WorkRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/oracle/main/json-schema/oracle-work-request-schema.json",
  "title": "WorkRequest",
  "description": "A description of workrequest status",
  "x-generated": "2026-10-03",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/oracle-accessgovernancecp-api-openapi.yml#/components/schemas/WorkRequest",
  "properties": {
    "compartmentId": {
      "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",
      "type": "string"
    },
    "id": {
      "description": "The OCID of the work request.",
      "type": "string"
    },
    "operationType": {
      "description": "Type of the work request",
      "enum": [
        "CREATE_GOVERNANCE_INSTANCE",
        "DELETE_GOVERNANCE_INSTANCE",
        "UPDATE_GOVERNANCE_INSTANCE"
      ],
      "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": "#/$defs/WorkRequestResource"
      },
      "maxItems": 50,
      "type": "array"
    },
    "status": {
      "description": "Status of current work request.",
      "enum": [
        "ACCEPTED",
        "IN_PROGRESS",
        "WAITING",
        "FAILED",
        "SUCCEEDED",
        "CANCELING",
        "CANCELED",
        "NEEDS_ATTENTION"
      ],
      "type": "string",
      "x-obmcs-top-level-enum": "#/definitions/OperationStatus"
    },
    "timeAccepted": {
      "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",
      "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).\n",
      "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),\nsection 14.29.\n",
      "format": "date-time",
      "type": "string"
    }
  },
  "required": [
    "operationType",
    "status",
    "id",
    "compartmentId",
    "resources",
    "percentComplete",
    "timeAccepted"
  ],
  "$defs": {
    "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.\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",
            "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": [
            "IS_DRY_RUN"
          ],
          "type": "object",
          "x-obmcs-top-level-enum": "#/definitions/WorkRequestResourceMetadataKey"
        }
      },
      "required": [
        "actionType",
        "entityType",
        "identifier"
      ]
    }
  }
}