Skip to content

StateChange

StateChange

Data type: Extensible

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

Name Type Description Example
@type (1) string When sub-classing, this defines the sub-class Extensible name
stateChangeDate (1) DateTime The date and time the state changed. 2023-01-01T08:00+01:00
state (1) string The state of the API resource
@baseType string When sub-classing, this defines the super-class
@schemaLocation string A URI to a JSON-Schema file that defines additional attributes and relationships
stateChangeReason Message [n..m] Reason for the state change described as a combination of a text and a code. []