Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace WorkRequestResource

A resource created or operated on by a work request.

Properties

actionType

actionType: ActionType

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

The resource type that 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: undefined | object

Additional information that helps to explain the resource.

Optional name

name: undefined | string

The name of the resource. Not all resources will have a name specified.

Functions

getDeserializedJsonObj

getJsonObj