Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace WorkRequest

An asynchronous work request. When you start a long-running operation, the service creates a work request. Work requests help you monitor long-running operations.

A work request is an activity log that lets you track each step in the operation's progress. Each work request has an OCID that lets you interact with it programmatically and use it for automation.

Properties

compartmentId

compartmentId: string

The OCID of the compartment that contains the work request.

id

id: string

The OCID of the work request.

operationType

operationType: OperationType

The asynchronous operation tracked by this work request.

percentComplete

percentComplete: number

Shows the progress of the operation tracked by the work request, as a percentage of the total work that must be performed. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

resources

resources: Array<WorkRequestResource>

The resources that are affected by the work request.

status

The status of the work request.

timeAccepted

timeAccepted: Date

The date and time the work request was created, in the format defined by RFC 3339.

Optional timeFinished

timeFinished: Date

The date and time the work request was finished, in the format defined by RFC 3339.

Optional timeStarted

timeStarted: Date

The date and time the work request was started, in the format defined by RFC 3339.

Functions

getDeserializedJsonObj

getJsonObj