OccCapacityRequestCollection

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/oracle/json-schema/oracle-occ-capacity-request-collection-schema.json",
  "title": "OccCapacityRequestCollection",
  "description": "A list of capacity requests.",
  "x-generated": "2026-11-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/oracle-capacitymanagement-api-openapi.yml#/components/schemas/OccCapacityRequestCollection",
  "properties": {
    "items": {
      "description": "An array of capacity requests.",
      "items": {
        "$ref": "#/$defs/OccCapacityRequestSummary"
      },
      "type": "array"
    }
  },
  "required": [
    "items"
  ],
  "type": "object",
  "x-example": "Example 1\n{\n  \"items\":\n    [\n    {\n      id: \"ocid1.capacityRequest.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n      compartmentId: \"ocid1.compartment.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n      displayName: \"Capacity Request\",\n      description: \"This is the capacity request made for 2nd March\",\n      namespace: \"COMPUTE\",\n      region: \"US-ASHBURN-1\",\n      availabilityDomain: \"US-ASHBURN-1-AD-1\",\n      dateExpectedCapacityHandover: \"2023-03-16T00:00:00Z\",\n      requestState: \"SUBMITTED\",\n      timeCreated: \"2023-06-03T17:32:28Z\",\n      timeUpdated: \"2023-06-03T17:32:28Z\",\n      lifecycleState: \"ACTIVE\",\n      lifecycleDetails: null,\n      freeformTags: {},\n      definedTags: {},\n      details: [{\n        resourceType: \"SERVER_HW\",\n        resourceName: \"BM.Standard2.52\",\n        requiredQuantity: 200,\n        workloadType: \"GENERIC\"\n      }]\n    }\n    ]\n}\n",
  "$defs": {
    "OccCapacityRequestSummary": {
      "description": "A summary model for the capacity request model.\n",
      "properties": {
        "availabilityDomain": {
          "description": "The availability domain (AD) for which the capacity request was made.",
          "type": "string"
        },
        "compartmentId": {
          "description": "The OCID of the tenancy from which the request was made.",
          "type": "string"
        },
        "dateExpectedCapacityHandover": {
          "description": "The date by which the capacity requested by customers before dateFinalCustomerOrder needs to be fulfilled.",
          "format": "date-time",
          "type": "string"
        },
        "definedTags": {
          "additionalProperties": {
            "additionalProperties": {
              "description": "The value of the tag. Only string type is supported.\n",
              "type": "object"
            },
            "description": "Key-value pair representing predefined tags' keys and values scoped to a namespace.\nExample: `{\"bar-key\": \"value\"}`\n",
            "type": "object"
          },
          "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace.\nExample: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`\n",
          "type": "object"
        },
        "description": {
          "description": "Meaningful text about the capacity request.",
          "type": "string"
        },
        "displayName": {
          "description": "The display name of the capacity request.",
          "type": "string"
        },
        "freeformTags": {
          "additionalProperties": {
            "type": "string"
          },
          "description": "Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.\nExample: `{\"bar-key\": \"value\"}`\n",
          "type": "object"
        },
        "id": {
          "description": "The OCID of the capacity request.",
          "type": "string"
        },
        "lifecycleDetails": {
          "description": "A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed State.",
          "type": "string"
        },
        "lifecycleState": {
          "description": "The current lifecycle state of the customer group.",
          "type": "string",
          "x-obmcs-enumref": "#/definitions/OccCapacityRequest/lifecycleState"
        },
        "namespace": {
          "description": "The name of the OCI service in consideration. For example, Compute, Exadata, and so on.\n",
          "enum": [
            "COMPUTE"
          ],
          "type": "string",
          "x-obmcs-top-level-enum": "#/definitions/Namespace"
        },
        "occAvailabilityCatalogId": {
          "description": "The OCID of the availability catalog against which the capacity request was placed.",
          "type": "string"
        },
        "occCustomerGroupId": {
          "description": "The OCID of the customer group to which this customer belongs to.",
          "type": "string"
        },
        "region": {
          "description": "The name of the region for which the capacity request was made.",
          "type": "string"
        },
        "requestState": {
          "description": "A list of states through which the capacity request goes by.",
          "type": "string",
          "x-obmcs-enumref": "#/definitions/OccCapacityRequest/requestState"
        },
        "requestType": {
          "description": "Type of Capacity Request(New or Transfer)",
          "type": "string",
          "x-obmcs-enumref": "#/definitions/OccCapacityRequest/requestType"
        },
        "systemTags": {
          "additionalProperties": {
            "additionalProperties": {
              "description": "The value of the tag. Only string type is supported.\n",
              "type": "object"
            },
            "description": "Key-value pair representing system tags' keys and values scoped to a namespace.\nExample: `{\"bar-key\": \"value\"}`\n",
            "type": "object"
          },
          "description": "System tags for this resource. Each key is predefined and scoped to a namespace.\nExample: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`\n",
          "type": "object"
        },
        "timeCreated": {
          "description": "The time when the capacity request was created.",
          "format": "date-time",
          "type": "string"
        },
        "timeUpdated": {
          "description": "The time when the capacity request was updated.",
          "format": "date-time",
          "type": "string"
        }
      },
      "required": [
        "id",
        "compartmentId",
        "occAvailabilityCatalogId",
        "namespace",
        "displayName",
        "occCustomerGroupId",
        "region",
        "availabilityDomain",
        "dateExpectedCapacityHandover",
        "lifecycleState",
        "requestState",
        "timeCreated",
        "timeUpdated"
      ],
      "type": "object",
      "x-example": "Example 1\n{\n  id: \"ocid1.capacityRequest.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n  compartmentId: \"ocid1.compartment.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n  displayName: \"Capacity Request\",\n  description: \"This is the capacity request made for 2nd March\",\n  namespace: \"COMPUTE\",\n  region: \"US-ASHBURN-1\",\n  availabilityDomain: \"US-ASHBURN-1-AD-1\",\n  dateExpectedCapacityHandover: \"2023-03-16T00:00:00Z\",\n  requestState: \"SUBMITTED\",\n  timeCreated: \"2023-06-03T17:32:28Z\",\n  timeUpdated: \"2023-06-03T17:32:28Z\",\n  lifecycleState: \"ACTIVE\",\n  lifecycleDetails: null,\n  freeformTags: {},\n  definedTags: {}\n}\n"
    }
  }
}