Jump to

• Request
• Response

Get work request status

get

/20180828/workRequests/{workRequestId}

This path retrieves the details of a work request.

Request

Path Parameters

• workRequestId(required): string
  The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.

Header Parameters

• 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. The only valid characters for request IDs are letters, numbers, underscore, and dash.

Back to Top

Response

Supported Media Types

• application/json

200 Response

The work request was retrieved.

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
  A decimal number representing the number of seconds the client should wait before polling this endpoint again.

Body ()

Root Schema : WorkRequest

Type: object

An asynchronous work request. Work requests help you monitor long-running operations. When you start a long-running operation, the service creates a work request. A work request is an activity log that allows you to track each step in the operation's progress. Each work request has an OCID that allows you to interact with it programmatically and use it for automation.

Show Source

• compartmentId(required): string
  The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the work request.
• id(required): string
  The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request.
• operationType(required): string
  Allowed Values: [ "CREATE_DATA_SHARING_AGREEMENT", "UPDATE_DATA_SHARING_AGREEMENT", "DELETE_DATA_SHARING_AGREEMENT", "MOVE_DATA_SHARING_AGREEMENT", "CREATE_DATA_SHARING_CONSTRAINT", "UPDATE_DATA_SHARING_CONSTRAINT", "DELETE_DATA_SHARING_CONSTRAINT", "MOVE_DATA_SHARING_CONSTRAINT", "CREATE_DATA_SHARING_REQUEST", "UPDATE_DATA_SHARING_REQUEST", "DELETE_DATA_SHARING_REQUEST", "MOVE_DATA_SHARING_REQUEST", "CREATE_DELIVERY_ENDPOINT", "UPDATE_DELIVERY_ENDPOINT", "DELETE_DELIVERY_ENDPOINT", "MOVE_DELIVERY_ENDPOINT", "CREATE_PAYER", "UPDATE_PAYER", "DELETE_PAYER", "MOVE_PAYER", "MOVE_PAYER_DIRECTORY_ENTRY", "CREATE_PROVIDER", "UPDATE_PROVIDER", "DELETE_PROVIDER", "MOVE_PROVIDER", "MOVE_PROVIDER_DIRECTORY_ENTRY", "CREATE_QUERY_ENDPOINT", "UPDATE_QUERY_ENDPOINT", "DELETE_QUERY_ENDPOINT", "MOVE_QUERY_ENDPOINT" ]

  The asynchronous operation tracked by this work request.
• percentComplete(required): number(float)
  Displays the progress of the operation tracked by the work request as a percentage of the total work that must be performed.
• resources(required): array resources
  Maximum Number of Items: 32

  The resources that are affected by the work request.
• status(required): string
  Allowed Values: [ "ACCEPTED", "IN_PROGRESS", "WAITING", "NEEDS_ATTENTION", "FAILED", "SUCCEEDED", "CANCELING", "CANCELED" ]

  The status of the work request.
• timeAccepted(required): string(date-time)
  The date and time that 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 that the work request was finished, in the format defined by [RFC 3339](https://tools.ietf.org/rfc/rfc3339).
• timeStarted: string(date-time)
  The date and time that the work request was started, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339).
