Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace WorkRequestResource

A resource that a work request creates and operates on.

Properties

actionType

actionType: ActionType

The way in which this resource is affected by the work is 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 that point, the resource will transition to CREATED, UPDATED, or DELETED, respectively.

entityType

entityType: string

The resource type that the work request affects.

Optional entityUri

entityUri: undefined | string

The URI path where you can perform a GET operation to access the resource metadata.

identifier

identifier: string

The identifier of the resource that the work request affects.

Optional metadata

metadata: undefined | object

Additional information that helps to explain the resource.

Functions

getDeserializedJsonObj

getJsonObj