CancelTroubleTicket

Extends: TaskEntity

Request to cancel an existing trouble ticket

Field Required Nullable Type Description Constraints Example

Field	Required	Nullable	Type	Description	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`	Yes	No	`TaskStateType`
`requestDate`	Yes	No	`DateTime`	Date when the task resource was created	2023-01-01T08:00:00+01:00
`requestPostedDate`	Yes	No	`DateTime`	Date when the request was posted	2023-01-01T08:00:00+01:00
`entity`	Yes	No	EntityRef
`troubleTicket`	No	No	TroubleTicketRef	Explicit reference to the related TroubleTicket
`stateChangeDate`	No	No	`DateTime`	The date and time the state changed.	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.	[]
`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	[]

@type

Yes

String

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

@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

id

String

Unique identifier

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

href

URI

Hyperlink reference

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

state

Yes

TaskStateType

requestDate

Yes

DateTime

Date when the task resource was created

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

requestPostedDate

Yes

DateTime

Date when the request was posted

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

entity

Yes

EntityRef

troubleTicket

TroubleTicketRef

Explicit reference to the related TroubleTicket

stateChangeDate

DateTime

The date and time the state changed.

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.

[]

stateChangeHistory

array of StateChange

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

[]

externalIdentifier

array of ExternalIdentifier

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

[]