Oracle Work Request API

openapi: 3.2.0
info:
  title: Oracle Work Request API
  version: '1.0'
  description: 'Operations tagged workRequest across 10 of this provider''s published API definitions: oci-database-multicloud-integrations-openapi.yaml, oci-delegate-access-control-openapi.yaml, oci-managed-access-openapi.yaml, oci-organizations-1-openapi.yaml, oci-organizations-openapi.yaml, oci-osmh-openapi.yaml, oci-vmware-1-openapi.yaml, oci-vmware-openapi.yaml, oci-waa-openapi.yaml, oci-workrequests-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: workRequest
paths:
  /workRequests:
    get:
      description: 'Lists the work requests in a compartment.

        '
      operationId: ListWorkRequests
      parameters:
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/WorkRequestIdQueryParam'
      - $ref: '#/components/parameters/WorkRequestStatusQueryParam'
      - $ref: '#/components/parameters/ResourceIdentifierQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/WorkRequestSortByQueryParam'
      responses:
        200:
          description: The list of work request summaries.
          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
            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
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkRequestSummaryCollection'
        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:
      - workRequest
      x-related-resource: '#/definitions/WorkRequest'
  /workRequests/{workRequestId}:
    delete:
      description: Cancels a work request.
      operationId: CancelWorkRequest
      parameters:
      - $ref: '#/components/parameters/WorkRequestIdPathParam'
      - $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
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Cancel work request
      tags:
      - workRequest
      x-related-resource: '#/definitions/WorkRequest'
    get:
      description: Gets details of the work request with the given ID.
      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
            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
            retry-after:
              description: A decimal number representing the number of seconds the client should wait before polling this endpoint again.
              schema:
                type: 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: Get work request status
      tags:
      - workRequest
      x-related-resource: '#/definitions/WorkRequest'
  /workRequests/{workRequestId}/errors:
    get:
      description: 'Returns a (paginated) list of errors for the work request with the given ID.

        '
      operationId: ListWorkRequestErrors
      parameters:
      - $ref: '#/components/parameters/WorkRequestIdPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/WorkRequestLogAndErrorSortByQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      responses:
        200:
          description: The 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
            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
          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: List work request errors
      tags:
      - workRequest
      x-related-resource: '#/definitions/WorkRequestError'
  /workRequests/{workRequestId}/logs:
    get:
      description: 'Returns a (paginated) list of logs for the work request with the given ID.

        '
      operationId: ListWorkRequestLogs
      parameters:
      - $ref: '#/components/parameters/WorkRequestIdPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/WorkRequestLogAndErrorSortByQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      responses:
        200:
          description: The 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
            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
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkRequestLogEntryCollection'
        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 request logs
      tags:
      - workRequest
      x-related-resource: '#/definitions/WorkRequestLogEntry'
  /workRequests/{workRequestId}/actions/rerun:
    post:
      description: 'Reruns a failed work for the specified work request [OCID](/iaas/Content/General/Concepts/identifiers.htm). Rerunning restarts the work on failed targets.

        '
      operationId: RerunWorkRequest
      parameters:
      - $ref: '#/components/parameters/WorkRequestIdPathParam_2'
      - $ref: '#/components/parameters/RequestIdHeader_2'
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      responses:
        202:
          description: Accepted the request. The work request is being rerun.
          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
            opc-work-request-id:
              description: 'Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status.

                '
              schema:
                type: string
        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: Reruns a failed work request based on a work request id.
      tags:
      - workRequest
      x-example: "POST 20220901/workRequests/<var>&lt;resource_OCID&gt;</var>/actions/rerun\nHost: osmh.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n    \"managedInstances\": [\n        \"ocid1.managementagent.oc1.phx.exampleuniqueID\"\n    ],\n    \"workRequestDetails\": {\n        \"displayName\": \"rerun of ocid1.osmhworkrequest.oc1.us-phoenix-1.exampleuniqueID\",\n        \"description\": \"rerun of failed update jobs in group\"\n    }\n}\n"
      x-related-resource: '#/definitions/WorkRequest'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RerunWorkRequestDetails'
        description: The resource [OCIDs](/iaas/Content/General/Concepts/identifiers.htm) to rerun the work requests for. If no OCIDs are provided, rerun will apply to all failed work requests associated with the specified work request id.
        required: true
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
      x-default-description: 'null'
      schema:
        type: string
        minLength: 1
    ResourceIdentifierQueryParam:
      description: The ID of the resource affected by the work request.
      in: query
      name: resourceId
      x-default-description: 'null'
      schema:
        type: string
    CompartmentIdQueryParam:
      description: The [ID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
      in: query
      name: compartmentId
      required: true
      x-default-description: 'null'
      schema:
        type: string
        maxLength: 255
        minLength: 1
    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
      required: false
      schema:
        type: string
    WorkRequestStatusQueryParam:
      description: A filter to return only work requests with the given OperationStatus.
      in: query
      name: status
      required: false
      x-default-description: 'null'
      x-obmcs-top-level-enum: '#/definitions/OperationStatus'
      schema:
        type: string
        enum:
        - ACCEPTED
        - IN_PROGRESS
        - WAITING
        - NEEDS_ATTENTION
        - FAILED
        - SUCCEEDED
        - CANCELING
        - CANCELED
    PaginationLimitQueryParam:
      description: The maximum number of items to return.
      in: query
      name: limit
      x-default-description: 'null'
      schema:
        type: integer
        default: 10
        maximum: 1000
        minimum: 1
    WorkRequestIdPathParam:
      description: The ID of the asynchronous request.
      in: path
      name: workRequestId
      required: true
      schema:
        type: string
    SortOrderQueryParam:
      description: The sort order to use, either 'asc' or 'desc'.
      in: query
      name: sortOrder
      x-default-description: 'null'
      x-obmcs-top-level-enum: '#/definitions/SortOrder'
      schema:
        type: string
        enum:
        - ASC
        - DESC
        default: DESC
    WorkRequestIdQueryParam:
      description: The ID of the asynchronous work request.
      in: query
      name: workRequestId
      x-default-description: 'null'
      schema:
        type: string
    WorkRequestLogAndErrorSortByQueryParam:
      description: 'The field to sort by. Only one sort order may be provided. Default order for timestamp is descending.

        '
      in: query
      name: sortBy
      schema:
        type: string
        enum:
        - timestamp
        default: timestamp
    RequestIdHeader_2:
      description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
      in: header
      name: opc-request-id
      schema:
        type: string
    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
      required: false
      schema:
        type: string
        maxLength: 64
        minLength: 1
    WorkRequestIdPathParam_2:
      description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request.
      in: path
      name: workRequestId
      required: true
      schema:
        type: string
    WorkRequestSortByQueryParam:
      description: 'The field to sort by. Only one sort order may be provided. Default order for timeAccepted is descending.

        '
      in: query
      name: sortBy
      schema:
        type: string
        enum:
        - timeAccepted
        default: timeAccepted
    RequestIdHeader:
      description: The client request ID for tracing.
      in: header
      name: opc-request-id
      schema:
        type: string
  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 message.
          type: string
      required:
      - code
      - message
    WorkRequestSummaryCollection:
      description: Results of a workRequest search. Contains both WorkRequest items and other information, such as metadata.
      properties:
        items:
          description: List of workRequestSummary objects.
          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:
          - CREATING
          - CREATED
          - UPDATED
          - DELETED
          - IN_PROGRESS
          - FAILED
          type: string
          x-obmcs-top-level-enum: '#/definitions/ActionType'
        entityType:
          description: The resource type the work request affects.
          type: string
        entityUri:
          description: The URI path that the user can do a GET on to access the resource metadata.
          type: string
        identifier:
          description: The identifier of the resource the work request affects.
          type: string
        metadata:
          additionalProperties:
            type: string
          description: Additional information that helps to explain the resource.
          enum:
          - VM_CLUSTER_ID
          - HOSTNAMES
          - COMMANDS
          - RESULT_LOCATION
          - IS_DRY_RUN
          type: object
          x-obmcs-top-level-enum: '#/definitions/WorkRequestResourceMetadataKey'
      required:
      - actionType
      - entityType
      - identifier
    WorkRequestErrorCollection:
      description: Results of a workRequestError search. Contains both WorkRequestError items and other information, such as metadata.
      properties:
        items:
          description: List of workRequestError objects.
          items:
            $ref: '#/components/schemas/WorkRequestError'
          type: array
      required:
      - items
      type: object
    RerunWorkRequestDetails:
      description: Provides the information used to target specific resources for the rerun of a work request.
      properties:
        managedInstances:
          description: List of managed instance [OCIDs](/iaas/Content/General/Concepts/identifiers.htm) to affected by the rerun of the work request.
          items:
            type: string
          type: array
        workRequestDetails:
          $ref: '#/components/schemas/WorkRequestDetails'
      type: object
    WorkRequestSummary:
      description: A summary of the status of a work request.
      properties:
        compartmentId:
          description: 'The ID 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

            '
          type: string
        id:
          description: The id of the work request.
          type: string
        operationType:
          description: Type of the work request.
          enum:
          - CREATE_AZURE_CONNECTOR
          - DELETE_AZURE_CONNECTOR
          - UPDATE_AZURE_CONNECTOR
          - MOVE_AZURE_CONNECTOR
          - REFRESH_AZURE_CONNECTOR
          - CREATE_AZURE_BLOB_CONTAINER
          - DELETE_AZURE_BLOB_CONTAINER
          - UPDATE_AZURE_BLOB_CONTAINER
          - MOVE_AZURE_BLOB_CONTAINER
          - CREATE_AZURE_BLOB_MOUNT
          - MOVE_AZURE_BLOB_MOUNT
          - UPDATE_AZURE_BLOB_MOUNT
          - DELETE_AZURE_BLOB_MOUNT
          - CREATE_MULTICLOUD_DISCOVERY
          - DELETE_MULTICLOUD_DISCOVERY
          - UPDATE_MULTICLOUD_DISCOVERY
          - MOVE_MULTICLOUD_DISCOVERY
          - CREATE_AZURE_VAULT
          - DELETE_AZURE_VAULT
          - UPDATE_AZURE_VAULT
          - MOVE_AZURE_VAULT
          - REFRESH_AZURE_VAULT
          - CREATE_AZURE_VAULT_ASSOCIATION
          - DELETE_AZURE_VAULT_ASSOCIATION
          - UPDATE_AZURE_VAULT_ASSOCIATION
          - MOVE_AZURE_VAULT_ASSOCIATION
          - PATCH_DB_RESOURCE
          - CREATE_GCP_IDENTITY_CONFIGURATION
          - DELETE_GCP_IDENTITY_CONFIGURATION
          - CREATE_GCP_CONNECTOR
          - DELETE_GCP_CONNECTOR
          - UPDATE_GCP_CONNECTOR
          - MOVE_GCP_CONNECTOR
          - REFRESH_GCP_CONNECTOR
          - GCP_DISCOVERY
          - CREATE_GCP_KEY_RING
          - DELETE_GCP_KEY_RING
          - UPDATE_GCP_KEY_RING
          - MOVE_GCP_KEY_RING
          - REFRESH_GCP_KEY_RING
          - CREATE_AWS_CONNECTOR
          - DELETE_AWS_CONNECTOR
          - UPDATE_AWS_CONNECTOR
          - MOVE_AWS_CONNECTOR
          - REFRESH_AWS_CONNECTOR
          - CREATE_AWS_KEY
          - DELETE_AWS_KEY
          - UPDATE_AWS_KEY
          - MOVE_AWS_KEY
          - REFRESH_AWS_KEY
          - CREATE_REPLICATE_RESOURCE
          - UPDATE_REPLICATE_RESOURCE
          - DELETE_REPLICATE_RESOURCE
          - MOVE_REPLICATE_RESOURCE
          - REFRESH_REPLICATE_RESOURCE
          - REPLICATE
          type: string
          x-obmcs-top-level-enum: '#/definitions/OperationType'
        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: Status of current work request.
          enum:
          - ACCEPTED
          - IN_PROGRESS
          - WAITING
          - NEEDS_ATTENTION
          - FAILED
          - SUCCEEDED
          - CANCELING
          - CANCELED
          type: string
          x-obmcs-top-level-enum: '#/definitions/OperationStatus'
        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 object 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:
      - operationType
      - status
      - id
      - compartmentId
      - resources
      - percentComplete
      - timeAccepted
    WorkRequestError:
      description: An error encountered while executing a work request.
      properties:
        code:
          description: 'A machine-usable code for the error that occured. Error codes are listed on

            (https://docs.cloud.oracle.com/Content/API/References/apierrors.htm)

            '
          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
    WorkRequestLogEntry:
      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
    WorkRequestDetails:
      description: Provides the name and description of the job.
      properties:
        description:
          description: User-specified information about the job. Avoid entering confidential information.
          maxLength: 400
          minLength: 0
          type: string
        displayName:
          description: A user-friendly name for the job. The name does not have to be unique. Avoid entering confidential information.
          maxLength: 255
          minLength: 1
          type: string
      type: object
    WorkRequestLogEntryCollection:
      description: Results of a workRequestLog search. Contains both workRequestLog items and other information, such as metadata.
      properties:
        items:
          description: List of workRequestLogEntries.
          items:
            $ref: '#/components/schemas/WorkRequestLogEntry'
          type: array
      required:
      - items
      type: object
    WorkRequest:
      description: A description of work request status.
      properties:
        compartmentId:
          description: 'The ID 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

            '
          type: string
        id:
          description: The id of the work request.
          type: string
        operationType:
          description: Type of the work request.
          enum:
          - CREATE_AZURE_CONNECTOR
          - DELETE_AZURE_CONNECTOR
          - UPDATE_AZURE_CONNECTOR
          - MOVE_AZURE_CONNECTOR
          - REFRESH_AZURE_CONNECTOR
          - CREATE_AZURE_BLOB_CONTAINER
          - DELETE_AZURE_BLOB_CONTAINER
          - UPDATE_AZURE_BLOB_CONTAINER
          - MOVE_AZURE_BLOB_CONTAINER
          - CREATE_AZURE_BLOB_MOUNT
          - MOVE_AZURE_BLOB_MOUNT
          - UPDATE_AZURE_BLOB_MOUNT
          - DELETE_AZURE_BLOB_MOUNT
          - CREATE_MULTICLOUD_DISCOVERY
          - DELETE_MULTICLOUD_DISCOVERY
          - UPDATE_MULTICLOUD_DISCOVERY
          - MOVE_MULTICLOUD_DISCOVERY
          - CREATE_AZURE_VAULT
          - DELETE_AZURE_VAULT
          - UPDATE_AZURE_VAULT
          - MOVE_AZURE_VAULT
          - REFRESH_AZURE_VAULT
          - CREATE_AZURE_VAULT_ASSOCIATION
          - DELETE_AZURE_VAULT_ASSOCIATION
          - UPDATE_AZURE_VAULT_ASSOCIATION
          - MOVE_AZURE_VAULT_ASSOCIATION
          - PATCH_DB_RESOURCE
          - CREATE_GCP_IDENTITY_CONFIGURATION
          - DELETE_GCP_IDENTITY_CONFIGURATION
          - CREATE_GCP_CONNECTOR
          - DELETE_GCP_CONNECTOR
          - UPDATE_GCP_CONNECTOR
          - MOVE_GCP_CONNECTOR
          - REFRESH_GCP_CONNECTOR
          - GCP_DISCOVERY
          - CREATE_GCP_KEY_RING
          - DELETE_GCP_KEY_RING
          - UPDATE_GCP_KEY_RING
          - MOVE_GCP_KEY_RING
          - REFRESH_GCP_KEY_RING
          - CREATE_AWS_CONNECTOR
          - DELETE_AWS_CONNECTOR
          - UPDATE_AWS_CONNECTOR
          - MOVE_AWS_CONNECTOR
          - REFRESH_AWS_CONNECTOR
          - CREATE_AWS_KEY
          - DELETE_AWS_KEY
          - UPDATE_AWS_KEY
          - MOVE_AWS_KEY
          - REFRESH_AWS_KEY
          - CREATE_REPLICATE_RESOURCE
          - UPDATE_REPLICATE_RESOURCE
          - DELETE_REPLICATE_RESOURCE
          - MOVE_REPLICATE_RESOURCE
          - REFRESH_REPLICATE_RESOURCE
          - REPLICATE
          type: string
          x-obmcs-top-level-enum: '#/definitions/OperationType'
        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: Status of current work request.
          enum:
          - ACCEPTED
          - IN_PROGRESS
          - WAITING
          - NEEDS_ATTENTION
          - FAILED
          - SUCCEEDED
          - CANCELING
          - CANCELED
          type: string
          x-obmcs-top-level-enum: '#/definitions/OperationStatus'
        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 object 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:
      - operationType
      - status
      - id
      - compartmentId
      - resources
      - percentComplete
      - timeAccepted
  responses:
    default:
      description: Unknown Error
      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
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
x-refined-from:
- oci-database-multicloud-integrations-openapi.yaml
- oci-delegate-access-control-openapi.yaml
- oci-managed-access-openapi.yaml
- oci-organizations-1-openapi.yaml
- oci-organizations-openapi.yaml
- oci-osmh-openapi.yaml
- oci-vmware-1-openapi.yaml
- oci-vmware-openapi.yaml
- oci-waa-openapi.yaml
- oci-workrequests-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-pro

# --- truncated at 32 KB (33 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/oracle/refs/heads/main/openapi/oracle-workrequest-api-openapi.yml