Jump to

• Request
• Response

GetWorkRequest

get

/20180222/workRequests/{work_request_id}

Get the details of a work request.

Request

Supported Media Types

• application/json

Path Parameters

• workRequestId(required): string
  Minimum Length: 1

  Maximum Length: 255

  The OCID of the 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 work request.

Headers

• etag: string
  For optimistic concurrency control. See `if-match`.
• 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.
• retry-after: integer
  the number of seconds to should wait before polling this endpoint again

Body ()

Root Schema : WorkRequest

Type: object

An asynchronous work request.

Show Source

• compartmentId(required): string
  The OCID of the compartment that contains the 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.
• resources(required): array resources
  The resources that are affected 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":"An asynchronous 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 that contains the work request. ",
            "type":"string"
        },
        "resources":{
            "description":"The resources that are affected by this work request.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/WorkRequestResource"
            }
        },
        "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",
        "resources",
        "percentComplete",
        "timeAccepted"
    ],
    "x-example":"Example response: Work request that tracks the launch instance operation {   \"operationType\": \"LaunchInstance\",   \"status\": \"SUCCEEDED\",   \"id\": \"ocid1.coreservicesworkrequest.oc1.phx.exampleunique_ID\",   \"compartmentId\": \"ocid1.tenancy.oc1..exampleunique_ID\",   \"resources\": [     {       \"actionType\": \"CREATED\",       \"entityType\": \"instance\",       \"identifier\": \"ocid1.instance.oc1.phx.exampleunique_ID\",       \"entityUri\": \"/20160918/instances/ocid1.instance.oc1.phx.exampleunique_ID\"     }   ],   \"percentComplete\": 100.0,   \"timeAccepted\": \"2019-05-06T23:02:52.319Z\",   \"timeStarted\": \"2019-05-06T23:02:57.592Z\",   \"timeFinished\": \"2019-05-06T23:03:59.744Z\" } ",
    "type":"object"
}

Nested Schema : resources

Type: array

The resources that are affected by this work request.

Show Source

• Array of: object WorkRequestResource
  A resource that is created or operated on by an asynchronous operation that is tracked by a work request.

{
    "description":"The resources that are affected by this work request.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/WorkRequestResource"
    }
}

Nested Schema : WorkRequestResource

Type: object

A resource that is created or operated on by an asynchronous operation that is tracked by a work request.

Show Source

• actionType(required): string
  Allowed Values: [ "CREATED", "UPDATED", "DELETED", "RELATED", "IN_PROGRESS", "FAILED" ]

  The way in which this resource was affected by the operation that spawned the work request.
• entityType(required): string
  The resource type the work request affects.
• entityUri: string
  The URI path that you can use for a GET request to access the resource metadata.
• identifier(required): string
  An OCID or other unique identifier for the resource.

{
    "description":"A resource that is created or operated on by an asynchronous operation that is tracked by a work request.",
    "properties":{
        "actionType":{
            "description":"The way in which this resource was affected by the operation that spawned the work request.",
            "type":"string",
            "enum":[
                "CREATED",
                "UPDATED",
                "DELETED",
                "RELATED",
                "IN_PROGRESS",
                "FAILED"
            ]
        },
        "entityType":{
            "description":"The resource type the work request affects.",
            "type":"string"
        },
        "identifier":{
            "description":"An OCID or other unique identifier for the resource.",
            "type":"string"
        },
        "entityUri":{
            "description":"The URI path that you can use for a GET request to access the resource metadata.",
            "type":"string"
        }
    },
    "required":[
        "actionType",
        "entityType",
        "identifier"
    ],
    "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

An error has occurred.

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"
}

Back to Top