Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace ListWorkRequestsRequest

example

Click here to see how to use ListWorkRequestsRequest.

Properties

Optional compartmentId

compartmentId: undefined | string

The ID (OCID) of the compartment in which to list resources.

Example: {@code ocid1.compartment.oc1..uniqueID}

Optional limit

limit: undefined | number

For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. 1 is the minimum, 1000 is the maximum.

For important details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).

Example: {@code 100}

Optional opcRequestId

opcRequestId: undefined | string

The client request ID for tracing.

Optional page

page: undefined | string

For list pagination. The value of the {@code opc-next-page} response header from the previous "List" call.

For important details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).

Optional resourceId

resourceId: undefined | string

The ID (OCID) of the resource affected by the work request.

Example: {@code ocid1.drplanexecution.oc1..uniqueID}

Optional retryConfiguration

retryConfiguration: RetryConfiguration

RetryConfiguration to be used for the request NOTE : Retries are not supported for requests that have binary or stream bodies this also affects UploadManager operations For all requests with binary/stream bodies, retry attempts are not made

Optional sortBy

sortBy: SortBy

The field to sort by. Only one sort order may be provided. Default order for timeAccepted is descending.

Optional sortOrder

sortOrder: model.SortOrder

The sort order to use, either 'asc' or 'desc'.

Optional status

status: model.OperationStatus

A filter to return only resources whose lifecycleState matches the given OperationStatus.

Optional workRequestId

workRequestId: undefined | string

The ID (OCID) of the asynchronous work request.

Example: {@code ocid1.workrequest.oc1..uniqueID}