openapi: 3.2.0 info: title: Oracle Work Requests API version: '1.0' description: 'Operations tagged workRequests across 2 of this provider''s published API definitions: oci-api-gateway-openapi.yaml, oci-mysql-openapi.yaml. Each path carries the servers of the definition it was published in.' servers: - url: http://127.0.0.1/20220518 - url: https://127.0.0.1/20220518 tags: - name: workRequests paths: /workRequests: get: description: 'Lists the work requests in a compartment. ' operationId: ListWorkRequests parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/ResourceIdQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' responses: 200: description: The list of work requests. headers: opc-next-page: description: '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). ' schema: type: string default: 'null' opc-prev-page: description: 'For list pagination. When this header appears in the response, additional pages of results were seen previously. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string default: 'null' opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request id. ' schema: type: string default: 'null' content: application/json: schema: $ref: '#/components/schemas/WorkRequestCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: List work requests tags: - workRequests x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/WorkRequestSummary' /workRequests/{workRequestId}: delete: description: Cancels the work request. operationId: CancelWorkRequest parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: The work request will be canceled. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request id. ' schema: type: string default: 'null' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Cancel the work request tags: - workRequests x-related-resource: '#/definitions/WorkRequest' get: description: Gets the status of the work request with the given identifier. operationId: GetWorkRequest parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The details of the work request. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string default: 'null' opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request id. ' schema: type: string default: 'null' retry-after: description: 'A decimal number representing the number of seconds the client should wait before polling this endpoint again. ' schema: type: number format: integer content: application/json: schema: $ref: '#/components/schemas/WorkRequest' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets work request status tags: - workRequests x-obmcs-client-retries-enabled: true /workRequests/{workRequestId}/errors: get: description: 'Returns a (paginated) list of errors for a given work request. ' operationId: ListWorkRequestErrors parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' responses: 200: description: List of work request errors. headers: opc-next-page: description: '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). ' schema: type: string default: 'null' opc-prev-page: description: 'For list pagination. When this header appears in the response, additional pages of results were seen previously. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string default: 'null' opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request id. ' schema: type: string default: 'null' content: application/json: schema: $ref: '#/components/schemas/WorkRequestErrorCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Lists work request errors tags: - workRequests x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/WorkRequestError' /workRequests/{workRequestId}/logs: get: description: 'Returns a (paginated) list of logs for a given work request. ' operationId: ListWorkRequestLogs parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' responses: 200: description: List of work request logs. headers: opc-next-page: description: '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). ' schema: type: string default: 'null' opc-prev-page: description: 'For list pagination. When this header appears in the response, additional pages of results were seen previously. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string default: 'null' opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request id. ' schema: type: string default: 'null' content: application/json: schema: $ref: '#/components/schemas/WorkRequestLogCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Lists work request logs tags: - workRequests x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/WorkRequestLog' components: parameters: PaginationTokenQueryParam: description: The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. in: query name: page schema: type: string default: 'null' maxLength: 1024 minLength: 1 SortByQueryParam: description: 'The field to sort by. You can provide one sort order (`sortOrder`). Default order for `timeCreated` is descending. Default order for `displayName` is ascending. The `displayName` sort order is case sensitive. ' in: query name: sortBy schema: type: string enum: - timeCreated - displayName default: timeCreated CompartmentIdQueryParam: description: The ocid of the compartment in which to list resources. in: query name: compartmentId required: true schema: type: string IfMatchHeader: description: 'For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource''s current etag value. ' in: header name: if-match schema: type: string default: 'null' PaginationLimitQueryParam: description: The maximum number of items to return. in: query name: limit schema: type: integer default: 100 maximum: 1000 minimum: 1 WorkRequestIdPathParam: description: The ocid of the asynchronous request. in: path name: workRequestId required: true schema: type: string SortOrderQueryParam: description: The sort order to use, either 'asc' or 'desc'. The default order depends on the sortBy value. in: query name: sortOrder schema: type: string enum: - ASC - DESC default: ASC ResourceIdQueryParam: description: Filter work requests by the resource ocid. in: query name: resourceId required: false schema: type: string default: 'null' RetryTokenHeader: description: 'A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. ' in: header name: opc-retry-token schema: type: string default: 'null' maxLength: 64 minLength: 1 RequestIdHeader: description: The client request id for tracing. in: header name: opc-request-id schema: type: string default: 'null' schemas: Error: description: Error Information. 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 required: - code - message type: object WorkRequestLogCollection: description: Collection of work request logs. properties: items: description: Work request logs. items: $ref: '#/components/schemas/WorkRequestLog' type: array required: - items type: object WorkRequestCollection: description: Collection of work request summaries. properties: items: description: Work request summaries. items: $ref: '#/components/schemas/WorkRequestSummary' type: array required: - items type: object WorkRequestResource: description: A resource created or operated on by a work request. properties: actionType: description: '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. ' enum: - CREATED - UPDATED - DELETED - IN_PROGRESS - FAILED type: string entityType: description: The resource type the work request affects. type: string entityUri: description: 'The URI path on which the user can perform a GET operation to access the resource metadata. ' type: string identifier: description: The identifier of the resource the work request affects. type: string required: - actionType - entityType - identifier type: object WorkRequestLog: description: A log message from the execution of a work request. properties: message: description: Human-readable log message. type: string timestamp: description: The time the log message was written. An RFC3339 formatted datetime string. format: date-time type: string required: - message - timestamp type: object WorkRequestErrorCollection: description: Collection of work request errors. properties: items: description: Work request errors. items: $ref: '#/components/schemas/WorkRequestError' type: array required: - items type: object WorkRequestSummary: description: A summary of the work request. properties: compartmentId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment in which the resource is created. ' maxLength: 255 minLength: 1 type: string operationType: description: The type of the work request. type: string x-obmcs-enumref: '#/definitions/WorkRequest/operationType' percentComplete: description: Percentage of the request completed. format: float type: number status: description: The status of the work request. type: string x-obmcs-enumref: '#/definitions/WorkRequest/status' timeAccepted: description: 'The date and time the request was created, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. ' format: date-time type: string timeFinished: description: 'The date and time the request was finished, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339). ' format: date-time type: string timeStarted: description: 'The date and time the request was started, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. ' format: date-time type: string workRequestId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the resource. ' maxLength: 255 minLength: 1 type: string required: - operationType - status - workRequestId - compartmentId - percentComplete - timeAccepted type: object WorkRequestError: description: An error encountered while executing a work request. properties: code: description: 'A machine-usable code for the error that occured. See API Errors. ' type: string message: description: A human-readable description of the issue encountered. type: string timestamp: description: The time the error occured. An RFC3339 formatted datetime string. format: date-time type: string required: - code - message - timestamp type: object WorkRequest: description: A description of the work request status. properties: compartmentId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment in which the resource is created. ' maxLength: 255 minLength: 1 type: string id: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the resource. ' maxLength: 255 minLength: 1 type: string operationType: description: The type of the work request. enum: - CREATE_GATEWAY - UPDATE_GATEWAY - DELETE_GATEWAY - CREATE_DEPLOYMENT - UPDATE_DEPLOYMENT - DELETE_DEPLOYMENT - CREATE_CERTIFICATE - UPDATE_CERTIFICATE - DELETE_CERTIFICATE - CREATE_API - UPDATE_API - DELETE_API - VALIDATE_API - CREATE_SDK - DELETE_SDK - CREATE_USAGE_PLAN - UPDATE_USAGE_PLAN - DELETE_USAGE_PLAN - CREATE_SUBSCRIBER - UPDATE_SUBSCRIBER - DELETE_SUBSCRIBER type: string percentComplete: description: Percentage of the request completed. format: float type: number resources: description: The resources affected by this work request. items: $ref: '#/components/schemas/WorkRequestResource' type: array status: description: The status of the work request. enum: - ACCEPTED - IN_PROGRESS - FAILED - SUCCEEDED - CANCELING - CANCELED type: string timeAccepted: description: 'The date and time the request was created, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. ' format: date-time type: string timeFinished: description: 'The date and time the request was finished, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339). ' format: date-time type: string timeStarted: description: 'The date and time the request was started, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. ' format: date-time type: string required: - id - operationType - status - compartmentId - resources - percentComplete - timeAccepted type: object responses: default: description: UnknownError headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request id. ' schema: type: string default: 'null' content: application/json: schema: $ref: '#/components/schemas/Error' x-refined-from: - oci-api-gateway-openapi.yaml - oci-mysql-openapi.yaml x-anchors: x-headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' type: string opc-next-page: description: '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. ' type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' type: string retry-after: description: A decimal number representing the number of seconds the client should wait before polling this endpoint again. type: integer x-properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object x-obmcs-client-retries-enabled: true x-oracle-package: com.oracle.idm.agcs.cp