openapi: 3.2.0 info: description: OCI Control Center (OCC) Capacity Management enables you to manage capacity requests in realms where OCI Control Center Capacity Management is available. For more information, see [OCI Control Center](/iaas/Content/control-center/home.htm). title: OCI Control Center Capacity Management API version: '20231107' x-provenance: method: harvested first_party: true publisher: Oracle source: https://docs.oracle.com/en-us/iaas/api/specs/5c5cc26928af17a068bdb45a2ae93089e20749d4307cbab1d3de8a9747ae3f4e.yaml harvested: '2026-08-04' note: Published by Oracle as the contract for the OCI Control Center Capacity Management API OCI service and stored verbatim; API Evangelist added only this provenance block. x-evidence: - url: https://docs.oracle.com/en-us/iaas/api/specs/index.json what: Oracle's own index of every OCI service specification - url: https://docs.oracle.com/en-us/iaas/api/specs/5c5cc26928af17a068bdb45a2ae93089e20749d4307cbab1d3de8a9747ae3f4e.yaml what: the harvested document for OCI Control Center Capacity Management API servers: - url: http://127.0.0.1/20231107 - url: https://127.0.0.1/20231107 tags: - name: capacityManagement paths: /namespace/{namespace}/occOverview: get: description: 'Lists an overview of all resources in that namespace in a given time interval. ' operationId: ListOccOverviews parameters: - $ref: '#/components/parameters/FilterByNamespacePathParam' - $ref: '#/components/parameters/FilterByCompartmentIdQueryParam' - $ref: '#/components/parameters/FilterByFromQueryParam' - $ref: '#/components/parameters/FilterByToQueryParam' - $ref: '#/components/parameters/WorkloadTypeQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/OccOverviewSortByQueryParam' responses: 200: description: The overview details against the timeInterval specified in the request headers: 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. ' 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/OccOverviewCollection' 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: A GET call to list overview of resources in a given time interval tags: - capacityManagement x-example: 'Example1 Request: GET /20231107/namespace/COMPUTE/overview?compartmentId=ocid1.compartment.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4&from="JANUARY 2023"&to="JUNE 2023" ' /occAvailabilityCatalogs: get: description: Lists all availability catalogs. operationId: ListOccAvailabilityCatalogs parameters: - $ref: '#/components/parameters/FilterByCompartmentIdQueryParam' - $ref: '#/components/parameters/FilterByNamespaceQueryParam' - $ref: '#/components/parameters/FilterByOccAvailabilityCatalogIdQueryParam' - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' - $ref: '#/components/parameters/FilterByCatalogStateQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/OccAvailabilityCatalogSortByQueryParam' responses: 200: description: List of availability catalogs. headers: 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. ' 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/OccAvailabilityCatalogCollection' 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 availability catalogs. tags: - capacityManagement x-example: "Example 1 request: List occAvailabilityCatalogs for a compartment\n GET /20231107/occAvailabilityCatalogs?compartmentId=\"ocid1.compartment.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\"\n" /occAvailabilityCatalogs/{occAvailabilityCatalogId}: get: description: Get details about availability catalog. operationId: GetOccAvailabilityCatalog parameters: - $ref: '#/components/parameters/OccAvailabilityCatalogIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The availability catalog details. 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 content: application/json: schema: $ref: '#/components/schemas/OccAvailabilityCatalog' 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: Details about a particular availability catalog. tags: - capacityManagement x-example: "Example 1 request:\n GET /20231107/occAvailabilityCatalogs/ocid1.availabilityCatalog.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\n" /occAvailabilityCatalogs/{occAvailabilityCatalogId}/content: get: description: 'Returns the binary contents of the availability catalog. Can be saved as a csv file. ' operationId: GetOccAvailabilityCatalogContent parameters: - $ref: '#/components/parameters/OccAvailabilityCatalogIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 200: description: The binary contents of the availability catalog were returned successfully. 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/binary: schema: format: binary 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: Export availability catalog. tags: - capacityManagement x-example: "Example 1 request:\n GET /20231107/occAvailabilityCatalogs/ocid1.availabilityCatalog.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4/content\n" x-related-resource: '#/definitions/OccAvailabilityCatalog' /occAvailabilityCatalogs/{occAvailabilityCatalogId}/occAvailabilities: get: description: Lists availabilities for a particular availability catalog. operationId: ListOccAvailabilities parameters: - $ref: '#/components/parameters/OccAvailabilityCatalogIdPathParam' - $ref: '#/components/parameters/FilterByCapacityHandoverDateQueryParam' - $ref: '#/components/parameters/ResourceNameQueryParam' - $ref: '#/components/parameters/ResourceTypeQueryParam' - $ref: '#/components/parameters/WorkloadTypeQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/AvailabilitiesSortByQueryParam' responses: 200: description: List capacity constraints. headers: 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. ' 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/OccAvailabilityCollection' 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 availabilities of an availability catalog. tags: - capacityManagement x-example: "Example 1 request:\n GET /20231107/occAvailabilityCatalogs/ocid1.availabilityCatalog.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4/occAvailabilities?compartmentId=\"ocid1.compartment.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\"\n" /occCapacityRequests: get: description: Lists all capacity requests. operationId: ListOccCapacityRequests parameters: - $ref: '#/components/parameters/FilterByCompartmentIdQueryParam' - $ref: '#/components/parameters/FilterByAvailabilityCatalogIdQueryParam' - $ref: '#/components/parameters/FilterByNamespaceQueryParam' - $ref: '#/components/parameters/FilterByRequestTypeQueryParam' - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' - $ref: '#/components/parameters/FilterByOccCapacityRequestIdQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/OccCapacityRequestSortByQueryParam' responses: 200: description: List of capacity requests. headers: 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. ' 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/OccCapacityRequestCollection' 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 capacity requests. tags: - capacityManagement x-example: "Example 1 Request:\n GET /20231107/occCapacityRequests?compartmentId=ocid1.compartment.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\n" post: description: Create Capacity Request. operationId: CreateOccCapacityRequest parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: 'The request to create capacity request was successfully received. ' headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: 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. ' 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/OccCapacityRequest' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: A post call to create capacity request. tags: - capacityManagement x-example: "Example 1 Request:\nPOST /20231107/occCapacityRequests\n{\n \"compartmentId\": \"ocid1.compartment.oc1..aaaaaaaa6nkq5revewli5e3ycmcj563o47afrhde7ws55cwn5pw2rzm3725q\",\n \"occAvailabilityCatalogId\": \"ocid1.occAvailabilityCatalog.oc1.iad.amaaaaaawoxkemia66ekv6wgm3uhdcn5yyq3shtt45dsyynaflbynafhtc5a\",\n \"namespace\": \"COMPUTE\",\n \"tenancyId\": \"ocid1.tenancy.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n \"region\": \"US-ASHBURN-1\",\n \"dateExpectedCapacityHandover\": \"2023/12/17\",\n \"displayName\": \"UI test request\",\n \"description\": \"This is the test request created for UI\",\n \"details\": \n [{\n \"resourceType\": \"SERVER_HW\",\n \"workloadType\": \"GENERIC\",\n \"resourceName\": \"BM.Standard2.52\",\n \"demandQuantity\": 135\n }]\n}\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateOccCapacityRequestDetails' description: 'The request details for creating a capacity request. ' required: true /occCapacityRequests/{occCapacityRequestId}: delete: description: Deletes the capacity request resource. operationId: DeleteOccCapacityRequest parameters: - $ref: '#/components/parameters/OccCapacityRequestIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: The request to delete the capacity request was successfully completed. 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 retry-after: description: A decimal number representing the number of seconds the client should wait before polling this endpoint again. schema: type: integer 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: Deletes the capacity request resource. This operation can only be done by operators and customers can't delete the capacity request resource. tags: - capacityManagement x-example: "Example 1 Request:\n DELETE /20231107/occCapacityRequests/ocid1.occCapacityRequest.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\n" x-related-resource: '#/definitions/OccCapacityRequest' get: description: Get details about the capacity request. operationId: GetOccCapacityRequest parameters: - $ref: '#/components/parameters/OccCapacityRequestIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The capacity request details. 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 content: application/json: schema: $ref: '#/components/schemas/OccCapacityRequest' 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: Details about a particular capacity request. tags: - capacityManagement x-example: 'Example 1 Request: GET /20231107/occCapacityRequests/ocid1.occCapacityRequest.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4 ' patch: description: Updates the OccCapacityRequest by evaluating a sequence of instructions. operationId: PatchOccCapacityRequest parameters: - $ref: '#/components/parameters/OccCapacityRequestIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Patched the capacityRequest. 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 content: application/json: schema: $ref: '#/components/schemas/OccCapacityRequest' 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: A patch api to update the OccCapacityRequestBaseDetails of OccCapacityRequest resource. tags: - capacityManagement x-example: "Example 1 Request:\n PATCH /20231107/occCapacityRequests/ocid1.occCapacityRequest.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\n {\n \"items\": [\n {\n \"operation\":\"REQUIRE\",\n \"selection\": \"details\",\n \"value\": {\n \"resourceName\": \"BM.BigData3.E4.128\",\n \"workloadType\": \"ROW\"\n \"demandQuantity\": \"48\"\n }\n }\n ]\n }\nExample 2 Request:\n PATCH /20231107/occCapacityRequests/ocid1.occCapacityRequest.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\n {\n \"items\": [\n {\n \"operation\":\"INSERT\",\n \"selection\": \"details\",\n \"value\": {\n \"resourceName\": \"BM.BigData3.E4.128\",\n \"resourceType\": \"SERVER_HW\",\n \"workloadType\": \"ROW\"\n \"demandQuantity\": \"48\"\n }\n }\n ]\n }\nExample 3 Request:\n# https://confluence.oci.oraclecorp.com/pages/viewpage.action?spaceKey=DEX&title=JSON+List+Patch\n# https://jmespath.org/proposals/improved-filters.html\n PATCH /20231107/occCapacityRequests/ocid1.occCapacityRequest.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\n {\n \"items\": [\n {\n \"operation\":\"REMOVE\",\n \"selection\": \"details[?resourceName=='BM.BigData3.E4.128' && workloadType=='ROW']\"\n }\n ]\n }\n" x-related-resource: '#/definitions/OccCapacityRequest' requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchOccCapacityRequestDetails' description: Request to update the details of the capacity request. required: true put: description: The request to update the capacity request. The user can perform actions like closing a partially completed request so that it doesn't go ahead for full completion. operationId: UpdateOccCapacityRequest parameters: - $ref: '#/components/parameters/OccCapacityRequestIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: 'The request to update the capacity request has been successfully received and updation is in progress. ' 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/OccCapacityRequest' 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: Updates the capacity request. tags: - capacityManagement x-example: "Example 1 Request:\n PUT /20231107/occCapacityRequests/ocid1.occCapacityRequest.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\n {\n \"requestState\": \"CANCELLED\"\n }\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateOccCapacityRequestDetails' description: Request to update the properties of the capacity request. required: true /occHandoverResourceBlockDetails: get: description: 'List details about a given occHandoverResourceBlock. ' operationId: ListOccHandoverResourceBlockDetails parameters: - $ref: '#/components/parameters/FilterByOccHandoverResourceBlockIdRequiredQueryParam' - $ref: '#/components/parameters/FilterByHostIdQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/OccHandoverResourceBlockDetailsSortByQueryParam' responses: 200: description: 'A list containing the details about a specified occHandoverResourceBlock. ' headers: 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. ' 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/OccHandoverResourceBlockDetailCollection' 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: A GET call to list the details about the specified occHandoverResourceBlock. tags: - capacityManagement x-example: 'Example 1 Request GET /20231107/occResourceHandoverBlockDetails?occResourceHandoverBlockId=ocid1.occresourceblock.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4 ' x-obmcs-cli-action: list /occHandoverResourceBlocks: get: description: 'List Occ Handover Resource blocks. ' operationId: ListOccHandoverResourceBlocks parameters: - $ref: '#/components/parameters/FilterByNamespaceQueryParam' - $ref: '#/components/parameters/FilterByCompartmentIdOptionalQueryParam' - $ref: '#/components/parameters/FilterByHandoverResourceNameQueryParam' - $ref: '#/components/parameters/FilterByStartHandoverDateQueryParam' - $ref: '#/components/parameters/FilterByEndHandoverDateQueryParam' - $ref: '#/components/parameters/FilterByOccHandoverResourceBlockIdQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/OccHandoverResourceBlockSortByQueryParam' responses: 200: description: 'A list containing details about the resources handed over by oracle in the period specified by startDate(inclusive) and endDate(inclusive). ' headers: 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. ' 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/OccHandoverResourceBlockCollection' 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: A GET call to list occ handover resource blocks. tags: - capacityManagement x-example: "Example 1 Request:\n GET /20231107/occHandoverResourceBlocks?compartmentId=ocid1.compartment.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4&&namespace=COMPUTE\n" x-obmcs-cli-action: list components: schemas: MetadataDetails: description: Used for representing the metadata of the catalog. This denotes the version and format of the CSV file for parsing. properties: formatVersion: default: V2 description: The version for the format of the catalog file being uploaded. enum: - V1 - V2 type: string required: - formatVersion type: object x-example: "Example 1\n{\n \"formatVersion\": \"V2\"\n}\n" PlacementDetails: description: 'Details like building, room and block where the resource was placed after provisioning in the datacenter. ' properties: availabilityDomain: description: 'The availability domain (AD) for which the resources were provisioned. ' type: string block: description: 'The block in the datacenter room where the resource was placed. ' type: string building: description: 'The datacenter building where the resource was placed. ' type: string region: description: 'The name of the region for which the resources were provisioned. ' type: string room: description: 'The name of the room in the dataacenter building where the resource was placed. ' type: string workloadType: description: 'The type of workload to which these resources were provisioned. ' type: string required: - region - availabilityDomain - workloadType - building - room - block type: object 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). ' 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. ' 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 description: description: Meaningful text about the capacity request. type: string details: description: A list of resources requested as part of this request items: $ref: '#/components/schemas/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. Example: `{"bar-key": "value"}` ' 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. ' 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. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' 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" 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 OccHandoverResourceBlockSummary: description: 'Details about the association of capacity requests with the corresponding resources handed over by oracle. ' properties: associatedCapacityRequests: description: 'A list containing details about the capacity requests against which the resources were provisioned by oracle. ' items: $ref: '#/components/schemas/AssociatedCapacityRequestDetails' maxItems: 100 type: array compartmentId: description: 'The OCID of the compartment where the resource block''s are placed. ' type: string handoverDate: description: 'The date on which the resource was handed over to the customer. ' format: date-time type: string handoverResourceName: description: "The name of the resource handed over by oracle. \nFor instance for compute namespace this will be the name of the bare metal hardware resource.\n" type: string id: description: 'The OCID of the resource block. ' type: string namespace: description: "The name of the OCI service in consideration. \nFor example Compute, Exadata and so on.\n" enum: - COMPUTE type: string x-obmcs-top-level-enum: '#/definitions/Namespace' occCustomerGroupId: description: 'The OCID of the customer group for which the resources were provisioned. ' type: string placementDetails: $ref: '#/components/schemas/PlacementDetails' totalHandoverQuantity: description: 'The total quantity of the resource that was made available to the customer by Oracle. ' format: int64 type: integer required: - id - compartmentId - namespace - occCustomerGroupId - handoverDate - handoverResourceName - totalHandoverQuantity - associatedCapacityRequests - placementDetails type: object OccHandoverResourceBlockDetailSummary: description: "Detailed information about a particular occHandoverResourceBlock. \nFor compute namespace this information includes host serial, host ocid etc.\n" properties: details: additionalProperties: type: string description: 'A map that contains additional details for a given handover resource. For example for compute namespace this includes host ocid, host serial etc. ' maxProperties: 100 type: object occResourceHandoverBlockId: description: 'The OCID of the occResourceHandoverBlock. ' type: string required: - occResourceHandoverBlockId - details type: object PatchOccCapacityRequestDetails: description: CapacityRequest details to patch. properties: items: description: List of patch instructions. items: $ref: '#/components/schemas/PatchInstruction' type: array type: object x-example: "Example 1\n{\n \"items\":\n [{\n \"operation\":\"REQUIRE\",\n \"selection\": \"details\",\n \"value\": {\n \"resourceName\": \"BM.BigData3.E4.128\",\n \"workloadType\": \"ROW\",\n \"demandQuantity\": \"20\"\n }\n }]\n}\nExample 2\n{\n \"items\":\n [{\n \"operation\":\"INSERT\",\n \"selection\": \"details\",\n \"value\": {\n \"resourceName\": \"BM.BigData3.E4.128\",\n \"workloadType\": \"ROW\",\n \"demandQuantity\": \"20\"\n }\n }]\n}\nExample 3\n{\n \"items\":\n [{\n \"operation\":\"REMOVE\",\n \"selection\": \"details[?resourceName=='BM.BigData3.E4.128' && workloadType=='ROW']\"\n }]\n}\n" OccCapacityRequestCollection: description: A list of capacity requests. properties: items: description: An array of capacity requests. items: $ref: '#/components/schemas/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" AssociatedOccHandoverResourceBlock: description: 'Details about the resource block that was handed over. ' properties: handoverQuantity: description: 'The total quantity of the resource that was made available to the customer as part of this resource block ' format: int64 type: integer occHandoverResourceBlockId: description: 'The OCID of the handed over resource block. ' type: string type: object OccOverviewCollection: description: A list representing response of overview API. properties: items: description: An array of overview summary. items: $ref: '#/components/schemas/OccOverviewSummary' type: array required: - items type: object x-example: "Example 1\n{\n \"items\": \n [\n {\n compartmentId: \"ocid1.compartment.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n periodValue: \"MARCH 2023\",\n resourceName: \"BM.Standard.V3\",\n totalAvailable: 100,\n totalDemanded: 40,\n totalSupplied: 10,\n totalRejected: 30,\n totalCancelled: 0,\n totalUnfulfilled: 0,\n workloadTypeBreakdownDetails:\"{\n \"totalAvailableWorkloadTypeBreakdown\": {\"Generic\": 100},\n \"totalDemandedWorkloadTypeBreakdown\": {\"Generic\": 40},\n \"totalSuppliedWorkloadTypeBreakdown\": {\"Generic\": 10},\n \"totalRejectedWorkloadTypeBreakdown\": {\"Generic\": 30},\n \"totalCancelledWorkloadTypeBreakdown\": {},\n \"totalUnfulfilledWorkloadTypeBreakdown\": {},\n }\"\n capacityRequests: \"[\n { \\\"id\\\": \\\"ocid1.occcapacityRequest.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\\\",\n \\\"totalDemanded\\\": 10,\n \\\"totalSupplied\\\": 10,\n \\\"totalRejected\\\": 0,\n \\\"totalCancelled\\\": 0,\n \\\"totalUnfulfilled\\\": 0,\n \\\"workloadTypeTotalSuppliedBreakdown\\\": {\\\"Generic\\\":10}, \n \\\"workloadTypeTotalDemandedBreakdown\\\": {\\\"Generic\\\":10}, \n \\\"workloadTypeTotalRejectedBreakdown\\\": {}, \n \\\"workloadTypeTotalCancelledBreakdown\\\": {}, \n \\\"workloadTypeTotalUnfulfilledBreakdown\\\": {}, \n },\n { \\\"id\\\": \\\"ocid1.occcapacityRequest.oc1..exampleb4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\\\",\n \\\"totalDemanded\\\": 30,\n \\\"totalSupplied\\\": 0,\n \\\"totalRejected\\\": 30\n \\\"totalCancelled\\\": 0,\n \\\"totalUnfulfilled\\\": 0,\n \\\"workloadTypeTotalSuppliedBreakdown\\\": {}, \n \\\"workloadTypeTotalDemandedBreakdown\\\": {\\\"Generic\\\":30}, \n \\\"workloadTypeTotalRejectedBreakdown\\\": {\\\"Generic\\\":30}, \n \\\"workloadTypeTotalCancelledBreakdown\\\": {}, \n \\\"workloadTypeTotalUnfulfilledBreakdown\\\": {}\n }\n ]\",\n unit: \"Servers\"\n }\n ]\n}\n" OccHandoverResourceBlockDetailCollection: description: 'A list of occResourceHandoverDetails. ' properties: items: description: 'An array of details about an occ handover resource block. ' items: $ref: '#/components/schemas/OccHandoverResourceBlockDetailSummary' type: array required: - items type: object x-example: "Example 1\n{\n \"items\":\n [{\n occResourceHandoverBlockId: \"ocid1.occresourceblock.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n details: {\n \"hostSerial\": \"exampleHostSerial\",\n \"hostId\": \"exampleHostId\",\n }\n }]\n}\n" AssociatedCapacityRequestDetails: description: 'Details about the associated capacity requests against which the resources were provisioned by oracle. ' properties: handoverQuantity: description: 'The total quantity of the bare metal hardware that was made available corresponding to the capacity request ocid. ' format: int64 type: integer occCapacityRequestId: description: 'The OCID of the capacity request against which the resources were provisioned. ' maxLength: 255 minLength: 1 type: string required: - occCapacityRequestId - handoverQuantity type: object PatchInstruction: description: A single instruction to be included as part of Patch request content. discriminator: propertyName: operation properties: operation: enum: - REQUIRE - PROHIBIT - REPLACE - INSERT - REMOVE - MOVE - MERGE type: string selection: description: 'The set of values to which the operation applies as a [JMESPath expression](https://jmespath.org/specification.html) for evaluation against the context resource. An operation fails if the selection yields an exception, except as otherwise specified. Note that comparisons involving non-primitive values (objects or arrays) are not supported and will always evaluate to false. ' type: string required: - operation - selection OccAvailabilityCatalog: description: Details of the availability catalog resource. properties: catalogState: description: The different states associated with the availability catalog. enum: - NOT_UPLOADED - UPLOAD_FAILED - STAGED - PUBLISHED - OUTDATED - DELETED type: string compartmentId: description: The OCID of the tenancy where the availability catalog resides. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is 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 description: description: Text information about the availability catalog. type: string details: description: Details about capacity available for different resources in catalog. items: $ref: '#/components/schemas/OccAvailabilitySummary' maxItems: 100 type: array displayName: description: A user-friendly name for the availability catalog. 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. Example: `{"bar-key": "value"}` ' type: object id: description: The OCID of the availability catalog. 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 metadataDetails: $ref: '#/components/schemas/MetadataDetails' namespace: description: 'The name of the OCI service in consideration. For example, Compute, Exadata, and so on. ' enum: - COMPUTE type: string x-obmcs-top-level-enum: '#/definitions/Namespace' occCustomerGroupId: description: The customer group OCID to which the availability catalog belongs. type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The time when the availability catalog was created. format: date-time type: string timeUpdated: description: The time when the availability catalog was last updated. format: date-time type: string required: - id - namespace - compartmentId - displayName - occCustomerGroupId - catalogState - metadataDetails - timeCreated - timeUpdated - lifecycleState type: object x-example: "Example 1\n {\n id\": \"ocid1.availabilityCatalog.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n \"namespace\": \"COMPUTE\",\n \"displayName\": \"Catalog 1\",\n \"occCustomerGroupId\": \"ocid1.customerGroup.oc1.examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n \"catalogState\": \"PUBLISHED\",\n \"metadataDetails\": {\n \"version\": \"V1\"\n },\n \"lifecycleState\": \"ACTIVE\",\n \"lifecycleDetails\": null,\n \"definedTags\": null,\n \"freeformTags\": null,\n \"timeCreated\": \"2023-06-03T17:32:28Z\",\n \"timeUpdated\": \"2023-06-03T17:32:28Z\",\n \"details\": [\n {\n \"catalogId\": \"ocid1.availabilityCatalog.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n \"namespace\": \"COMPUTE\",\n \"dateFinalCustomerOrder\": \"2023-02-02T00:00:00Z\",\n \"dateExpectedCapacityHandover\": \"2023-03-16T00:00:00Z\",\n \"resourceType\": \"CAPACITY_CONSTRAINT\",\n \"workloadType\": \"ROW\",\n \"resourceName\": \"US-ASHBURN-1-AD-1\",\n \"availableQuantity\": 4864,\n \"totalAvailableQuantity\": 4864,\n \"demandedQuantity\": 0,\n \"unit\": \"Servers\"\n }\n ]\n }\n" OccAvailabilityCatalogCollection: description: A list of availability catalogs. properties: items: description: An array of availability catalogs. items: $ref: '#/components/schemas/OccAvailabilityCatalogSummary' type: array required: - items type: object x-example: "Example 1\n{\n \"items\":\n [{\n id\": \"ocid1.availabilityCatalog.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n \"namespace\": \"COMPUTE\",\n \"displayName\": \"Catalog 1\",\n \"occCustomerGroupId\": \"ocid1.customerGroup.oc1.examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n \"catalogState\": \"PUBLISHED\",\n \"metadataDetails\": {\n \"formatVersion\": \"V1\"\n },\n \"lifecycleState\": \"ACTIVE\",\n \"lifecycleDetails\": null,\n \"definedTags\": null,\n \"freeformTags\": null,\n \"timeCreated\": \"2023-06-03T17:32:28Z\",\n \"timeUpdated\": \"2023-06-03T17:32:28Z\"\n }]\n}\n" CreateOccCapacityRequestDetails: description: 'Details about the create request for the capacity request. ' properties: availabilityDomain: description: The availability domain (AD) in which the new resource is to be placed. If this is specified then the capacity will be validated and fulfilled within the scope of this AD. Note that this field is NOT required for Capacity request Transfer requests. type: string compartmentId: description: Since all resources are at tenancy level hence this will be the ocid of the tenancy where operation is to be performed. 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. ' 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 description: description: Meaningful text about the capacity request. type: string details: description: A list of different resources requested by the user. items: $ref: '#/components/schemas/OccCapacityRequestBaseDetails' maxItems: 100 type: array displayName: description: An user-friendly name for the capacity request. Does not have to be unique, and it's changeable. Avoid entering confidential information. 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. Example: `{"bar-key": "value"}` ' type: object 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 namespace: description: The name of the OCI service in consideration. For example, Compute, Exadata, and so on. enum: - COMPUTE type: string x-obmcs-top-level-enum: '#/definitions/Namespace' occAvailabilityCatalogId: description: The OCID of the availability catalog against which capacity request is made. type: string region: description: The name of the region for which the capacity request is made. type: string requestState: default: CREATED description: The subset of request states available for creating the capacity request. enum: - CREATED - SUBMITTED type: string requestType: description: Type of Capacity Request(New or Transfer) type: string x-obmcs-enumref: '#/definitions/OccCapacityRequest/requestType' required: - compartmentId - namespace - region - displayName - dateExpectedCapacityHandover - details type: object x-example: "Example 1\n {\n \"compartmentId\": \"ocid1.compartment.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n \"occAvailabilityCatalogId\": \"ocid1.availabilityCatalog.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca6\",\n \"namespace\": \"COMPUTE\",\n \"region\": \"US-ASHBURN-1\",\n \"availabilityDomain\": \"US-ASHBURN-AD-1\"\n \"dateExpectedCapacityHandover\": \"2023-03-16T00:00:00Z\",\n \"displayName\": \"Test Request\",\n \"description\": \"This request is for testing the CREATE API\",\n \"details\": [\n {\n \"resourceType\": \"SERVER_HW\",\n \"workloadType\": \"GENERIC\",\n \"resourceName\": \"BM.Standard2.52\",\n \"demandQuantity\": 135\n }\n ]\n }\n" UpdateOccCapacityRequestDetails: description: The details required for making an update call for capacity requests. properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is 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 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. Example: `{"bar-key": "value"}` ' type: object requestState: description: The subset of request states available for updating the capacity request. enum: - SUBMITTED - CANCELLED type: string x-example: "Example 1\n{\n \"requestState\": \"SUBMITTED\"\n}\n" OccCapacityRequestSummary: description: 'A summary model for the capacity request model. ' 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. ' 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 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. Example: `{"bar-key": "value"}` ' 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. ' 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. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' 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" 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. ' items: $ref: '#/components/schemas/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 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" OccAvailabilitySummary: description: The details about the available capacity and constraints for different resource types present in the availability catalog. properties: availableQuantity: description: The quantity of resource currently available that the customer can request. format: int64 type: integer catalogId: description: The OCID of the availability catalog. type: string dateExpectedCapacityHandover: description: The date by which the capacity requested by customers before dateFinalCustomerOrder needs to be fulfilled. format: date-time type: string dateFinalCustomerOrder: description: The date by which the customer must place the order to have their capacity requirements met by the customer handover date. format: date-time type: string demandedQuantity: description: The quantity of resource currently demanded by the customer. format: int64 type: integer namespace: description: 'The name of the OCI service in consideration. For example, Compute, Exadata, and so on. ' enum: - COMPUTE type: string x-obmcs-top-level-enum: '#/definitions/Namespace' resourceName: description: The name of the resource that the customer can request. type: string resourceType: description: The different types of resources against which customers can place capacity requests. type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object totalAvailableQuantity: description: The total quantity of resource that the customer can request. format: int64 type: integer unit: description: The unit in which the resource available is measured. type: string workloadType: description: The type of workload (Generic/ROW). type: string required: - catalogId - namespace - dateFinalCustomerOrder - dateExpectedCapacityHandover - resourceType - workloadType - resourceName - availableQuantity - totalAvailableQuantity - demandedQuantity - unit type: object x-example: "Example 1\n {\n \"catalogId\": \"ocid1.availabilityCatalog.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n \"namespace\": \"COMPUTE\",\n \"dateFinalCustomerOrder\": \"2023-02-02T00:00:00Z\",\n \"dateExpectedCapacityHandover\": \"2023-03-16T00:00:00Z\",\n \"resourceType\": \"SERVER_HW\",\n \"workloadType\": \"GENERIC\",\n \"name\": \"BM.DenseO.E4.128\",\n \"availableQuantity\": 235,\n \"totalAvailableQuantity\": 235,\n \"demandedQuantity\": 0,\n \"unit\": \"Servers\"\n }\n" OccHandoverResourceBlockCollection: description: 'A list of occ handover resource blocks. ' properties: items: description: 'An array of occ handover resource blocks. ' items: $ref: '#/components/schemas/OccHandoverResourceBlockSummary' type: array required: - items type: object x-example: "Example 1\n{\n \"items\":\n [{\n id: \"ocid1.occresourceblock.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n compartmentId: \"ocid1.tenancy.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n namespace: \"COMPUTE\",\n occCustomerGroupId: \"ocid1.occcustomergroup.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n handoverDate: \"2024-03-07T00:00:00Z\",\n handoverResourceName: \"BM.Standard3.53\",\n totalHandoverQuantity: 200\n associatedCapacityRequests: [{\n occCapacityRequestId: \"ocid1.occcapacityrequest.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n handoverQuantity: 200\n }],\n placementDetails: {\n \"region\": \"us-ashburn-1\",\n \"availabilityDomain\": \"iad.ad1\",\n \"workloadType\": \"US_PROD\",\n \"building\": \"iad18\",\n \"room\": \"iad18.1\",\n \"block\": 52\n }\n }]\n}\n" OccAvailabilityCollection: description: A list of capacity constraints. properties: items: description: An array of capacity constraints. items: $ref: '#/components/schemas/OccAvailabilitySummary' type: array required: - items type: object x-example: "Example 1\n {\n \"items\":\n [{\n \"catalogId\": \"ocid1.availabilityCatalog.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n \"namespace\": \"COMPUTE\",\n \"dateFinalCustomerOrder\": \"2023-02-02T00:00:00Z\",\n \"dateExpectedCapacityHandover\": \"2023-03-16T00:00:00Z\",\n \"resourceType\": \"SERVER_HW\",\n \"workloadType\": \"GENERIC\",\n \"name\": \"BM.DenseO.E4.128\",\n \"availableQuantity\": 235,\n \"totalAvailableQuantity\": 235,\n \"demandedQuantity\": 0,\n \"unit\": \"Servers\"\n }]\n }\n" OccOverviewSummary: description: 'The overview summary is used to represent an array item that shall be used to represent the overview of the catalog resources along with their corresponding capacity requests. ' properties: capacityRequestsBlob: description: A raw json blob containing all the capacity requests corresponding to the resource name type: string compartmentId: description: The OCID of the compartment from which the api call is made. This will be used for authorizing the request. type: string periodValue: description: The name of the month along with year for which this summary corresponds to. type: string resourceName: description: The name of the resource for which we have aggregated the value. type: string totalAvailable: description: The quantity of the resource which is available at the end of the period of aggregationDetails model in consideration. format: int64 type: integer totalCancelled: description: The quantity of the resource which is cancelled by the customer. Once the capacity request was submitted, the customer can still cancel it. This field sums up those values. format: int64 type: integer totalDemanded: description: The quantity of the resource which is demanded by customers via capacity requests against the resource name at the end of the time period in consideration for overview. format: int64 type: integer totalRejected: description: The quantity of the resource which is rejected by Oracle. format: int64 type: integer totalSupplied: description: The quantity of the resource which is supplied by Oracle to the customer against the resource name at the end of the time period in consideration. format: int64 type: integer totalUnfulfilled: description: The quantity of the resource which Oracle was unable to supply. For a given capacity request, Oracle sometimes cannot supply the entire value demanded by the customer. In such cases a partial value is provided, thereby leaving behind a portion of unfulfilled values. This field sums that up. format: int64 type: integer unit: description: The unit e.g SERVER in which the above values like totalAvailable, totalSupplied etc is measured. type: string workloadTypeBreakdownBlob: description: A raw json blob containing breakdown of totalAvailable, totalDemanded, totalSupplied, totalRejected, totalCancelled and totalUnfulfilled by workload types type: string required: - compartmentId - periodValue - resourceName - totalAvailable - totalDemanded - totalSupplied - totalCancelled - totalUnfulfilled - totalRejected - workloadTypeBreakdownBlob - unit type: object OccAvailabilityCatalogSummary: description: A catalog containing resource availability details for a customer. properties: catalogState: description: Represents whether this version of the availability catalog has been made available to the customer. The state is No by default. type: string x-obmcs-enumref: '#/definitions/OccAvailabilityCatalog/catalogState' compartmentId: description: The OCID of the tenancy where the availability catalog resides. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is 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 description: description: Text information about the availability catalog. type: string displayName: description: An user-friendly name for the availability catalog. Does not have to be unique, and is changeable. Avoid entering confidential information. 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. Example: `{"bar-key": "value"}` ' type: object id: description: The OCID of the availability catalog. 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/OccAvailabilityCatalog/lifecycleState' metadataDetails: $ref: '#/components/schemas/MetadataDetails' namespace: description: 'The name of the OCI service in consideration. For example, Compute, Exadata, and so on. ' enum: - COMPUTE type: string x-obmcs-top-level-enum: '#/definitions/Namespace' occCustomerGroupId: description: The Customer Group OCID to which the availability catalog belongs. type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The time when the availability catalog was created. format: date-time type: string timeUpdated: description: The time when the availability catalog was last updated. format: date-time type: string required: - id - namespace - compartmentId - displayName - occCustomerGroupId - catalogState - metadataDetails - timeCreated - timeUpdated - lifecycleState type: object x-example: "Example 1\n {\n id\": \"ocid1.availabilityCatalog.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n \"namespace\": \"COMPUTE\",\n \"displayName\": \"Catalog 1\",\n \"occCustomerGroupId\": \"ocid1.customerGroup.oc1.examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n \"catalogState\": \"PUBLISHED\",\n \"metadataDetails\": {\n \"formatVersion\": \"V1\"\n },\n \"lifecycleState\": \"ACTIVE\",\n \"lifecycleDetails\": null,\n \"definedTags\": null,\n \"freeformTags\": null,\n \"timeCreated\": \"2023-06-03T17:32:28Z\",\n \"timeUpdated\": \"2023-06-03T17:32:28Z\"\n }\n" parameters: FilterByCapacityHandoverDateQueryParam: description: The capacity handover date of the capacity constraint to filter the list of capacity constraints. in: query name: dateExpectedCapacityHandover required: false x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 PaginationTokenQueryParam: description: A token representing the position at which to start retrieving results. This must come from `opc-next-page` header field of a previous response. in: query name: page schema: type: string minLength: 1 FilterByOccCapacityRequestIdQueryParam: description: A filter to return the list of capacity requests based on the OCID of the capacity request. This is done for the users who have INSPECT permission on the resource but do not have READ permission. in: query name: id required: false x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 OccAvailabilityCatalogSortByQueryParam: description: 'The field to sort by. Only one sort order may be provided. The default order for displayName is ascending. The default order for timeCreated is descending. ' in: query name: sortBy required: false schema: type: string enum: - displayName - timeCreated default: timeCreated FilterByOccAvailabilityCatalogIdQueryParam: description: The OCID of the availability catalog to filter the list of availability catalogs. in: query name: id required: false x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 FilterByCompartmentIdOptionalQueryParam: description: The OCID of the compartment or tenancy in which resources are to be listed. in: query name: compartmentId required: false x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 OccHandoverResourceBlockDetailsSortByQueryParam: description: "The field to sort by. Only one sort order may be provided. \nThe default order for handoverDate is chronological order(latest date item at the end).\n" in: query name: sortBy required: false schema: type: string enum: - handoverDate default: handoverDate FilterByNamespacePathParam: description: The namespace by which we would filter the list. in: path name: namespace required: true x-obmcs-top-level-enum: '#/definitions/Namespace' schema: type: string enum: - COMPUTE maxLength: 255 minLength: 1 OccHandoverResourceBlockSortByQueryParam: description: "The field to sort by. Only one sort order may be provided. \nThe default order for handoverDate is chronological order(latest date item at the end).\n" in: query name: sortBy required: false schema: type: string enum: - handoverDate default: handoverDate FilterByEndHandoverDateQueryParam: description: 'This filter helps in fetching all handed over resources for which the recordDate is less than or equal to the endDate. ' in: query name: handoverDateLessThanOrEqualTo required: false x-default-description: The default value for this filter will the today's date schema: type: string format: date-time OccCapacityRequestIdPathParam: description: The OCID of the capacity request. in: path name: occCapacityRequestId required: true schema: type: string maxLength: 255 minLength: 1 FilterByNamespaceQueryParam: description: The namespace by which we would filter the list. in: query name: namespace required: false x-default-description: 'null' x-obmcs-top-level-enum: '#/definitions/Namespace' schema: type: string enum: - COMPUTE 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 FilterByCompartmentIdQueryParam: description: The ocid of the compartment or tenancy in which resources are to be listed. This will also be used for authorization purposes. in: query name: compartmentId required: true x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 WorkloadTypeQueryParam: description: Workload type using the resources in an availability catalog can be filtered. in: query name: workloadType x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 OccAvailabilityCatalogIdPathParam: description: The OCID of the availability catalog. in: path name: occAvailabilityCatalogId required: true schema: type: string maxLength: 255 minLength: 1 FilterByDisplayNameQueryParam: description: A filter to return only the resources that match the entire display name. The match is not case sensitive. in: query name: displayName required: false schema: type: string PaginationLimitQueryParam: description: The maximum number of items to return. in: query name: limit schema: type: integer default: 10 maximum: 100 minimum: 1 SortOrderQueryParam: description: The sort order to use, either 'ASC' or 'DESC'. in: query name: sortOrder x-default-description: 'The default value depends upon `sortBy`, and in general is ''DESC'' when sorting by time and ''ASC'' otherwise. ' x-obmcs-top-level-enum: '#/definitions/SortOrder' schema: type: string enum: - ASC - DESC ResourceNameQueryParam: description: The name of the resource to filter the list of capacity constraints. in: query name: resourceName required: false x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 OccOverviewSortByQueryParam: description: 'The field to sort by. Only one sort order may be provided. The default order for periodValue is chronological order(latest month item at the end). ' in: query name: sortBy required: false schema: type: string enum: - periodValue default: periodValue FilterByToQueryParam: description: The month corresponding to this date would be considered as the ending point of the time period against which we would like to perform an aggregation. in: query name: to required: false x-default-description: The default value for this will be the previous month schema: type: string format: date-time FilterByCatalogStateQueryParam: description: Filter the list of availability catalogs based on the catalog state. in: query name: catalogState required: true x-default-description: PUBLISHED schema: type: string enum: - PUBLISHED maxLength: 255 minLength: 1 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 FilterByOccHandoverResourceBlockIdRequiredQueryParam: description: 'The OCID of the OccHandoverResource which is a required query parameter for listing OccHandoverResourceDetails. ' in: query name: occHandoverResourceBlockId required: true x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 OccCapacityRequestSortByQueryParam: description: 'The field to sort by. Only one sort order may be provided. The default order for display name is ascending. The default order for time created is reverse chronological order(latest date at the top). ' in: query name: sortBy required: false schema: type: string enum: - displayName - timeCreated default: timeCreated FilterByRequestTypeQueryParam: description: A filter to return only the resources that match the request type. The match is not case sensitive. in: query name: requestType required: false x-default-description: 'null' x-obmcs-enumref: '#/definitions/OccCapacityRequest/requestType' schema: type: string FilterByStartHandoverDateQueryParam: description: 'This filter helps in fetching all handed over resources for which the recordDate is greater than or equal to the startDate. ' in: query name: handoverDateGreaterThanOrEqualTo required: false x-default-description: The default value for this filter will the today's date schema: type: string format: date-time AvailabilitiesSortByQueryParam: description: 'The field to sort by. Only one sort order may be provided. The default order for resource name is ascending. The default order for date of capacity handover is descending. ' in: query name: sortBy required: false schema: type: string enum: - dateExpectedCapacityHandover - resourceName default: dateExpectedCapacityHandover maxLength: 255 minLength: 1 FilterByOccHandoverResourceBlockIdQueryParam: description: 'This filter helps in fetching the handed over resource for which the occHandoverResourceId is equal to the one provided here. ' in: query name: occHandoverResourceBlockId required: false x-default-description: The ocid of the occ handover resource block which we want to filter to schema: type: string maxLength: 255 minLength: 1 FilterByFromQueryParam: description: The month corresponding to this date would be considered as the starting point of the time period against which we would like to perform an aggregation. in: query name: from required: false x-default-description: The default value for this will be the previous month schema: type: string format: date-time FilterByHostIdQueryParam: description: 'This fiter is applicable only for COMPUTE namespace. It helps in fetching of all resource block details for which the hostId is equal to the one provided in this query param. ' in: query name: hostId required: false x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 RequestIdHeader: description: 'The client request ID for tracing. The only valid characters for request IDs are letters, numbers, underscore, and dash. ' in: header name: opc-request-id schema: type: string FilterByHandoverResourceNameQueryParam: description: 'A filter to return only the list of resources that match the name provided in this filter. ' in: query name: handoverResourceName required: false x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 FilterByAvailabilityCatalogIdQueryParam: description: A filter to return the list of capacity requests based on the OCID of the availability catalog against which they were created. in: query name: occAvailabilityCatalogId required: false x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 ResourceTypeQueryParam: description: Resource type using which the capacity constraints of an availability catalog can be filtered. in: query name: resourceType required: false x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 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-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 work. You can use this to query its status. ' 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: compartmentId: description: Since all resources are at tenancy level hence this will be the ocid of the tenancy where operation is to be performed. 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. ' 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 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 occAvailabilityCatalogId: description: 'The ocid of the availability catalog. ' type: string serviceTenancyId: '''${service_tenancy}''' systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object x-properties: null x-tag-groups: capacityManagementServiceList: - oci-control-center-cp capacityManagementTag: - capacityManagement demandSignalTag: - demandSignal internalDemandSignalTag: - internalDemandSignal x-obmcs-client-retries-enabled: true x-obmcs-endpoint-service-name: control-center-cp x-oracle-package: com.oracle.oci.occ.cp