OccCapacityRequest
A single request of some quantity of a specific server type, in a specific location and expected delivery date. The maximum amount possible to request is the smallest number between the number of servers available for purchase and the number of servers allowed by the constraints (For example, power, network, physical space, and so on).
Properties
| Name | Type | Description |
|---|---|---|
| availabilityDomain | string | The availability domain (AD) for which the capacity request was made. |
| compartmentId | string | The OCID of the tenancy from which the request was made. |
| dateExpectedCapacityHandover | string | The date by which the capacity requested by customers before dateFinalCustomerOrder needs to be fulfilled. |
| definedTags | object | Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` |
| description | string | Meaningful text about the capacity request. |
| details | array | A list of resources requested as part of this request |
| displayName | string | The display name of the capacity request. |
| freeformTags | object | Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` |
| id | string | The OCID of the capacity request. |
| lifecycleDetails | string | 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. |
| lifecycleState | string | The current lifecycle state of the resource. |
| namespace | string | The name of the OCI service in consideration. For example, Compute, Exadata, and so on. |
| occAvailabilityCatalogId | string | The OCID of the availability catalog against which the capacity request was placed. |
| occCustomerGroupId | string | The OCID of the customer group to which this customer belongs to. |
| region | string | The name of the region for which the capacity request was made. |
| requestState | string | The different states the capacity request goes through. |
| requestType | string | Type of Capacity Request(New or Transfer) |
| systemTags | object | System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` |
| timeCreated | string | The time when the capacity request was created. |
| timeUpdated | string | The time when the capacity request was updated. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://artifacts.apis.io/oracle/json-schema/oracle-occ-capacity-request-schema.json",
"title": "OccCapacityRequest",
"description": "A single request of some quantity of a specific server type, in a specific location and expected delivery date. The maximum amount possible to request is the smallest number between the number of servers available for purchase and the number of servers allowed by the constraints (For example, power, network, physical space, and so on).\n",
"x-generated": "2026-11-04",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/oracle-capacitymanagement-api-openapi.yml#/components/schemas/OccCapacityRequest",
"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"
},
"details": {
"description": "A list of resources requested as part of this request",
"items": {
"$ref": "#/$defs/OccCapacityRequestBaseDetails"
},
"maxItems": 100,
"type": "array"
},
"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 resource.",
"enum": [
"CREATING",
"UPDATING",
"ACTIVE",
"DELETING",
"DELETED",
"FAILED"
],
"type": "string"
},
"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": "The different states the capacity request goes through.",
"enum": [
"CREATED",
"SUBMITTED",
"REJECTED",
"IN_PROGRESS",
"COMPLETED",
"PARTIALLY_COMPLETED",
"CANCELLED",
"DELETED"
],
"type": "string"
},
"requestType": {
"default": "NEW",
"description": "Type of Capacity Request(New or Transfer)",
"enum": [
"NEW",
"TRANSFER"
],
"type": "string"
},
"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",
"details"
],
"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 details: [{\n resourceType: \"SERVER_HW\",\n resourceName: \"BM.Standard2.52\",\n requiredQuantity: 200,\n workloadType: \"GENERIC\"\n }]\n}\n",
"$defs": {
"AssociatedOccHandoverResourceBlock": {
"description": "Details about the resource block that was handed over.\n",
"properties": {
"handoverQuantity": {
"description": "The total quantity of the resource that was made available to the customer as part of this resource block\n",
"format": "int64",
"type": "integer"
},
"occHandoverResourceBlockId": {
"description": "The OCID of the handed over resource block.\n",
"type": "string"
}
},
"type": "object"
},
"OccCapacityRequestBaseDetails": {
"description": "The details of the create capacity request. This model serves as a base for different namespaces.",
"properties": {
"actualHandoverQuantity": {
"description": "The actual handed over quantity of resources at the time of request resolution.",
"format": "int64",
"type": "integer"
},
"associatedOccHandoverResourceBlockList": {
"description": "A list containing details about occHandoverResourceBlocks which were handed over for the corresponding resource name.\n",
"items": {
"$ref": "#/$defs/AssociatedOccHandoverResourceBlock"
},
"maxItems": 100,
"type": "array"
},
"availabilityDomain": {
"description": "The availability domain of the resource which is to be transferred. Note that this is only required for Capacity Request Transfer requests.",
"type": "string"
},
"dateActualHandover": {
"description": "The date on which the actual handover quantity of resources is delivered.",
"format": "date-time",
"type": "string"
},
"dateExpectedHandover": {
"description": "The date on which the latest increment to supplied quantity of resources was delivered.",
"format": "date-time",
"type": "string"
},
"demandQuantity": {
"description": "The number of compute server's with name <resourceName> required by the user.",
"format": "int64",
"type": "integer"
},
"expectedHandoverQuantity": {
"description": "The incremental quantity of resources supplied as the provisioning is underway.",
"format": "int64",
"type": "integer"
},
"resourceName": {
"description": "The name of the COMPUTE server shape for which the request is made. Do not use CAPACITY_CONSTRAINT as the resource name.",
"type": "string"
},
"resourceType": {
"description": "The type of the resource against which the user wants to place a capacity request.",
"type": "string"
},
"sourceWorkloadType": {
"description": "The WorkloadType from where capacity request are to be transferred.",
"type": "string"
},
"workloadType": {
"description": "The type of the workload (Generic/ROW).",
"type": "string"
}
},
"required": [
"resourceType",
"workloadType",
"resourceName",
"demandQuantity"
],
"x-example": "Example 1\n{\n \"resourceType\": \"SERVER_HW\",\n \"workloadType\": \"GENERIC\",\n \"expectedHandoverQuantity\": null,\n \"dateExpectedHandover\": null,\n \"actualHandoverQuantity\": null,\n \"dateActualHandover\": null,\n \"resourceName\": \"BM.Standard2.52\",\n \"demandQuantity\": 135\n}\nExample 2\n{\n \"resourceType\": \"SERVER_HW\",\n \"workloadType\": \"ROW\",\n \"expectedHandoverQuantity\": null,\n \"dateExpectedHandover\": null,\n \"actualHandoverQuantity\": null,\n \"dateActualHandover\": null,\n \"sourceWorkloadType\": \"US_PROD\",\n \"availabilityDomain\": \"US-ASHBURN-1-AD-1\",\n \"associatedOccHandoverResourceBlocks\": [{\n \"occHandoverResourceBlockId\": \"ocid1.occhandoverresourceblock.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n \"handoverQuantity\": 23\n }],\n \"resourceName\": \"BM.Standard2.52\",\n \"demandQuantity\": 135\n}\n"
}
}
}
Work with this as data
Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
curl "https://apis.io/api/v1/json-schemas/oracle-occ-capacity-request"
curl "https://apis.io/api/v1/json-schemas?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.