StateChange

Holds the state notification message and associated date the state changed, populated by the server

Field Required Nullable Type Description Constraints Example

Field	Required	Nullable	Type	Description	Constraints	Example
`@type`	Yes	No	`String`	When sub-classing, this defines the sub-class Extensible name	default `null`;
`@baseType`	No	No	`String`	When sub-classing, this defines the super-class	default `null`;
`@schemaLocation`	No	No	`String`	A URI to a JSON-Schema file that defines additional attributes and relationships	default `null`;
`stateChangeDate`	Yes	No	`Date`	The date and time the state changed.	default `null`;	2023-01-01T08:00:00+01:00
`stateChangeMessage`	No	No	`array` of Message	Message for the state change described as a combination of a text and a code.	default `null`;	[]
`state`	Yes	No	`String`	The state of the API resource	default `null`;

@type

Yes

String

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

default null;

@baseType

String

When sub-classing, this defines the super-class

default null;

@schemaLocation

String

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

default null;

stateChangeDate

Yes

Date

The date and time the state changed.

default null;

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

stateChangeMessage

array of Message

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

default null;

[]

state

Yes

String

The state of the API resource

default null;