Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace WorkRequestResource

A resource created or operated on by a work request.

Properties

actionType

actionType: ActionTypes

The way in which this resource is affected by the work tracked in the work request. A resource being created, updated, or deleted will remain in the IN_PROGRESS state until work is complete for that resource at which point it will transition to CREATED, UPDATED, or DELETED, respectively.

entityType

entityType: string

The resource type the work request affects.

Optional entityUri

entityUri: undefined | string

The URI path that the user can do a GET on to access the resource metadata

identifier

identifier: string

The identifier of the resource the work request affects.

Optional metadata

metadata: any

Additional metadata about the resource that has been operated upon by this work request. For WorkRequests operationType WORK_DELIVERY the metadata will contain: workDeliveryStatus indicating the status of the work delivery item as a WorkDeliveryStatus value, workSubmissionKey the WorkSubmission request id, and workSubmissionDetails containing any details of result

Optional sourceId

sourceId: undefined | string

The identifier of the source the work request is requesting.

Optional sourceName

sourceName: undefined | string

The name of the source the work request is requesting.

Optional sourceVersion

sourceVersion: undefined | string

The version of the source the work request is requesting.

Optional timeAccepted

timeAccepted: Date

The date and time the request was created, as described in RFC 3339, section 5.6.

Optional timeFinished

timeFinished: Date

The date and time the request was finished, as described in RFC 3339, section 5.6.

Optional timeStarted

timeStarted: Date

The date and time the request was started, as described in RFC 3339, section 5.6.

Functions

getDeserializedJsonObj

getJsonObj