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 Demand Signal 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: demandSignal paths: /occmDemandSignalCatalogResources: get: description: 'This API will list all the resources across all demand signal catalogs for a given namespace and customer group containing the caller compartment. ' operationId: ListOccmDemandSignalCatalogResources parameters: - $ref: '#/components/parameters/FilterByCompartmentIdQueryParam' - $ref: '#/components/parameters/FilterByDemandSignalCatalogResourceNameQueryParam' - $ref: '#/components/parameters/FilterByDemandSignalCatalogResourceNamespaceQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/OccmDemandSignalCatalogResourceSortByQueryParam' responses: 200: description: 'A list of resources matching the criteria specified by LIST API call. ' 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/OccmDemandSignalCatalogResourceCollection' 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 demand signal catalog resources. tags: - demandSignal x-example: "Example 1\n Request:\n GET /occmDemandSignalCatalogResources?compartmentId=ocid1.compartment.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\n Response:\n {\n \"items\": [\n {\n \"id\": \"ocid1.occmdemandsignalresource.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n \"compartmentId\": \"ocid1.compartment.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n \"occmDemandSignalCatalogId\": \"ocid1.occmdemandsignalcatalog.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n \"namespace\": \"COMPUTE\",\n \"name\": \"VM.Standard3.Flex\",\n \"targetCompartmentId\": \"ocid1.compartment.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n \"region\": \"us-ashburn-1\",\n \"availabilityDomain\": \"us-ashburn-ad-1\",\n timeCreated: \"2025-01-15T17:32:28Z\",\n timeUpdated: \"2025-01-20T17:32:28Z\",\n \"resourceProperties\": {\n \"items\": [\n {\n \"propertyName\": \"OCPU\",\n \"propertyValue\": \"1\",\n \"propertyMinValue\": 1,\n \"propertyMaxValue\": 32,\n \"propertyOptions\": null,\n \"propertyUnit\": null,\n \"isEditable\": true\n },\n {\n \"propertyName\": \"Memory\",\n \"propertyValue\": \"1\",\n \"propertyMinValue\": 1,\n \"propertyMaxValue\": 512,\n \"propertyOptions\": null,\n \"propertyUnit\": \"GB\",\n \"isEditable\": true\n }\n ]\n\n \"resourcePropertyConstraints\": {\n \"items\": [\n {\n \"constraintName\": \"minMemoryPerOCPU\",\n \"constraintValue\": \"2\"\n },\n {\n \"constraintName\": \"maxMemoryPerOCPU\",\n \"constraintValue\": \"3\"\n }\n ]\n }\n },\n {\n \"id\": \"ocid1.occmdemandsignalresource.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n \"compartmentId\": \"ocid1.compartment.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n \"occmDemandSignalCatalogId\": \"ocid1.occmdemandsignalcatalog.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n \"namespace\": \"COMPUTE\",\n \"name\": \"BM.Standard3.64\",\n \"targetCompartmentId\": \"ocid1.compartment.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n \"region\": \"us-ashburn-1\",\n \"availabilityDomain\": \"us-ashburn-ad-1\",\n timeCreated: \"2025-01-15T17:32:28Z\",\n timeUpdated: \"2025-01-20T17:32:28Z\",\n \"resourceProperties\": {\n \"items\": [\n {\n \"propertyName\": \"OCPU\",\n \"propertyValue\": \"64\",\n \"propertyMinValue\": null,\n \"propertyMaxValue\": null,\n \"propertyOptions\": null,\n \"propertyUnit\": null,\n \"isEditable\": false\n },\n {\n \"propertyName\": \"Memory\",\n \"propertyValue\": \"1024\",\n \"propertyMinValue\": null,\n \"propertyMaxValue\": null,\n \"propertyOptions\": null,\n \"propertyUnit\": \"GB\",\n \"isEditable\": false\n }\n ]\n },\n \"resourcePropertyConstraints\": {\n \"items\": []\n },\n\n }\n ]\n }\n" x-related-resource: '#/definitions/OccmDemandSignalCatalogResource' /occmDemandSignalDeliveries: get: description: 'This GET call is used to list all demand signals delivery resources within the compartment passed as a query param. ' operationId: ListOccmDemandSignalDeliveries parameters: - $ref: '#/components/parameters/FilterByCompartmentIdQueryParam' - $ref: '#/components/parameters/FilterByOccmDemandSignalIdQueryParam' - $ref: '#/components/parameters/FilterByOccmDemandSignalItemIdQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/OccmDemandSignalDeliverySortByQueryParam' responses: 200: description: 'A list of demand signal delivery resources matching the criteria specified by LIST API call. ' 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/OccmDemandSignalDeliveryCollection' 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 demand signal delivery resources. tags: - demandSignal x-example: "Example 1\n Request:\n GET /20231107/occmDemandSignalDeliveries?compartmentId=ocid1.compartment.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4&occmDemandSignalId=ocid1.occmdemandsignal.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4&occmDemandSignalItemId=ocid1.occmdemandsignalitem.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4&lifecycleDetails=ACCEPTED&limit=50&page=eyJwYWdlIjoyfQ==&sortOrder=ASC&sortBy=resourceName\n Response:\n {\n \"items\": [\n {\n \"id\": \"ocid1.occmdemandsignaldelivery.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n \"compartmentId\": \"ocid1.tenancy.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n \"demandSignalId\": \"ocid1.occmdemandsignal.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n \"demandSignalItemId\": \"ocid1.occmdemandsignalitem.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n \"lifecycleState\": \"ACTIVE\",\n \"lifecycleDetails\": \"ACCEPTED\",\n \"justification\": \"This resource is available to be delivered\",\n \"acceptedQuantity\": 20,\n \"timeDelivered\": null,\n \"freeformTags\": {},\n \"definedTags\": {}\n },\n {\n \"id\": \"ocid1.occmdemandsignaldelivery.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca5\",\n \"compartmentId\": \"ocid1.tenancy.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n \"demandSignalId\": \"ocid1.occmdemandsignal.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n \"demandSignalItemId\": \"ocid1.occmdemandsignalitem.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n \"lifecycleState\": \"ACTIVE\",\n \"lifecycleDetails\": \"DECLINED\",\n \"justification\": \"The resource is no longer available\",\n \"acceptedQuantity\": 20,\n \"timeDelivered\": null,\n \"freeformTags\": {},\n \"definedTags\": {}\n }\n ]\n }\n" x-obmcs-cli-action: list /occmDemandSignalItems: get: description: 'This API will list the detailed information about the resources demanded as part of the demand signal. ' operationId: ListOccmDemandSignalItems parameters: - $ref: '#/components/parameters/FilterByCompartmentIdQueryParam' - $ref: '#/components/parameters/FilterItemsByOccmDemandSignalIdQueryParam' - $ref: '#/components/parameters/FilterByDemandSignalResourceNameQueryParam' - $ref: '#/components/parameters/FilterByOccmDemandSignalNamespaceQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/OccmDemandSignalItemsSortByQueryParam' responses: 200: description: 'A list containing detailed information about resources demanded in a given demand signal matching the criteria specified by this LIST API call. ' 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/OccmDemandSignalItemCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get detailed information about resource demanded as part of the demand signal. tags: - demandSignal x-example: "Example 1\n Request: \n GET /20231107/occmDemandSignalItems?compartmentId=ocid1.compartment.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4&occmDemandSignalId=ocid1.occmdemandsignal.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4&resourceName=BM.Standard3.64&demandSignalNamespace=COMPUTE&limit=50&page=eyJwYWdlIjoyfQ==&sortOrder=ASC&sortBy=resourceName\n Response:\n {\n \"items\": [\n {\n \"id\": \"ocid1.occmdemandsignalitem.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n \"demandSignalId\": \"ocid1.occmdemandsignal.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n \"compartmentId\": \"ocid1.tenancy.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n \"demandSignalCatalogResourceId\": \"ocid1.occmdemandsignalcatalogresource.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n \"demandSignalNamespace\": \"COMPUTE\",\n \"requestType\": \"DEMAND\",\n \"resourceName\": \"BM.Standard3.64\",\n \"region\": \"us-ashburn-1\",\n \"availabilityDomain\": \"us-ashburn-ad-1\",\n \"targetCompartmentId\": \"ocid1.tenancy.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n \"quantity\": 20,\n \"timeNeededBefore\": \"2025-03-07T00:00:00Z\",\n \"resourceProperties\": {\n \"OCPU\": \"16\",\n \"Memory\": \"1024\"\n }\n },\n {\n \"id\": \"ocid1.occmdemandsignalitem.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsycc6\",\n \"demandSignalId\": \"ocid1.occmdemandsignal.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsycc6\",\n \"compartmentId\": \"ocid1.tenancy.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n \"demandSignalCatalogResourceId\": \"ocid1.occmdemandsignalcatalogresource.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n \"demandSignalNamespace\": \"NETWORK\",\n \"requestType\": \"DEMAND\",\n \"resourceName\": \"Fast Connect\",\n \"region\": \"us-phoenix-1\",\n \"availabilityDomain\": \"us-phoenix-ad-1\",\n \"targetCompartmentId\": \"ocid1.tenancy.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n \"quantity\": 10,\n \"timeNeededBefore\": \"2025-02-07T00:00:00Z\",\n \"resourceProperties\": {\n \"type\": \"type1\"\n }\n }\n ]\n }\n" x-related-resource: '#/definitions/OccmDemandSignalItem' post: description: 'This API will create a demand signal item representing a resource request. This needs to be grouped under a demand signal. ' operationId: CreateOccmDemandSignalItem parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: 'The request to create a demand signal item is successful. ' 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/OccmDemandSignalItem' 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 a demand signal item. tags: - demandSignal x-example: "Example 1\nRequest:\nPOST /20231107/occmDemandSignalItems\n{\n \"compartmentId\": \"ocid1.tenancy.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n \"demandSignalId\": \"ocid1.occmdemandsignal.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n \"demandSignalCatalogResourceId\": \"ocid1.occmdemandsignalcatalogresource.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n \"requestType\": \"DEMAND\",\n \"region\": \"us-ashburn-1\",\n \"availabilityDomain\": \"us-ashburn-ad-1\",\n \"targetCompartmentId\": \"ocid1.tenancy.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n \"demandQuantity\": 20,\n \"timeNeededBefore\": \"2025-03-07T00:00:00Z\",\n \"resourceProperties\": {\n \"OCPU\": \"16\",\n \"Memory\": \"1024\"\n },\n \"notes\": \"Customer notes for OCI team\",\n}\nResponse:\n{\n \"id\": \"ocid1.occmdemandsignalitem.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n \"compartmentId\": \"ocid1.tenancy.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n \"demandSignalId\": \"ocid1.occmdemandsignal.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n \"demandSignalCatalogResourceId\": \"ocid1.occmdemandsignalcatalogresource.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n \"demandSignalNamespace\": \"COMPUTE\",\n \"requestType\": \"DEMAND\",\n \"resourceName\": \"BM.Standard3.64\",\n \"region\": \"us-ashburn-1\",\n \"availabilityDomain\": \"us-ashburn-ad-1\",\n \"targetCompartmentId\": \"ocid1.tenancy.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n \"demandQuantity\": 20,\n \"timeNeededBefore\": \"2025-03-07T00:00:00Z\",\n \"resourceProperties\": {\n \"OCPU\": \"16\",\n \"Memory\": \"1024\"\n },\n \"lifecycleState\": \"ACTIVE\",\n \"freeformTags\": {},\n \"definedTags\": {}\n}\n" x-related-resource: '#/definitions/OccmDemandSignalItem' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateOccmDemandSignalItemDetails' description: 'The request details for creating occm demand signal item. ' required: true /occmDemandSignalItems/actions/bulkCreateDemandSignalItems: post: description: 'This API will help in bulk creation of demand signal items. This API is atomic i.e either all the demand signal item resources will be created or none will be created. ' operationId: BulkCreateOccmDemandSignalItem parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: 'The bulk creation request is 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 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 post call to bulk create demand signal items. tags: - demandSignal x-example: "Example 1 \nRequest:\nPOST /20231107/occmDemandSignalItems/actions/bulkCreateDemandSignalItems\n{\n \"demandSignalId\": \"ocid1.occmdemandsignal.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n \"createOccmDemandSignalItems\": [\n {\n \"demandSignalCatalogResourceId\": \"ocid1.occmdemandsignalcatalogresource.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n \"requestType\": \"DEMAND\",\n \"region\": \"us-ashburn-1\",\n \"availabilityDomain\": \"us-ashburn-ad-1\",\n \"targetCompartmentId\": \"ocid1.tenancy.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n \"demandQuantity\": 300,\n \"timeNeededBefore\": \"2025-03-07T00:00:00Z\",\n \"resourceProperties\": {\n \"OCPU\": \"16\",\n \"Memory\": \"1024\"\n },\n \"notes\": \"Customer notes for OCI team\",\n },\n {\n \"demandSignalCatalogResourceId\": \"ocid1.occmdemandsignalcatalogresource.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n \"requestType\": \"DEMAND\",\n \"region\": \"us-ashburn-1\",\n \"availabilityDomain\": \"us-ashburn-ad-1\",\n \"targetCompartmentId\": \"ocid1.tenancy.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n \"demandQuantity\": 300,\n \"timeNeededBefore\": \"2025-03-07T00:00:00Z\",\n \"resourceProperties\": {\n \"OCPU\": \"16\",\n \"Memory\": \"1024\"\n }\n }\n ]\n}\n" x-related-resource: '#/definitions/OccmDemandSignalItem' requestBody: content: application/json: schema: $ref: '#/components/schemas/BulkCreateOccmDemandSignalItemDetails' description: 'The request details for bulk creating the demand signal items. ' required: true /occmDemandSignalItems/{occmDemandSignalItemId}: delete: description: 'This is a DELETE API which deletes a demand signal item with the provided demand signal item ocid. ' operationId: DeleteOccmDemandSignalItem parameters: - $ref: '#/components/parameters/OccmDemandSignalItemIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: The request to delete the demand signal item 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 demand signal item resource. tags: - demandSignal x-example: 'Example 1 Request: DELETE /20231107/occmDemandSignalItems/ocid1.occmdemandsignalitem.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4 ' x-related-resource: '#/definitions/OccmDemandSignalItem' get: description: 'This is a GET API to get the details of a demand signal item resource representing the details of the resource demanded by you. ' operationId: GetOccmDemandSignalItem parameters: - $ref: '#/components/parameters/OccmDemandSignalItemIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: 'The details about a specific demand signal item were successfully retrieved. ' 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/OccmDemandSignalItem' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get details about a particular demand signal item tags: - demandSignal x-example: "Example 1:\nRequest: \nGET /20231107/occmDemandSignalItems/ocid1.occmdemandsignalitem.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\nResponse:\n{\n \"id\": \"ocid1.occmdemandsignalitem.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n \"demandSignalId\": \"ocid1.occmdemandsignal.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n \"compartmentId\": \"ocid1.tenancy.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n \"demandSignalCatalogResourceId\": \"ocid1.occmdemandsignalcatalogresource.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n \"demandSignalNamespace\": \"COMPUTE\",\n \"requestType\": \"DEMAND\",\n \"resourceName\": \"BM.Standard3.64\",\n \"region\": \"us-ashburn-1\",\n \"availabilityDomain\": \"us-ashburn-ad-1\",\n \"targetCompartmentId\": \"ocid1.tenancy.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n \"demandQuantity\": 20,\n \"timeNeededBefore\": \"2025-03-07T00:00:00Z\",\n \"resourceProperties\": {\n \"OCPU\": \"16\",\n \"Memory\": \"1024\"\n }\n}\n" put: description: 'This is a PUT API which can be used to update the demand signal item resource. ' operationId: UpdateOccmDemandSignalItem parameters: - $ref: '#/components/parameters/OccmDemandSignalItemIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: 'The request to update the demand signal item has been successfully updated. ' 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/OccmDemandSignalItem' 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 occm demand signal item. tags: - demandSignal x-example: "Example 1 \nRequest:\n PUT /20231107/occmDemandSignalItems/ocid1.occmdemandsignalitem.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\n {\n \"region\": \"us-ashburn-1\",\n \"availabilityDomain\": \"us-ashburn-ad-1\",\n \"targetCompartmentId\": \"ocid1.tenancy.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n \"demandQuantity\": 100,\n \"timeNeededBefore\": \"2025-03-07T00:00:00Z\",\n \"resourceProperties\": {\n \"OCPU\": \"32\",\n \"Memory\": \"2048\"\n },\n \"notes\": \"Updated notes\",\n }\nResponse:\n{\n \"id\": \"ocid1.occmdemandsignalitem.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n \"demandSignalId\": \"ocid1.occmdemandsignal.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n \"compartmentId\": \"ocid1.tenancy.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n \"demandSignalCatalogResourceId\": \"ocid1.occmdemandsignalcatalogresource.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n \"demandSignalNamespace\": \"COMPUTE\",\n \"requestType\": \"DEMAND\",\n \"resourceName\": \"BM.Standard3.64\",\n \"region\": \"us-ashburn-1\",\n \"availabilityDomain\": \"us-ashburn-ad-1\",\n \"targetCompartmentId\": \"ocid1.tenancy.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n \"demandQuantity\": 100,\n \"timeNeededBefore\": \"2025-03-07T00:00:00Z\",\n \"resourceProperties\": {\n \"OCPU\": \"16\",\n \"Memory\": \"1024\"\n }\n}\n" x-related-resource: '#/definitions/OccmDemandSignalItem' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateOccmDemandSignalItemDetails' description: 'The details about the request to update the specified demand signal item. ' required: true /occmDemandSignals: get: description: 'This GET call is used to list all demand signals within the compartment passed as a query parameter. ' operationId: ListOccmDemandSignals parameters: - $ref: '#/components/parameters/FilterByCompartmentIdQueryParam' - $ref: '#/components/parameters/FilterByOccmDemandSignalIdQueryParam' - $ref: '#/components/parameters/FilterByOccmDemandSignalState' - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/OccmDemandSignalSortByQueryParam' responses: 200: description: 'A list of demand signals matching the criteria specified by LIST API call. ' 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/OccmDemandSignalCollection' 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 demand signals. tags: - demandSignal x-example: "Example 1 \n Request:\n GET /20231107/occmDemandSignals?compartmentId=ocid1.compartment.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4&id=ocid1.occmdemandsignal.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4&lifecycleDetails=SUBMITTED&displayName=Demand%20Signal%201&limit=50&page=eyJwYWdlIjoyfQ==&sortOrder=ASC&sortBy=timeCreated\n Response: \n {\n \"items\":\n [\n {\n id: \"ocid1.occmdemandsignal.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n compartmentId: \"ocid1.compartment.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n displayName: \"Demand Signal 1\",\n description: \"This is a sample demand signal\",\n timeCreated: \"2025-01-15T17:32:28Z\",\n timeUpdated: \"2025-01-20T17:32:28Z\",\n lifecycleState: \"ACTIVE\",\n lifecycleDetails: \"SUBMITTED\",\n freeformTags: {},\n definedTags: {}\n },\n {\n id: \"ocid1.occmdemandsignal.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsycb6\",\n compartmentId: \"ocid1.compartment.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n displayName: \"Demand Signal 2\",\n description: \"This is a another sample demand signal\",\n timeCreated: \"2025-01-15T17:32:28Z\",\n timeUpdated: \"2025-01-20T17:32:28Z\",\n lifecycleState: \"ACTIVE\",\n lifecycleDetails: \"CREATED\",\n freeformTags: {},\n definedTags: {}\n }\n ]\n}\n" x-related-resource: '#/definitions/OccmDemandSignal' post: description: 'This is a post API to create occm demand signal. ' operationId: CreateOccmDemandSignal parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: 'The request to create a demand signal is successful. ' 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/OccmDemandSignal' 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 occm demand signal. tags: - demandSignal x-example: "Example 1 \n Request:\n POST /20231107/occmDemandSignals\n {\n compartmentId: \"ocid1.compartment.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n displayName: \"Demand Signal 1\",\n description: \"This is a sample demand signal\"\n }\n Response: \n {\n id: \"ocid1.occmdemandsignal.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n compartmentId: \"ocid1.compartment.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n displayName: \"Demand Signal 1\",\n description: \"This is a sample demand signal\",\n timeCreated: \"2025-01-15T17:32:28Z\",\n timeUpdated: \"2025-01-20T17:32:28Z\",\n lifecycleState: \"ACTIVE\",\n lifecycleDetails: \"CREATED\",\n freeformTags: {},\n definedTags: {}\n }\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateOccmDemandSignalDetails' description: 'The request details for creating occm demand signal. ' required: true /occmDemandSignals/{occmDemandSignalId}: delete: description: 'This is a DELETE API which deletes a demand signal with the provided demand signal ocid. ' operationId: DeleteOccmDemandSignal parameters: - $ref: '#/components/parameters/OccmDemandSignalIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: The request to delete the demand signal 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 demand signal resource. tags: - demandSignal x-example: 'Example 1 Request: DELETE /20231107/occmDemandSignals/ocid1.occmdemandsignal.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4 ' x-related-resource: '#/definitions/OccmDemandSignal' get: description: 'This is a GET API which gets the detailed information about a specific demand signal. ' operationId: GetOccmDemandSignal parameters: - $ref: '#/components/parameters/OccmDemandSignalIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: 'The details about a specific demand signal were successfully retrieved. ' 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/OccmDemandSignal' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get details about a particular demand signal. tags: - demandSignal x-example: "Example 1 \n Request: \n GET /20231107/occmDemandSignals/ocid1.occmdemandsignal.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\n Response:\n {\n id: \"ocid1.occmdemandsignal.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n compartmentId: \"ocid1.compartment.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n displayName: \"Demand Signal 1\",\n description: \"This is a sample demand signal\",\n timeCreated: \"2025-01-15T17:32:28Z\",\n timeUpdated: \"2025-01-20T17:32:28Z\",\n lifecycleState: \"ACTIVE\",\n lifecycleDetails: \"SUBMITTED\",\n freeformTags: {},\n definedTags: {}\n }\n" put: description: 'This is a PUT API which shall be used to update the metadata of the demand signal. ' operationId: UpdateOccmDemandSignal parameters: - $ref: '#/components/parameters/OccmDemandSignalIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: 'The request to update the demand signal 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/OccmDemandSignal' 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 demand signal resource. tags: - demandSignal x-example: "Example 1 \n Request:\n PUT /20231107/occmDemandSignals/ocid1.occmdemandsignal.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\n {\n displayName: \"Demand Signal 1 - Updated\",\n description: \"Updated description\",\n lifecycleDetails: \"SUBMITTED\",\n }\n Response:\n {\n id: \"ocid1.occmdemandsignal.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n compartmentId: \"ocid1.compartment.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n displayName: \"Demand Signal 1\",\n description: \"This is a sample demand signal\",\n timeCreated: \"2025-01-15T17:32:28Z\",\n timeUpdated: \"2025-01-20T17:32:28Z\",\n lifecycleState: \"ACTIVE\",\n lifecycleDetails: \"SUBMITTED\",\n freeformTags: {},\n definedTags: {}\n }\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateOccmDemandSignalDetails' description: 'The request details for this PUT API to update the metadata for a given demand signal resource. ' required: true components: schemas: OccmDemandSignal: description: 'An occm demand signal is a resource that communicates the forecasting needs of a customer to OCI in advance. ' properties: compartmentId: description: 'The OCID of the tenancy from which the request to create the demand signal was made. ' maxLength: 256 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 demand signal. ' maxLength: 400 type: string displayName: description: 'The display name of the demand signal. ' maxLength: 256 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 demand signal. ' maxLength: 256 type: string lifecycleDetails: description: "The different states associated with a demand signal. \n\nCREATED -> A demand signal is by default created in this state. \nSUBMITTED -> Once you have reviewed the details of the demand signal, you can transition it to SUBMITTED state so that OCI can start working on it.\nDELETED -> You can delete a demand signal as long as it is in either CREATED or SUBMITTED state.\nIN_PROGRESS -> Once OCI starts working on a given demand signal. They transition it to IN_PROGRESS.\nCANCELLED -> OCI can transition the demand signal to this state.\nCOMPLETED -> OCI will transition the demand signal to COMPLETED state once the quantities which OCI committed to deliver to you has been delivered.\n" enum: - CREATED - SUBMITTED - DELETED - IN_PROGRESS - REJECTED - COMPLETED type: string lifecycleState: description: 'The current lifecycle state of the resource. ' enum: - CREATING - ACTIVE - UPDATING - DELETED - DELETING - FAILED 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 demand signal was created. ' format: date-time type: string timeUpdated: description: 'The time when the demand signal was last updated. ' format: date-time type: string required: - id - compartmentId - displayName - lifecycleState - lifecycleDetails - timeCreated - timeUpdated type: object x-example: "Example 1 \n{\n id: \"ocid1.occmdemandsignal.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n compartmentId: \"ocid1.compartment.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n displayName: \"Demand Signal 1\",\n description: \"This is a sample demand signal\",\n timeCreated: \"2025-01-15T17:32:28Z\",\n timeUpdated: \"2025-01-20T17:32:28Z\",\n lifecycleState: \"ACTIVE\",\n lifecycleDetails: \"CREATED\",\n freeformTags: {},\n definedTags: {}\n}\n" OccmDemandSignalResourcePropertiesSummary: description: 'A summary model for the Occm demand signal resource properties. ' properties: isEditable: description: 'This will indicate if demand signal resource''s property is editable. ' type: boolean propertyMaxValue: description: 'The maximum value of demand signal resource''s property. This is an optional parameter. ' format: int64 type: integer propertyMinValue: description: 'The minimum value of demand signal resource''s property. This is an optional parameter. ' format: int64 type: integer propertyName: description: 'The name of demand signal resource''s property. ' maxLength: 256 type: string propertyOptions: description: 'Predefined options for demand signal resource''s property. This is an optional parameter. ' items: $ref: '#/components/schemas/OccmDemandSignalResourcePropertyOptionSummary' maxItems: 100 type: array propertyUnit: description: 'Unit for demand signal resource''s property. ' type: string propertyValue: description: 'Default value of demand signal resource''s property. ' maxLength: 256 type: string required: - propertyName - isEditable - propertyValue type: object x-example: "Example 1\n {\n \"propertyName\": \"OCPU\",\n \"propertyValue\": \"1\",\n \"propertyMinValue\": 1,\n \"propertyMaxValue\": 32,\n \"propertyOptions\": null,\n \"propertyUnit\": null,\n \"isEditable\": true\n }\n" CreateOccmDemandSignalItemDetails: description: 'Details about different fields required to create a demand signal item resource. ' properties: availabilityDomain: description: 'The name of the availability domain for which you want to request the OCI resource. This is an optional parameter. ' maxLength: 256 type: string x-obmcs-cli-param: ad compartmentId: description: 'The OCID of the tenancy from which the demand signal item was created. ' maxLength: 256 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 demandQuantity: description: 'The quantity of the resource that you want to demand from OCI. ' format: int64 type: integer demandSignalCatalogResourceId: description: 'The OCID of the correponding demand signal catalog resource. ' maxLength: 256 type: string x-obmcs-cli-param: ds-catalog-resource-id demandSignalId: description: 'The OCID of the demand signal under which we need to create this item. ' maxLength: 256 type: string x-obmcs-cli-param: ds-id 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 notes: description: 'This field will serve as notes section for you. You can use this section to convey a message to OCI regarding your resource request. NOTE: The previous value gets overwritten with the new one for this once updated. ' maxLength: 2048 minLength: 1 type: string region: description: 'The name of region for which you want to request the OCI resource. ' maxLength: 256 type: string requestType: description: 'The type of request (DEMAND or RETURN) that you want to make for this demand signal item. ' enum: - DEMAND type: string x-obmcs-top-level-enum: '#/definitions/OccmDemandSignalItemRequestType' resourceProperties: additionalProperties: type: string description: 'A map of various properties associated with the OCI resource. ' maxProperties: 100 type: object targetCompartmentId: description: 'The OCID of the tenancy for which you want to request the OCI resource for. This is an optional parameter. ' maxLength: 256 type: string timeNeededBefore: description: 'the date before which you would ideally like the OCI resource to be delivered to you. ' format: date-time type: string required: - compartmentId - demandSignalId - demandSignalCatalogResourceId - requestType - region - demandQuantity - timeNeededBefore - resourceProperties type: object x-example: "Example 1\n{\n \"compartmentId\": \"ocid1.compartment.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n \"demandSignalId\": \"ocid1.occmdemandsignal.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n \"demandSignalCatalogResourceId\": \"ocid1.occmdemandsignalcatalogresource.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n \"requestType\": \"DEMAND\",\n \"region\": \"us-ashburn-1\",\n \"availabilityDomain\": \"us-ashburn-ad-1\",\n \"targetCompartmentId\": \"ocid1.compartment.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n \"demandQuantity\": 20,\n \"timeNeededBefore\": \"2025-03-07T00:00:00Z\",\n \"resourceProperties\": {\n \"OCPU\": \"16\", \n \"Memory\": \"1024\"\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 CreateOccmDemandSignalDetails: description: 'Details about the different fields required for creating OCC Demand Signal. ' properties: compartmentId: description: 'The OCID of the tenancy where we would like to create a demand signal. ' maxLength: 256 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: 'A short description of the demand signal. ' maxLength: 400 type: string displayName: description: 'The user-friendly name of the demand signal. Does not have to be unique. Avoid entering anything confidential. ' maxLength: 256 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 required: - compartmentId - displayName type: object x-example: "Example 1 \n{\n compartmentId: \"ocid1.compartment.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n displayName: \"Demand Signal 1\",\n description: \"This is a sample demand signal\"\n}\n" OccmDemandSignalDeliverySummary: description: 'A summary model containing information about the demand signal delivery resources. ' properties: acceptedQuantity: description: 'The quantity of the resource that OCI will supply to the customer. ' format: int64 type: integer compartmentId: description: 'The OCID of the tenancy from which the demand signal delivery resource is created. ' maxLength: 256 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 demandSignalId: description: 'The OCID of the demand signal under which this delivery will be grouped. ' maxLength: 256 type: string demandSignalItemId: description: 'The OCID of the demand signal item corresponding to which this delivery is made. ' maxLength: 256 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 this demand signal delivery resource. ' maxLength: 256 type: string justification: description: 'This field could be used by OCI to communicate the reason for accepting or declining the request. ' maxLength: 2048 type: string lifecycleDetails: description: 'The enum values corresponding to the various states associated with the delivery resource. ACCEPTED -> OCI has accepted your resource request and will deliver the quantity as specified by acceptance quantity of this resource. DECLINED -> OCI has declined you resource request. DELIVERED -> OCI has delivered the accepted quantity to the customers. Note: Under extreme rare scenarios the delivery state can toggle between ACCEPTED and DECLINED states ' enum: - ACCEPTED - DECLINED - DELIVERED type: string lifecycleState: description: 'The current lifecycle state of the resource. ' enum: - CREATING - ACTIVE - UPDATING - DELETED - DELETING - FAILED 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 timeDelivered: description: 'The date on which the OCI delivered the resource to the customers. ' format: date-time type: string required: - id - compartmentId - demandSignalId - demandSignalItemId - acceptedQuantity - lifecycleState - lifecycleDetails type: object x-example: "Example 1\n{\n \"id\": \"ocid1.occmdemandsignaldelivery.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n \"compartmentId\": \"ocid1.tenancy.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n \"demandSignalId\": \"ocid1.occmdemandsignal.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n \"demandSignalItemId\": \"ocid1.occmdemandsignalitem.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n \"lifecycleState\": \"ACTIVE\",\n \"lifecycleDetails\": \"ACCEPTED\",\n \"justification\": \"This resource is available to be delivered\",\n \"acceptedQuantity\": 20,\n \"timeDelivered\": null,\n \"freeformTags\": {},\n \"definedTags\": {}\n}\n" OccmDemandSignalItem: description: 'An occm demand signal item is a resource that is used to communicate the forecasting need for a particular resource with OCI. It''s a sub-resource and need to be grouped inside a demand signal. ' properties: availabilityDomain: description: 'The name of the availability domain for which you want to request the OCI resource. ' maxLength: 256 type: string compartmentId: description: 'The OCID of the tenancy from which the demand signal item was created. ' maxLength: 256 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 demandQuantity: description: 'The quantity of the resource that you want to demand from OCI. ' format: int64 type: integer demandSignalCatalogResourceId: description: 'The OCID of the corresponding demand signal catalog resource. ' maxLength: 256 type: string demandSignalId: description: 'The OCID of the demand signal under which this item will be grouped. ' maxLength: 256 type: string demandSignalNamespace: description: 'The name of the OCI service in consideration for demand signal submission. For example: COMPUTE, NETWORK, GPU etc. ' enum: - COMPUTE - NETWORK - GPU - STORAGE type: string x-obmcs-top-level-enum: '#/definitions/DemandSignalNamespace' 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 demand signal item. ' maxLength: 256 type: string lifecycleState: description: The current lifecycle state of the resource. enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED type: string notes: description: 'This field will serve as notes section for you. You can use this section to convey a message to OCI regarding your resource request. NOTE: The previous value gets overwritten with the new one for this once updated. ' maxLength: 2048 minLength: 1 type: string region: description: 'The name of region for which you want to request the OCI resource. ' maxLength: 256 type: string requestType: description: 'The type of request (DEMAND or RETURN) made against a particular demand signal item. ' enum: - DEMAND type: string x-obmcs-top-level-enum: '#/definitions/OccmDemandSignalItemRequestType' resourceName: description: 'The name of the OCI resource that you want to request. ' maxLength: 256 type: string resourceProperties: additionalProperties: type: string description: 'A map of various properties associated with the OCI resource. ' maxProperties: 100 type: object 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 targetCompartmentId: description: 'The OCID of the tenancy for which you want to request the OCI resource for. This is an optional parameter. ' maxLength: 256 type: string timeNeededBefore: description: 'the date before which you would ideally like the OCI resource to be delivered to you. ' format: date-time type: string required: - id - compartmentId - demandSignalId - demandSignalNamespace - demandSignalCatalogResourceId - requestType - resourceName - region - lifecycleState - demandQuantity - timeNeededBefore - resourceProperties type: object x-example: "Example 1 \n{\n \"id\": \"ocid1.occmdemandsignalitem.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n \"demandSignalId\": \"ocid1.occmdemandsignal.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n \"compartmentId\": \"ocid1.tenancy.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n \"demandSignalCatalogResourceId\": \"ocid1.occmdemandsignalcatalogresource.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n \"demandSignalNamespace\": \"COMPUTE\",\n \"requestType\": \"DEMAND\",\n \"resourceName\": \"BM.Standard3.64\",\n \"region\": \"us-ashburn-1\",\n \"availabilityDomain\": \"us-ashburn-ad-1\",\n \"targetCompartmentId\": \"ocid1.tenancy.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n \"demandQuantity\": 20,\n \"timeNeededBefore\": \"2025-03-07T00:00:00Z\",\n \"resourceProperties\": {\n \"OCPU\": \"16\", \n \"Memory\": \"1024\"\n },\n \"notes\": \"Customer notes for OCI team\",\n \"lifecycleState\": \"ACTIVE\",\n \"freeformTags\": {},\n \"definedTags\": {}\n}\n" BulkCreateOccmDemandSignalItemDetails: description: 'Details about the model that is to be used for bulk creating demand signal items. ' properties: createOccmDemandSignalItems: description: 'A list of demand signal items that we want to bulk create. ' items: $ref: '#/components/schemas/BulkCreateOccmDemandSignalItem' maxItems: 5000 type: array x-obmcs-cli-param: create-items demandSignalId: description: 'The OCID of the demand signal in which we want to bulk create these demand signal item resources. ' maxLength: 256 type: string x-obmcs-cli-param: ds-id required: - demandSignalId - createOccmDemandSignalItems type: object UpdateOccmDemandSignalItemDetails: description: 'Details about different fields used to update the demand signal item. ' properties: availabilityDomain: description: 'The name of the availability domain for which you want to request the OCI resource. ' maxLength: 256 type: string x-obmcs-cli-param: ad 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 demandQuantity: description: 'The quantity of the resource that you want to demand from OCI. ' format: int64 type: integer 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 notes: description: 'This field will serve as notes section for you. You can use this section to convey a message to OCI regarding your resource request. NOTE: The previous value gets overwritten with the new one for this once updated. ' maxLength: 2048 minLength: 1 type: string region: description: 'The region for which you want to request the resource for. ' maxLength: 256 type: string resourceProperties: additionalProperties: type: string description: 'A map of various properties associated with the OCI resource. This parameter will act as a replace parameter i.e the existing resource properties will be overridden by this update. ' maxProperties: 100 type: object targetCompartmentId: description: 'The OCID of the tenancy for which you want to request the OCI resource for. ' maxLength: 256 type: string timeNeededBefore: description: 'the date before which you would ideally like the OCI resource to be delivered to you. ' format: date-time type: string type: object x-example: "Example 1\n{\n \"region\": \"us-ashburn-1\",\n \"availabilityDomain\": \"us-ashburn-ad-1\",\n \"targetCompartmentId\": \"ocid1.compartment.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n \"demandQuantity\": 20,\n \"timeNeededBefore\": \"2025-03-07T00:00:00Z\",\n \"resourceProperties\": {\n \"OCPU\": \"16\", \n \"Memory\": \"1024\"\n }\n}\n" OccmDemandSignalResourcePropertyConstraintsCollection: description: A list containing detailed information about a resource's property constraints. properties: items: description: 'An array of items containing detailed information about a resource''s property dependencies. ' items: $ref: '#/components/schemas/OccmDemandSignalResourcePropertyConstraintsSummary' type: array required: - items type: object x-example: "{\n \"items\": [\n {\n \"constraintName\": \"minMemoryPerOCPU\",\n \"constraintValue\": \"2\"\n },\n {\n \"constraintName\": \"maxMemoryPerOCPU\",\n \"constraintValue\": \"3\"\n }\n ]\n}\n" OccmDemandSignalCatalogResourceCollection: description: A list containing detailed information about different resources. properties: items: description: 'An array of items containing detailed information about different resources. ' items: $ref: '#/components/schemas/OccmDemandSignalCatalogResourceSummary' type: array required: - items type: object x-example: "Example 1\n{\n \"items\": [\n {\n \"id\": \"ocid1.occmdemandsignalresource.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n \"compartmentId\": \"ocid1.compartment.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n \"namespace\": \"COMPUTE\",\n \"name\": \"VM.Standard3.Flex\",\n \"targetCompartmentId\": \"ocid1.compartment.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n \"region\": \"us-ashburn-1\",\n \"availabilityDomain\": \"us-ashburn-ad-1\",\n \"timeCreated\": \"2025-01-15T17:32:28Z\",\n \"timeUpdated\": \"2025-01-20T17:32:28Z\",\n \"resourceProperties\": {\n \"items\": [\n {\n \"propertyName\": \"OCPU\",\n \"propertyValue\": \"1\",\n \"propertyMinValue\": 1,\n \"propertyMaxValue\": 32,\n \"propertyOptions\": null,\n \"propertyUnit\": null,\n \"isEditable\": true\n },\n {\n \"propertyName\": \"Memory\",\n \"propertyValue\": \"1\",\n \"propertyMinValue\": 1,\n \"propertyMaxValue\": 512,\n \"propertyOptions\": null,\n \"propertyUnit\": \"GB\",\n \"isEditable\": true\n }\n ]\n },\n \"resourcePropertyConstraints\": {\n \"items\": [\n {\n \"constraintName\": \"minMemoryPerOCPU\",\n \"constraintValue\": \"2\"\n },\n {\n \"constraintName\": \"maxMemoryPerOCPU\",\n \"constraintValue\": \"3\"\n }\n ]\n }\n },\n {\n \"id\": \"ocid1.occmdemandsignalresource.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca5\",\n \"compartmentId\": \"ocid1.compartment.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n \"namespace\": \"COMPUTE\",\n \"name\": \"BM.Standard3.64\",\n \"targetCompartmentId\": \"ocid1.compartment.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n \"region\": \"us-ashburn-1\",\n \"availabilityDomain\": \"us-ashburn-ad-1\",\n \"timeCreated\": \"2025-01-15T17:32:28Z\",\n \"timeUpdated\": \"2025-01-20T17:32:28Z\",\n \"resourceProperties\": {\n \"items\": [\n {\n \"propertyName\": \"OCPU\",\n \"propertyValue\": \"64\",\n \"propertyMinValue\": null,\n \"propertyMaxValue\": null,\n \"propertyOptions\": null,\n \"propertyUnit\": null,\n \"isEditable\": false\n },\n {\n \"propertyName\": \"Memory\",\n \"propertyValue\": \"1024\",\n \"propertyMinValue\": null,\n \"propertyMaxValue\": null,\n \"propertyOptions\": null,\n \"propertyUnit\": \"GB\",\n \"isEditable\": false\n }\n ]\n },\n \"resourcePropertyConstraints\": {\n \"items\": []\n },\n \"lifecycleState\": \"ACTIVE\",\n \"freeformTags\": null,\n \"definedTags\": null,\n \"systemTags\": null\n }\n ]\n}\n" OccmDemandSignalCollection: description: 'A list of demand signals. ' properties: items: description: 'An array of demand signals. ' items: $ref: '#/components/schemas/OccmDemandSignalSummary' type: array required: - items type: object x-example: "Example 1 \n{\n \"items\":\n [\n {\n id: \"ocid1.occmdemandsignal.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n compartmentId: \"ocid1.compartment.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n displayName: \"Demand Signal 1\",\n description: \"This is a sample demand signal\",\n timeCreated: \"2025-01-15T17:32:28Z\",\n timeUpdated: \"2025-01-20T17:32:28Z\",\n lifecycleState: \"ACTIVE\",\n lifecycleDetails: \"SUBMITTED\",\n freeformTags: {},\n definedTags: {}\n },\n {\n id: \"ocid1.occmdemandsignal.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsycb6\",\n compartmentId: \"ocid1.compartment.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n displayName: \"Demand Signal 2\",\n description: \"This is a another sample demand signal\",\n timeCreated: \"2025-01-15T17:32:28Z\",\n timeUpdated: \"2025-01-20T17:32:28Z\",\n lifecycleState: \"ACTIVE\",\n lifecycleDetails: \"CREATED\",\n freeformTags: {},\n definedTags: {}\n }\n ]\n}\n" OccmDemandSignalSummary: description: 'A summary model for the occm demand signal. ' properties: compartmentId: description: 'The OCID of the tenancy from which the request to create the demand signal was made. ' maxLength: 256 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: 'A short description about the demand signal. ' maxLength: 400 type: string displayName: description: 'The display name of the demand signal. ' maxLength: 256 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 demand signal. ' maxLength: 256 type: string lifecycleDetails: description: "The different states associated with a demand signal. \n\nCREATED -> A demand signal is by default created in this state. \nSUBMITTED -> Once you have reviewed the details of the demand signal, you can transition it to SUBMITTED state so that OCI can start working on it.\nDELETED -> You can delete a demand signal as long as it is in either CREATED or SUBMITTED state.\nIN_PROGRESS -> Once OCI starts working on a given demand signal. They transition it to IN_PROGRESS.\nREJECTED -> OCI can transition the demand signal to this state if all the demand signal items of that demand signal are declined.\nCOMPLETED -> OCI will transition the demand signal to COMPLETED state once the quantities which OCI committed to deliver to you has been delivered.\n" type: string x-obmcs-enumref: '#/definitions/OccmDemandSignal/lifecycleDetails' lifecycleState: description: 'The current lifecycle state of the demand signal. ' type: string x-obmcs-enumref: '#/definitions/OccmDemandSignal/lifecycleState' 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 demand signal was created. ' format: date-time type: string timeUpdated: description: 'The time when the demand signal was last updated. ' format: date-time type: string required: - id - compartmentId - displayName - lifecycleDetails - lifecycleState - timeCreated - timeUpdated type: object x-example: "Example 1 \n{\n id: \"ocid1.occmdemandsignal.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n compartmentId: \"ocid1.compartment.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n displayName: \"Demand Signal 1\",\n description: \"This is a sample demand signal\",\n timeCreated: \"2025-01-15T17:32:28Z\",\n timeUpdated: \"2025-01-20T17:32:28Z\",\n lifecycleState: \"ACTIVE\",\n lifecycleDetails: \"CREATED\",\n freeformTags: {},\n definedTags: {}\n}\n" BulkCreateOccmDemandSignalItem: description: 'The occm demand signal item which will be used for the bulk creation api. ' properties: availabilityDomain: description: 'The name of the availability domain for which you want to request the OCI resource. This is an optional parameter. ' maxLength: 256 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 demandQuantity: description: 'The quantity of the resource that you want to demand from OCI. ' format: int64 type: integer demandSignalCatalogResourceId: description: 'The OCID of the correponding demand signal catalog resource. ' maxLength: 256 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 notes: description: 'This field will serve as notes section for you. You can use this section to convey a message to OCI regarding your resource request. NOTE: The previous value gets overwritten with the new one for this once updated. ' maxLength: 2048 minLength: 1 type: string region: description: 'The name of region for which you want to request the OCI resource. ' maxLength: 256 type: string requestType: description: 'The type of request (DEMAND or RETURN) that you want to make for this demand signal item. ' enum: - DEMAND type: string x-obmcs-top-level-enum: '#/definitions/OccmDemandSignalItemRequestType' resourceProperties: additionalProperties: type: string description: 'A map of various properties associated with the OCI resource. ' maxProperties: 100 type: object targetCompartmentId: description: 'The OCID of the tenancy for which you want to request the OCI resource for. This is an optional parameter. ' maxLength: 256 type: string timeNeededBefore: description: 'the date before which you would ideally like the OCI resource to be delivered to you. ' format: date-time type: string required: - demandSignalCatalogResourceId - requestType - region - targetCompartmentId - demandQuantity - timeNeededBefore - resourceProperties OccmDemandSignalItemCollection: description: A list containing detailed information about different resources demanded as part of a given demand signal. properties: items: description: 'An array of items containing detailed information about different resource demanded as part of a demand signal. ' items: $ref: '#/components/schemas/OccmDemandSignalItemSummary' type: array required: - items type: object x-example: "Example 1\n{\n \"items\": [\n {\n \"id\": \"ocid1.occmdemandsignalitem.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n \"demandSignalId\": \"ocid1.occmdemandsignal.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n \"compartmentId\": \"ocid1.tenancy.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n \"demandSignalCatalogResourceId\": \"ocid1.occmdemandsignalcatalogresource.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n \"demandSignalNamespace\": \"COMPUTE\",\n \"requestType\": \"DEMAND\",\n \"resourceName\": \"BM.Standard3.64\",\n \"region\": \"us-ashburn-1\",\n \"availabilityDomain\": \"us-ashburn-ad-1\",\n \"targetCompartmentId\": \"ocid1.tenancy.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n \"quantity\": 20,\n \"timeNeededBefore\": \"2025-03-07T00:00:00Z\",\n \"resourceProperties\": {\n \"OCPU\": \"16\", \n \"Memory\": \"1024\"\n },\n \"notes\": \"Customer notes for OCI team\",\n \"lifecycleState\": \"ACTIVE\",\n \"freeformTags\": {},\n \"definedTags\": {}\n },\n { \n \"id\": \"ocid1.occmdemandsignalitem.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca6\",\n \"demandSignalId\": \"ocid1.occmdemandsignal.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n \"compartmentId\": \"ocid1.tenancy.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n \"demandSignalCatalogResourceId\": \"ocid1.occmdemandsignalcatalogresource.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n \"demandSignalNamespace\": \"NETWORK\",\n \"resourceName\": \"Fast Connect\",\n \"requestType\": \"DEMAND\",\n \"region\": \"us-phoenix-1\",\n \"availabilityDomain\": \"us-phoenix-ad-1\",\n \"targetCompartmentId\": \"ocid1.tenancy.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n \"quantity\": 10,\n \"timeNeededBefore\": \"2025-02-07T00:00:00Z\",\n \"resourceProperties\": {\n \"type\": \"type1\"\n },\n \"notes\": \"Customer notes for OCI team\",\n \"lifecycleState\": \"ACTIVE\",\n \"freeformTags\": {},\n \"definedTags\": {}\n }\n ]\n}\n" UpdateOccmDemandSignalDetails: description: 'Details about different fields that can be used to update the demand signal. ' 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 description: description: 'Use this field to update the description of the demand signal. ' maxLength: 400 type: string displayName: description: 'Use this field to update the display name of the demand signal ' maxLength: 256 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: 'The subset of demand signal states available for updating the demand signal. ' enum: - SUBMITTED type: string x-example: "Example 1\n{\n lifecycleDetails: \"SUBMITTED\"\n}\n" OccmDemandSignalResourcePropertyConstraintsSummary: description: 'A summary model for the Occm demand signal resource property constraints. ' properties: constraintName: description: 'The name of demand signal resource''s property constraint. ' maxLength: 256 type: string constraintValue: description: 'The value of demand signal resource''s property constraint. ' maxLength: 256 type: string required: - constraintName - constraintValue type: object x-example: "{\n \"constraintName\": \"minMemoryPerOCPU\",\n \"constraintValue\": \"2\"\n}\n" OccmDemandSignalItemSummary: description: 'A summary model containing information about various demand signal resource requests. ' properties: availabilityDomain: description: 'The name of the availability domain for which you want to request the OCI resource. ' maxLength: 256 type: string compartmentId: description: 'The OCID of the tenancy from which the demand signal item was created. ' maxLength: 256 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 demandSignalCatalogResourceId: description: 'The OCID of the corresponding demand signal catalog resource. ' maxLength: 256 type: string demandSignalId: description: 'The OCID of the demand signal under which this item will be grouped. ' maxLength: 256 type: string demandSignalNamespace: description: 'The name of the OCI service in consideration for demand signal submission. For example: COMPUTE, NETWORK, GPU etc. ' enum: - COMPUTE - NETWORK - GPU - STORAGE type: string x-obmcs-top-level-enum: '#/definitions/DemandSignalNamespace' 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 demand signal resource request. ' maxLength: 256 type: string lifecycleState: description: 'The current lifecycle state of the demand signal item. ' type: string x-obmcs-enumref: '#/definitions/OccmDemandSignalItem/lifecycleState' notes: description: 'This field will serve as notes section for you. You can use this section to convey a message to OCI regarding your resource request. NOTE: The previous value gets overwritten with the new one for this once updated. ' maxLength: 2048 minLength: 1 type: string quantity: description: 'The quantity of the resource that you want to demand from OCI or return to OCI. ' format: int64 type: integer region: description: 'The name of region for which you want to request the OCI resource. ' maxLength: 256 type: string requestType: description: 'The type of request (DEMAND or RETURN) made against a particular demand signal item. ' enum: - DEMAND type: string x-obmcs-top-level-enum: '#/definitions/OccmDemandSignalItemRequestType' resourceName: description: 'The name of the OCI resource that you want to request. ' maxLength: 256 type: string resourceProperties: additionalProperties: type: string description: 'A map of various properties associated with the OCI resource. ' maxProperties: 100 type: object 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 targetCompartmentId: description: 'The ocid of the tenancy for which you want to request the OCI resource for. This is an optional parameter. ' maxLength: 256 type: string timeNeededBefore: description: 'the date before which you would ideally like the OCI resource to be delivered to you. ' format: date-time type: string required: - id - compartmentId - demandSignalId - demandSignalNamespace - demandSignalCatalogResourceId - requestType - resourceName - region - lifecycleState - quantity - timeNeededBefore - resourceProperties type: object x-example: "Example 1 \n{\n \"id\": \"ocid1.occmdemandsignalitem.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n \"demandSignalId\": \"ocid1.occmdemandsignal.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n \"compartmentId\": \"ocid1.tenancy.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n \"demandSignalCatalogResourceId\": \"ocid1.occmdemandsignalcatalogresource.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n \"demandSignalNamespace\": \"COMPUTE\",\n \"requestType\": \"DEMAND\",\n \"resourceName\": \"BM.Standard3.64\",\n \"region\": \"us-ashburn-1\",\n \"availabilityDomain\": \"us-ashburn-ad-1\",\n \"targetCompartmentId\": \"ocid1.tenancy.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n \"quantity\": 20,\n \"timeNeededBefore\": \"2025-03-07T00:00:00Z\",\n \"resourceProperties\": {\n \"OCPU\": \"16\", \n \"Memory\": \"1024\"\n },\n \"notes\": \"Customer notes for OCI team\",\n \"lifecycleState\": \"ACTIVE\",\n \"freeformTags\": {},\n \"definedTags\": {}\n}\n" OccmDemandSignalCatalogResourceSummary: description: 'A summary model containing information about the details of a demand signal catalog resource. ' properties: availabilityDomain: description: 'The name of the availability domain for which you want to request the OCI resource. This is an optional parameter. ' maxLength: 256 type: string compartmentId: description: 'The OCID of the tenancy from which the request to create the demand signal was made. ' maxLength: 256 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 id: description: 'The OCID of the demand signal catalog resource. ' maxLength: 256 type: string lifecycleState: description: 'The current lifecycles state of the demand signal catalog resource. ' type: string x-obmcs-enumref: '#/definitions/OccmDemandSignalCatalogResource/lifecycleState' name: description: 'The name of the OCI resource that you want to request. ' maxLength: 256 type: string namespace: description: 'The name of the OCI service in consideration for demand signal submission. For example: COMPUTE, NETWORK, GPU etc. ' enum: - COMPUTE - NETWORK - GPU - STORAGE type: string x-obmcs-top-level-enum: '#/definitions/DemandSignalNamespace' region: description: 'The name of region for which you want to request the OCI resource. This is an optional parameter. ' maxLength: 256 type: string resourceProperties: $ref: '#/components/schemas/OccmDemandSignalResourcePropertiesCollection' resourcePropertyConstraints: $ref: '#/components/schemas/OccmDemandSignalResourcePropertyConstraintsCollection' 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 targetCompartmentId: description: 'The OCID of the customer tenancy for which this resource will be available for the customer to order against. ' maxLength: 256 type: string timeCreated: description: 'The time when the demand signal catalog resource was created. ' format: date-time type: string timeUpdated: description: 'The time when the demand signal catalog resource was last updated. ' format: date-time type: string required: - id - compartmentId - namespace - name - lifecycleState - timeCreated - timeUpdated type: object x-example: "Example 1\n {\n \"id\": \"ocid1.occmdemandsignalresource.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n \"compartmentId\": \"ocid1.compartment.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n \"namespace\": \"COMPUTE\",\n \"name\": \"VM.Standard3.Flex\",\n \"targetCompartmentId\": \"ocid1.compartment.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n \"region\": \"us-ashburn-1\",\n \"availabilityDomain\": \"us-ashburn-ad-1\",\n \"timeCreated\": \"2025-01-15T17:32:28Z\",\n \"timeUpdated\": \"2025-01-20T17:32:28Z\",\n \"resourceProperties\": {\n \"items\": [\n {\n \"propertyName\": \"OCPU\",\n \"propertyValue\": \"1\",\n \"propertyMinValue\": \"1\",\n \"propertyMaxValue\": \"32\",\n \"propertyOptions\": null,\n \"propertyUnit\": null,\n \"isEditable\": true\n },\n {\n \"propertyName\": \"Memory\",\n \"propertyValue\": \"1\",\n \"propertyMinValue\": 1,\n \"propertyMaxValue\": 512,\n \"propertyOptions\": null,\n \"propertyUnit\": \"GB\",\n \"isEditable\": true\n }\n ]\n },\n \"resourcePropertyConstraints\": {\n \"items\": [\n {\n \"constraintName\": \"minMemoryPerOCPU\",\n \"constraintValue\": \"2\"\n },\n {\n \"constraintName\": \"maxMemoryPerOCPU\",\n \"constraintValue\": \"3\"\n }\n ]\n }\n }\n" OccmDemandSignalDeliveryCollection: description: 'A list containing detailed delivery information about different resource demanded as part of the demand signal. ' properties: items: description: 'An array of items containing detailed information about demand signal delivery resources. ' items: $ref: '#/components/schemas/OccmDemandSignalDeliverySummary' type: array required: - items type: object x-example: "Example 1\n{\n \"items\": [\n {\n \"id\": \"ocid1.occmdemandsignaldelivery.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n \"compartmentId\": \"ocid1.tenancy.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n \"demandSignalId\": \"ocid1.occmdemandsignal.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n \"demandSignalItemId\": \"ocid1.occmdemandsignalitem.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n \"lifecycleState\": \"ACTIVE\",\n \"lifecycleDetails\": \"ACCEPTED\",\n \"justification\": \"This resource is available to be delivered\",\n \"acceptedQuantity\": 20,\n \"timeDelivered\": null,\n \"freeformTags\": {},\n \"definedTags\": {}\n },\n {\n \"id\": \"ocid1.occmdemandsignaldelivery.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca5\",\n \"compartmentId\": \"ocid1.tenancy.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n \"demandSignalId\": \"ocid1.occmdemandsignal.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n \"demandSignalItemId\": \"ocid1.occmdemandsignalitem.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n \"lifecycleState\": \"ACTIVE\",\n \"lifecycleDetails\": \"DECLINED\",\n \"justification\": \"The resource is no longer available\",\n \"acceptedQuantity\": 20,\n \"timeDelivered\": null,\n \"freeformTags\": {},\n \"definedTags\": {}\n }\n ]\n}\n" OccmDemandSignalResourcePropertiesCollection: description: A list containing detailed information about a resource's properties. properties: items: description: 'An array of items containing detailed information about a resource''s properties. ' items: $ref: '#/components/schemas/OccmDemandSignalResourcePropertiesSummary' type: array required: - items type: object x-example: "{\n \"items\": [\n {\n \"propertyName\": \"OCPU\",\n \"propertyValue\": \"1\",\n \"propertyMinValue\": 1,\n \"propertyMaxValue\": 32,\n \"propertyOptions\": null,\n \"propertyUnit\": null,\n \"isEditable\": true\n },\n {\n \"propertyName\": \"Memory\",\n \"propertyValue\": \"1\",\n \"propertyMinValue\": 1,\n \"propertyMaxValue\": 512,\n \"propertyOptions\": null,\n \"propertyUnit\": \"GB\",\n \"isEditable\": true\n }\n ]\n}\n" OccmDemandSignalResourcePropertyOptionSummary: description: 'A summary model for the Occm demand signal resource property option. To support range of the options for a property ' properties: optionKey: description: 'key of a property option like memoryValue, ocpuValue. ' type: string optionValue: description: 'value of a property option like 64, 2 fastconnect etc. ' type: string required: - optionKey - optionValue type: object x-example: "{\n \"optionKey\": \"memory\",\n \"optionValue\": \"2\"\n}\n" parameters: OccmDemandSignalDeliverySortByQueryParam: description: 'The field to sort the response of List Demand Signal Delivery API. Only one sort order may be provided. The default order for resource name is case sensitive alphabetical order. ' in: query name: sortBy required: false schema: type: string enum: - resourceName default: resourceName 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 FilterByDemandSignalResourceNameQueryParam: description: 'A query parameter to filter the list of demand signal details based on the resource name. ' in: query name: resourceName required: false x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 IfMatchHeader: description: 'For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource''s current etag value. ' in: header name: if-match required: false schema: type: string 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 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 OccmDemandSignalItemsSortByQueryParam: description: 'The field to sort the response of List Demand Signal Details API. Only one sort order may be provided. The default order for resource name is case sensitive alphabetical order. ' in: query name: sortBy required: false schema: type: string enum: - resourceName default: resourceName FilterByOccmDemandSignalNamespaceQueryParam: description: 'A query parameter to filter the list of demand signal details based on the namespace. ' in: query name: demandSignalNamespace required: false x-default-description: 'null' x-obmcs-cli-param: namespace x-obmcs-top-level-enum: '#/definitions/DemandSignalNamespace' schema: type: string enum: - COMPUTE - NETWORK - GPU - STORAGE maxLength: 255 minLength: 1 PaginationLimitQueryParam: description: The maximum number of items to return. in: query name: limit schema: type: integer default: 10 maximum: 100 minimum: 1 OccmDemandSignalItemIdPathParam: description: 'The OCID of the demand signal item. ' in: path name: occmDemandSignalItemId required: true x-obmcs-cli-param: ds-item-id schema: type: string maxLength: 255 minLength: 1 OccmDemandSignalIdPathParam: description: 'The OCID of the demand signal. ' in: path name: occmDemandSignalId required: true x-obmcs-cli-param: ds-id schema: type: string maxLength: 255 minLength: 1 FilterItemsByOccmDemandSignalIdQueryParam: description: 'A query parameter to filter the list of demand signal items based on a demand signal id. ' in: query name: occmDemandSignalId required: false x-default-description: 'null' x-obmcs-cli-param: ds-id schema: type: string maxLength: 255 minLength: 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 OccmDemandSignalSortByQueryParam: description: 'The field to sort the response of List Demand Signal API. Only one sort order may be provided. The default order for timeCreated is reverse chronological order (latest date at the top). The default order for displayName is case sensitive alphabetical order. ' in: query name: sortBy required: false schema: type: string enum: - timeCreated - displayName default: timeCreated FilterByDemandSignalCatalogResourceNamespaceQueryParam: description: 'A query parameter to filter the list of demand signal catalog resources based on the namespace. ' in: query name: demandSignalNamespace required: false x-default-description: 'null' x-obmcs-cli-param: namespace x-obmcs-top-level-enum: '#/definitions/DemandSignalNamespace' schema: type: string enum: - COMPUTE - NETWORK - GPU - STORAGE maxLength: 255 minLength: 1 FilterByOccmDemandSignalItemIdQueryParam: description: 'A query parameter to filter the list of demand signal items based on it''s OCID. ' in: query name: occmDemandSignalItemId required: false x-default-description: 'null' x-obmcs-cli-param: ds-item-id schema: type: string maxLength: 255 minLength: 1 FilterByDemandSignalCatalogResourceNameQueryParam: description: 'A query parameter to filter the list of demand signal catalog resource based on the resource name. ' in: query name: name required: false x-default-description: 'null' schema: type: string 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 FilterByOccmDemandSignalIdQueryParam: description: 'A query parameter to filter the list of demand signals based on it''s OCID. ' in: query name: id required: false x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 OccmDemandSignalCatalogResourceSortByQueryParam: description: 'The field to sort the response of List Demand catalog resources API. Only one sort order may be provided. The default order for name is case sensitive alphabetical order. ' in: query name: sortBy required: false schema: type: string enum: - name default: name 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 FilterByOccmDemandSignalState: description: 'A query parameter to filter the list of demand signals based on its state. ' in: query name: lifecycleDetails required: false x-default-description: 'null' x-obmc-enum-ref: '#/definitions/OccmDemandSignal/lifecycleDetails' 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