Jump to

• Request
• Response

List Work Requests

get

/20190828/workRequests

List the work requests in a compartment.

Request

Query Parameters

• compartmentId: string
  The ID of a table's compartment.
• limit: integer
  Minimum Value: 1

  Maximum Value: 1000

  The maximum number of items to return.

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

  Maximum Length: 1024

  The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

Header Parameters

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

Back to Top

Response

Supported Media Types

• application/json

200 Response

A collection of WorkRequest.

Headers

• opc-next-page: string
  For 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 : WorkRequestCollection

Type: object

Results of ListWorkRequests

Show Source

• items(optional): array items
  A page of WorkRequestSummary objects.

{
    "description":"Results of ListWorkRequests",
    "type":"object",
    "properties":{
        "items":{
            "description":"A page of WorkRequestSummary objects.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/WorkRequestSummary"
            }
        }
    }
}

Nested Schema : items

Type: array

A page of WorkRequestSummary objects.

Show Source

• Array of: object WorkRequestSummary
  A description of workrequest status.

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

Nested Schema : WorkRequestSummary

Type: object

A description of workrequest status.

Show Source

• compartmentId: string
  The ocid of the compartment that contains the work request.
• id: string
  The id of the work request.
• operationType: string
  Allowed Values: [ "CREATE_TABLE", "UPDATE_TABLE", "DELETE_TABLE" ]

  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_TABLE",
                "UPDATE_TABLE",
                "DELETE_TABLE"
            ],
            "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.\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\n[RFC 3339](https://tools.ietf.org/rfc/rfc3339), section\n14.29.\n"
        },
        "timeFinished":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time the object was finished, as described in\n[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" ]

  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 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\ntracked in the work request.  A resource being created,\nupdated, or deleted will remain in the IN_PROGRESS state\nuntil work is complete for that resource at which point it\nwill transition to CREATED, UPDATED, or DELETED,\nrespectively.\n",
            "enum":[
                "CREATED",
                "UPDATED",
                "DELETED",
                "IN_PROGRESS"
            ],
            "type":"string"
        },
        "identifier":{
            "type":"string",
            "description":"The identifier of the resource the work request affects."
        },
        "entityUri":{
            "type":"string",
            "description":"The URI path to access the resource metadata."
        }
    },
    "required":[
        "actionType",
        "entityType",
        "identifier"
    ]
}

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

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\nprogrammatic parsing.\n",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string.",
            "type":"string"
        }
    }
}

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

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\nprogrammatic parsing.\n",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string.",
            "type":"string"
        }
    }
}

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

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\nprogrammatic parsing.\n",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string.",
            "type":"string"
        }
    }
}

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

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\nprogrammatic parsing.\n",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string.",
            "type":"string"
        }
    }
}

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

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\nprogrammatic parsing.\n",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string.",
            "type":"string"
        }
    }
}

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\nprogrammatic parsing.\n",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string.",
            "type":"string"
        }
    }
}

Back to Top