AmendProductOrder

Extends

TaskEntity

Request for amending an existing product order

Field Required Nullable Type Description Constraints Example

@type

Yes

No

String

When sub-classing, this defines the sub-class Extensible name

@baseType

No

No

String

When sub-classing, this defines the super-class

@schemaLocation

No

No

String

A URI to a JSON-Schema file that defines additional attributes and relationships

id

No

No

String

Unique identifier

2d7ed5fd-9f62-4211-bc84-357f5f7b80f5

href

No

No

URI

Hyperlink reference

https://api.example.org/resource/id

state

No

No

TaskStateType

stateChangeDate

No

No

DateTime

The date and time the state changed.

2023-01-01T08:00+01:00

stateChangeReason

No

No

array of Message

Reason for the state change described as a combination of a text and a code.

[]

requestDate

No

No

DateTime

Date when the task resource was created

2023-01-01T08:00+01:00

requestPostedDate

No

No

DateTime

Date when the request was posted

2023-01-01T08:00+01:00

stateChangeHistory

No

No

array of StateChange

The state change history that is associated to the Entity. Populated by the server

[]

externalIdentifier

No

No

array of ExternalIdentifier

A reference to an externally defined object in the context of the managed entity

[]

productOrder

Yes

No

ProductOrderRef

amendReason

No

No

array of Message

Reason for the amend request (Message)

amendProductOrderItem

No

No

array of AmendProductOrderItem

ProductOrderItem to be amended (id alone for delete, full ProductOrderItem for add and replace)