• timeUpdated: string(date-time)
  The date and time that the work request was updated, in the format defined by [RFC 3339](https://tools.ietf.org/rfc/rfc3339).

{
    "description":"An asynchronous work request. Work requests help you monitor long-running operations. When you start a long-running operation,\nthe service creates a work request. A work request is an activity log that allows you to track each step in the operation's\nprogress. Each work request has an OCID that allows you to interact with it programmatically and use it for automation.\n",
    "x-obmcs-splat":{
        "resourceKind":"workRequest",
        "ocidEntityType":"cdexhubworkrequest",
        "adLocality":"regional"
    },
    "properties":{
        "operationType":{
            "type":"string",
            "x-obmcs-top-level-enum":"#/definitions/OperationType",
            "enum":[
                "CREATE_DATA_SHARING_AGREEMENT",
                "UPDATE_DATA_SHARING_AGREEMENT",
                "DELETE_DATA_SHARING_AGREEMENT",
                "MOVE_DATA_SHARING_AGREEMENT",
                "CREATE_DATA_SHARING_CONSTRAINT",
                "UPDATE_DATA_SHARING_CONSTRAINT",
                "DELETE_DATA_SHARING_CONSTRAINT",
                "MOVE_DATA_SHARING_CONSTRAINT",
                "CREATE_DATA_SHARING_REQUEST",
                "UPDATE_DATA_SHARING_REQUEST",
                "DELETE_DATA_SHARING_REQUEST",
                "MOVE_DATA_SHARING_REQUEST",
                "CREATE_DELIVERY_ENDPOINT",
                "UPDATE_DELIVERY_ENDPOINT",
                "DELETE_DELIVERY_ENDPOINT",
                "MOVE_DELIVERY_ENDPOINT",
                "CREATE_PAYER",
                "UPDATE_PAYER",
                "DELETE_PAYER",
                "MOVE_PAYER",
                "MOVE_PAYER_DIRECTORY_ENTRY",
                "CREATE_PROVIDER",
                "UPDATE_PROVIDER",
                "DELETE_PROVIDER",
                "MOVE_PROVIDER",
                "MOVE_PROVIDER_DIRECTORY_ENTRY",
                "CREATE_QUERY_ENDPOINT",
                "UPDATE_QUERY_ENDPOINT",
                "DELETE_QUERY_ENDPOINT",
                "MOVE_QUERY_ENDPOINT"
            ],
            "description":"The asynchronous operation tracked by this work request."
        },
        "status":{
            "type":"string",
            "x-obmcs-top-level-enum":"#/definitions/OperationStatus",
            "enum":[
                "ACCEPTED",
                "IN_PROGRESS",
                "WAITING",
                "NEEDS_ATTENTION",
                "FAILED",
                "SUCCEEDED",
                "CANCELING",
                "CANCELED"
            ],
            "description":"The status of the work request."
        },
        "id":{
            "type":"string",
            "description":"The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request."
        },
        "compartmentId":{
            "type":"string",
            "description":"The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the work request.\n"
        },
        "resources":{
            "type":"array",
            "maxItems":"32",
            "items":{
                "$ref":"#/definitions/WorkRequestResource"
            },
            "description":"The resources that are affected by the work request."
        },
        "percentComplete":{
            "type":"number",
            "format":"float",
            "description":"Displays the progress of the operation tracked by the work request as a percentage of the total work\nthat must be performed.\n"
        },
        "timeAccepted":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time that the work request was created, in the format defined by\n[RFC 3339](https://tools.ietf.org/html/rfc3339).\n"
        },
        "timeStarted":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time that the work request was started, in the format defined by\n[RFC 3339](https://tools.ietf.org/html/rfc3339).\n"
        },
        "timeFinished":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time that the work request was finished, in the format defined by\n[RFC 3339](https://tools.ietf.org/rfc/rfc3339).\n"
        },
        "timeUpdated":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time that the work request was updated, in the format defined by\n[RFC 3339](https://tools.ietf.org/rfc/rfc3339).\n"
        }
    },
    "required":[
        "operationType",
        "status",
        "id",
        "compartmentId",
        "resources",
        "percentComplete",
        "timeAccepted"
    ]
}

Nested Schema : resources

Type: array

Maximum Number of Items: 32

The resources that are affected by the work request.

Show Source

• Array of: object WorkRequestResource
  A resource created or operated on by a work request.

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

Nested Schema : WorkRequestResource

Type: object

A resource created or operated on by a work request.

Show Source

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

  The way in which this resource is affected by the operation tracked in the work request. A resource being created, updated, or deleted remains in the IN_PROGRESS state until work is complete for that resource, at which point it transitions to CREATED, UPDATED, or DELETED state, respectively.
• entityType(required): string
  The resource type that 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](/iaas/Content/General/Concepts/identifiers.htm) or other unique identifier for the resource.
• metadata: object metadata
  Additional Properties Allowed: additionalProperties

  Additional information that helps to explain the resource.

{
    "description":"A resource created or operated on by a work request.",
    "properties":{
        "entityType":{
            "type":"string",
            "description":"The resource type that the work request affects."
        },
        "actionType":{
            "description":"The way in which this resource is affected by the operation tracked in the work request.\nA resource being created, updated, or deleted remains in the IN_PROGRESS state until\nwork is complete for that resource, at which point it transitions to CREATED, UPDATED,\nor DELETED state, respectively.\n",
            "x-obmcs-top-level-enum":"#/definitions/ActionType",
            "enum":[
                "CREATED",
                "UPDATED",
                "DELETED",
                "IN_PROGRESS",
                "RELATED",
                "FAILED"
            ],
            "type":"string"
        },
        "identifier":{
            "type":"string",
            "description":"An [OCID](/iaas/Content/General/Concepts/identifiers.htm) or other unique identifier for the resource."
        },
        "entityUri":{
            "type":"string",
            "description":"The URI path that you can use for a GET request to access the resource metadata."
        },
        "metadata":{
            "description":"Additional information that helps to explain the resource.",
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "x-obmcs-top-level-enum":"#/definitions/WorkRequestResourceMetadataKey",
            "enum":[
                "IS_DRY_RUN"
            ]
        }
    },
    "required":[
        "actionType",
        "entityType",
        "identifier"
    ]
}

Nested Schema : metadata

Type: object

Additional Properties Allowed

Show Source

• string

{
    "description":"Additional information that helps to explain the resource.",
    "type":"object",
    "additionalProperties":{
        "type":"string"
    },
    "x-obmcs-top-level-enum":"#/definitions/WorkRequestResourceMetadataKey",
    "enum":[
        "IS_DRY_RUN"
    ]
}

Additional information that helps to explain the resource.

Allowed Values: [ "IS_DRY_RUN" ]

401 Response

Unauthorized

Headers

• opc-request-id: string
  Unique identifier for the request

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

404 Response

Not Found

Headers

• opc-request-id: string
  Unique identifier for the request

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

429 Response

Too Many Requests

Headers

• opc-request-id: string
  Unique identifier for the request

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

500 Response

Internal Server Error

Headers

• opc-request-id: string
  Unique identifier for the request

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

Default Response

An error has occurred.

Headers

• opc-request-id: string
  Unique identifier for the request

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

Back to Top