Jump to

• Request
• Response

Get Work Request Status

get

/20191010/workRequests/{workRequestId}

Gets the status of the work request with the given ID.

Request

Supported Media Types

• application/json

Path Parameters

• workRequestId: string
  The ID of the asynchronous request.

Header Parameters

• opc-request-id: string
  The client request ID for tracing.

Back to Top

Response

Supported Media Types

• application/json

200 Response

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

Body ()

Root Schema : WorkRequest

Type: object

A description of workrequest status

Show Source

• compartmentId: string
  The OCID of the compartment that contains the work request. Work requests should be scoped to the same compartment as the resource the work request affects. If the work request affects multiple resources, and those resources are not in the same compartment, it is up to the service team to pick the primary resource whose compartment should be used
• id: string
  The ID of the work request.
• operationType: string
  Allowed Values: [ "CREATE_PLATFORM", "UPDATE_PLATFORM", "UPGRADE_PLATFORM", "DELETE_PLATFORM", "SCALE_PLATFORM", "START_PLATFORM", "STOP_PLATFORM", "CUSTOMIZE_PLATFORM", "SCALE_CHAINCODE_HOSTS", "WORKREQUEST_CLEANUP" ]

  Type of the work request
• percentComplete: number(float)
  Percentage of the request completed.
• resources: array resources
  The resources affected by this work request.
• status: string
  Allowed Values: [ "ACCEPTED", "IN_PROGRESS", "FAILED", "SUCCEEDED", "CANCELING", "CANCELED" ]

  Status of current work request.
• timeAccepted: string(date-time)
  The date and time the request was created, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29.
• timeFinished(optional): string(date-time)
  The date and time the object was finished, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339).
• timeStarted(optional): string(date-time)
  The date and time the request was started, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29.

{
    "description":"A description of workrequest status",
    "properties":{
        "operationType":{
            "type":"string",
            "enum":[
                "CREATE_PLATFORM",
                "UPDATE_PLATFORM",
                "UPGRADE_PLATFORM",
                "DELETE_PLATFORM",
                "SCALE_PLATFORM",
                "START_PLATFORM",
                "STOP_PLATFORM",
                "CUSTOMIZE_PLATFORM",
                "SCALE_CHAINCODE_HOSTS",
                "WORKREQUEST_CLEANUP"
            ],
            "description":"Type of the work request"
        },
        "status":{
            "type":"string",
            "enum":[
                "ACCEPTED",
                "IN_PROGRESS",
                "FAILED",
                "SUCCEEDED",
                "CANCELING",
                "CANCELED"
            ],
            "description":"Status of current work request."
        },
        "id":{
            "type":"string",
            "description":"The ID of the work request."
        },
        "compartmentId":{
            "type":"string",
            "description":"The OCID of the compartment that contains the work request. Work requests should be scoped to\nthe same compartment as the resource the work request affects. If the work request affects multiple resources,\nand those resources are not in the same compartment, it is up to the service team to pick the primary\nresource whose compartment should be used\n"
        },
        "resources":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/WorkRequestResource"
            },
            "description":"The resources affected by this work request."
        },
        "percentComplete":{
            "type":"number",
            "format":"float",
            "description":"Percentage of the request completed."
        },
        "timeAccepted":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time the request was created, as described in\n[RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29.\n"
        },
        "timeStarted":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time the request was started, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339),\nsection 14.29.\n"
        },
        "timeFinished":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time the object was finished, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339).\n"
        }
    },
    "required":[
        "operationType",
        "status",
        "id",
        "compartmentId",
        "resources",
        "percentComplete",
        "timeAccepted"
    ]
}

Nested Schema : resources

Type: array

The resources affected by this work request.

Show Source

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

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

Nested Schema : WorkRequestResource

Type: object

A resource created or operated on by a work request.

Show Source

• actionType: string
  Allowed Values: [ "CREATED", "UPDATED", "DELETED", "IN_PROGRESS", "RELATED" ]

  The way in which this resource is affected by the work tracked in the work request. A resource being created, updated, or deleted will remain in the IN_PROGRESS state until work is complete for that resource at which point it will transition to CREATED, UPDATED, or DELETED, respectively.
• entityType: string
  The resource type the work request affects.
• entityUri(optional): string
  The URI path that the user can do a GET on to access the resource metadata
• identifier: string
  The identifier of the resource the work request affects.

{
    "description":"A resource created or operated on by a work request.",
    "properties":{
        "entityType":{
            "type":"string",
            "description":"The resource type the work request affects."
        },
        "actionType":{
            "description":"The way in which this resource is affected by the work tracked in the work request.\nA resource being created, updated, or deleted will remain in the IN_PROGRESS state until\nwork is complete for that resource at which point it will transition to CREATED, UPDATED,\nor DELETED, respectively.\n",
            "enum":[
                "CREATED",
                "UPDATED",
                "DELETED",
                "IN_PROGRESS",
                "RELATED"
            ],
            "type":"string"
        },
        "identifier":{
            "type":"string",
            "description":"The identifier of the resource the work request affects."
        },
        "entityUri":{
            "type":"string",
            "description":"The URI path that the user can do a GET on to access the resource metadata"
        }
    },
    "required":[
        "actionType",
        "entityType",
        "identifier"
    ]
}

400 Response

Bad Request

401 Response

Not authorized

404 Response

Invalid parameters

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

Error Information.

Show Source

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

{
    "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 string.",
            "type":"string"
        }
    }
}

500 Response

Service unavailable

Default Response

Unknown 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

Error Information.

Show Source

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

{
    "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 string.",
            "type":"string"
        }
    }
}

Back to Top