{
  "opencollection": "1.0.0",
  "info": {
    "name": "OCI Control Center Capacity Management Demand Signal API",
    "version": "20231107"
  },
  "items": [
    {
      "info": {
        "name": "demandSignal",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List demand signal catalog resources.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://127.0.0.1/20231107/occmDemandSignalCatalogResources",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "compartmentId",
                "value": "",
                "type": "query",
                "description": "The ocid of the compartment or tenancy in which resources are to be listed. This will also be used for authorization purposes."
              },
              {
                "name": "name",
                "value": "",
                "type": "query",
                "description": "A query parameter to filter the list of demand signal catalog resource based on the resource name.\n"
              },
              {
                "name": "demandSignalNamespace",
                "value": "",
                "type": "query",
                "description": "A query parameter to filter the list of demand signal catalog resources based on the namespace.\n"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The maximum number of items to return."
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "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."
              },
              {
                "name": "sortOrder",
                "value": "",
                "type": "query",
                "description": "The sort order to use, either 'ASC' or 'DESC'."
              },
              {
                "name": "sortBy",
                "value": "",
                "type": "query",
                "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.\n"
              }
            ]
          },
          "docs": "This API will list all the  resources across all demand signal catalogs for a given namespace and customer group containing the caller compartment.\n"
        },
        {
          "info": {
            "name": "List demand signal delivery resources.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://127.0.0.1/20231107/occmDemandSignalDeliveries",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "compartmentId",
                "value": "",
                "type": "query",
                "description": "The ocid of the compartment or tenancy in which resources are to be listed. This will also be used for authorization purposes."
              },
              {
                "name": "id",
                "value": "",
                "type": "query",
                "description": "A query parameter to filter the list of demand signals based on it's OCID.\n"
              },
              {
                "name": "occmDemandSignalItemId",
                "value": "",
                "type": "query",
                "description": "A query parameter to filter the list of demand signal items based on it's OCID.\n"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The maximum number of items to return."
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "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."
              },
              {
                "name": "sortOrder",
                "value": "",
                "type": "query",
                "description": "The sort order to use, either 'ASC' or 'DESC'."
              },
              {
                "name": "sortBy",
                "value": "",
                "type": "query",
                "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.\n"
              }
            ]
          },
          "docs": "This GET call is used to list all demand signals delivery resources within the compartment passed as a query param.\n"
        },
        {
          "info": {
            "name": "Get detailed information about resource demanded as part of the demand signal.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://127.0.0.1/20231107/occmDemandSignalItems",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "compartmentId",
                "value": "",
                "type": "query",
                "description": "The ocid of the compartment or tenancy in which resources are to be listed. This will also be used for authorization purposes."
              },
              {
                "name": "occmDemandSignalId",
                "value": "",
                "type": "query",
                "description": "A query parameter to filter the list of demand signal items based on a demand signal id.\n"
              },
              {
                "name": "resourceName",
                "value": "",
                "type": "query",
                "description": "A query parameter to filter the list of demand signal details based on the resource name.\n"
              },
              {
                "name": "demandSignalNamespace",
                "value": "",
                "type": "query",
                "description": "A query parameter to filter the list of demand signal details based on the namespace.\n"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The maximum number of items to return."
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "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."
              },
              {
                "name": "sortOrder",
                "value": "",
                "type": "query",
                "description": "The sort order to use, either 'ASC' or 'DESC'."
              },
              {
                "name": "sortBy",
                "value": "",
                "type": "query",
                "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.\n"
              }
            ]
          },
          "docs": "This API will list the detailed information about the resources demanded as part of the demand signal.\n"
        },
        {
          "info": {
            "name": "A post call to create a demand signal item.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "http://127.0.0.1/20231107/occmDemandSignalItems",
            "headers": [
              {
                "name": "opc-retry-token",
                "value": ""
              },
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This API will create a demand signal item representing a resource request. This needs to be grouped under a demand signal.\n"
        },
        {
          "info": {
            "name": "A post call to bulk create demand signal items.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "http://127.0.0.1/20231107/occmDemandSignalItems/actions/bulkCreateDemandSignalItems",
            "headers": [
              {
                "name": "opc-retry-token",
                "value": ""
              },
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "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.\n"
        },
        {
          "info": {
            "name": "Get details about a particular demand signal item",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://127.0.0.1/20231107/occmDemandSignalItems/:occmDemandSignalItemId",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "occmDemandSignalItemId",
                "value": "",
                "type": "path",
                "description": "The OCID of the demand signal item.\n"
              }
            ]
          },
          "docs": "This is a GET API to get the details of a demand signal item resource representing the details of the resource demanded by you.\n"
        },
        {
          "info": {
            "name": "Updates the occm demand signal item.",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "http://127.0.0.1/20231107/occmDemandSignalItems/:occmDemandSignalItemId",
            "headers": [
              {
                "name": "if-match",
                "value": ""
              },
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "occmDemandSignalItemId",
                "value": "",
                "type": "path",
                "description": "The OCID of the demand signal item.\n"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This is a PUT API which can be used to update the demand signal item resource.\n"
        },
        {
          "info": {
            "name": "Deletes the demand signal item resource.",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "http://127.0.0.1/20231107/occmDemandSignalItems/:occmDemandSignalItemId",
            "headers": [
              {
                "name": "if-match",
                "value": ""
              },
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "occmDemandSignalItemId",
                "value": "",
                "type": "path",
                "description": "The OCID of the demand signal item.\n"
              }
            ]
          },
          "docs": "This is a DELETE API which deletes a demand signal item with the provided demand signal item ocid.\n"
        },
        {
          "info": {
            "name": "List demand signals.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://127.0.0.1/20231107/occmDemandSignals",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "compartmentId",
                "value": "",
                "type": "query",
                "description": "The ocid of the compartment or tenancy in which resources are to be listed. This will also be used for authorization purposes."
              },
              {
                "name": "id",
                "value": "",
                "type": "query",
                "description": "A query parameter to filter the list of demand signals based on it's OCID.\n"
              },
              {
                "name": "lifecycleDetails",
                "value": "",
                "type": "query",
                "description": "A query parameter to filter the list of demand signals based on its state.\n"
              },
              {
                "name": "displayName",
                "value": "",
                "type": "query",
                "description": "A filter to return only the resources that match the entire display name. The match is not case sensitive."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The maximum number of items to return."
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "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."
              },
              {
                "name": "sortOrder",
                "value": "",
                "type": "query",
                "description": "The sort order to use, either 'ASC' or 'DESC'."
              },
              {
                "name": "sortBy",
                "value": "",
                "type": "query",
                "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.\n"
              }
            ]
          },
          "docs": "This GET call is used to list all demand signals within the compartment passed as a query parameter.\n"
        },
        {
          "info": {
            "name": "A post call to create occm demand signal.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "http://127.0.0.1/20231107/occmDemandSignals",
            "headers": [
              {
                "name": "opc-retry-token",
                "value": ""
              },
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This is a post API to create occm demand signal.\n"
        },
        {
          "info": {
            "name": "Get details about a particular demand signal.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://127.0.0.1/20231107/occmDemandSignals/:occmDemandSignalId",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "occmDemandSignalId",
                "value": "",
                "type": "path",
                "description": "The OCID of the demand signal.\n"
              }
            ]
          },
          "docs": "This is a GET API which gets the detailed information about a specific demand signal.\n"
        },
        {
          "info": {
            "name": "Updates the demand signal resource.",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "http://127.0.0.1/20231107/occmDemandSignals/:occmDemandSignalId",
            "headers": [
              {
                "name": "if-match",
                "value": ""
              },
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "occmDemandSignalId",
                "value": "",
                "type": "path",
                "description": "The OCID of the demand signal.\n"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This is a PUT API which shall be used to update the metadata of the demand signal.\n"
        },
        {
          "info": {
            "name": "Deletes the demand signal resource.",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "http://127.0.0.1/20231107/occmDemandSignals/:occmDemandSignalId",
            "headers": [
              {
                "name": "if-match",
                "value": ""
              },
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "occmDemandSignalId",
                "value": "",
                "type": "path",
                "description": "The OCID of the demand signal.\n"
              }
            ]
          },
          "docs": "This is a DELETE API which deletes a demand signal with the provided demand signal ocid.\n"
        }
      ]
    }
  ],
  "bundled": true
}