Jump to

• Request
• Response

List work requests

get

/20180828/workRequests

This path lists the work requests in a compartment.

Request

Query Parameters

• compartmentId: string
  The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources.
• 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. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

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

  For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
• resourceId: string
  The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the resource affected by the work request.
• sortBy: string
  The field that you can use to sort the available information. Only one sort order may be provided. Results in the `timeAccepted` field are displayed in descending order by default.

  Default Value: timeAccepted

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

  Allowed Values: [ "ASC", "DESC" ]
• status: string
  A filter to return only the resources that match the given lifecycle state.

  Allowed Values: [ "ACCEPTED", "IN_PROGRESS", "WAITING", "NEEDS_ATTENTION", "FAILED", "SUCCEEDED", "CANCELING", "CANCELED" ]
• workRequestId: 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 list of work requests was retrieved.

Headers

• opc-next-page: string
  For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
• 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

A list of work requests. This list can contain both work requests and other information, such as metadata.

Show Source

• items(required): array items
  A list of work requests.

{
    "type":"object",
    "description":"A list of work requests. This list can contain both work requests and other information, such as metadata.",
    "required":[
        "items"
    ],
    "properties":{
        "items":{
            "description":"A list of work requests.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/WorkRequestSummary"
            }
        }
    }
}

Nested Schema : items

Type: array

A list of work requests.

Show Source

• Array of: object WorkRequestSummary
  Summary information about an asynchronous work request.

{
    "description":"A list of work requests.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/WorkRequestSummary"
    }
}

Nested Schema : WorkRequestSummary

Type: object

Summary information about an asynchronous work request.

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 this 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":"Summary information about an asynchronous work request.",
    "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 this 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 this 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 this 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