Jump to

• Request
• Response

List Work Requests

get

/20210415/workRequests

Lists the work requests in a compartment.

Request

Supported Media Types

• application/json

Query Parameters

• availabilityDomain: string
  The availability domain of the pod shape.
• compartmentId(required): string
  Minimum Length: 1

  Maximum Length: 255

  The OCID of the compartment.
• limit: integer
  Minimum Value: 1

  Maximum Value: 1000

  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.

  Default Value: 100
• page: string
  Minimum Length: 1

  Maximum Length: 512

  For list pagination. The value of the opc-next-page response header from the previous List call.

  Default Value: 0
• resourceIdentifier: string
  The identifier of the resource the work request affects.
• sortBy: string
  The field to sort by. You can provide one sort order. Default order for timeAccepted is descending.

  Default Value: timeAccepted

  Allowed Values: [ "timeAccepted" ]
• sortOrder: string
  The sort order to use, either ascending (ASC) or descending (DESC).

  Default Value: DESC

  Allowed Values: [ "ASC", "DESC" ]
• status: string
  A filter to return resources with a lifecycleState that matches the given OperationStatus.

  Allowed Values: [ "ACCEPTED", "IN_PROGRESS", "FAILED", "SUCCEEDED", "CANCELING", "CANCELED" ]
• workRequestId: string
  The ID of the asynchronous work request.

Header Parameters

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Back to Top

Response

Supported Media Types

• application/json

200 Response

The list is being retrieved.

Headers

• opc-next-page: string
  Pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.
• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : WorkRequestSummaryCollection

Type: object

Results of a workRequest search. Contains both WorkRequest items and other information, such as metadata.

Show Source

• items(required): array items
  List of workRequestSummary objects.

{
    "type":"object",
    "description":"Results of a workRequest search. Contains both WorkRequest items and other information, such as metadata.",
    "required":[
        "items"
    ],
    "properties":{
        "items":{
            "description":"List of workRequestSummary objects.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/WorkRequestSummary"
            }
        }
    }
}

Nested Schema : items

Type: array

List of workRequestSummary objects.

Show Source

• Array of: object WorkRequestSummary
  A summary of the status of a work request.

{
    "description":"List of workRequestSummary objects.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/WorkRequestSummary"
    }
}

Nested Schema : WorkRequestSummary

Type: object

A summary of the status of a work request.

Show Source

• compartmentId(required): string
  The OCID of the compartment containing this work request.
• id(required): string
  The OCID of the work request.
• operationType(required): string
  The asynchronous operation tracked by this work request.
• percentComplete(required): number(float)
  The percentage complete of the operation tracked by this work request.
• status(required): string
  Allowed Values: [ "ACCEPTED", "IN_PROGRESS", "FAILED", "SUCCEEDED", "CANCELING", "CANCELED" ]

  The status of the work request.
• timeAccepted(required): string(date-time)
  The date and time the work request was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339).
• timeFinished: string(date-time)
  The date and time the work request reached a terminal state, either FAILED or SUCCEEDED, in the format defined by RFC3339.
• timeStarted: string(date-time)
  The date and time the work request transitioned from ACCEPTED to IN_PROGRESS, in the format defined by RFC3339.

{
    "description":"A summary of the status of a work request.",
    "properties":{
        "operationType":{
            "description":"The asynchronous operation tracked by this work request.",
            "type":"string"
        },
        "status":{
            "description":"The status of the work request.",
            "enum":[
                "ACCEPTED",
                "IN_PROGRESS",
                "FAILED",
                "SUCCEEDED",
                "CANCELING",
                "CANCELED"
            ],
            "type":"string"
        },
        "id":{
            "description":"The OCID of the work request.",
            "type":"string"
        },
        "compartmentId":{
            "description":"The OCID of the compartment containing this work request.",
            "type":"string"
        },
        "percentComplete":{
            "description":"The percentage complete of the operation tracked by this work request.",
            "type":"number",
            "format":"float"
        },
        "timeAccepted":{
            "description":"The date and time the work request was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339).",
            "format":"date-time",
            "type":"string"
        },
        "timeStarted":{
            "description":"The date and time the work request transitioned from ACCEPTED to IN_PROGRESS, in the format defined by RFC3339.",
            "format":"date-time",
            "type":"string"
        },
        "timeFinished":{
            "description":"The date and time the work request reached a terminal state, either FAILED or SUCCEEDED, in the format defined by RFC3339.",
            "format":"date-time",
            "type":"string"
        }
    },
    "required":[
        "operationType",
        "status",
        "id",
        "compartmentId",
        "percentComplete",
        "timeAccepted"
    ],
    "x-example":"{   \"operationType\":\"LaunchInstancesInPool\",   \"status\":\"SUCCEEDED\",   \"id\":\"ocid1.coreservicesworkrequest.oc1.phx.exampleunique_ID\",   \"compartmentId\":\"ocid1.tenancy.oc1..exampleuniqueID\",   \"percentComplete\":100.0,   \"timeAccepted\":\"2019-05-07T00:50:03.248Z\",   \"timeStarted\":\"2019-05-07T00:50:03.374Z\",   \"timeFinished\":\"2019-05-07T00:52:05.704Z\" } ",
    "type":"object"
}

400 Response

Bad Request

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
• message(required): string
  A human-readable error string.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm)."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

401 Response

Unauthorized

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
• message(required): string
  A human-readable error string.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm)."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

404 Response

Not Found

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
• message(required): string
  A human-readable error string.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm)."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

429 Response

Too Many Requests

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
• message(required): string
  A human-readable error string.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm)."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

500 Response

Internal Server Error

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
• message(required): string
  A human-readable error string.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm)."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

Default Response

Unknown Error

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
• message(required): string
  A human-readable error string.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm)."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

Back to Top