{
  "opencollection": "1.0.0",
  "info": {
    "name": "OCI Control Center Capacity Management API",
    "version": "20231107"
  },
  "items": [
    {
      "info": {
        "name": "capacityManagement",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "A GET call to list overview of resources in a given time interval",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://127.0.0.1/20231107/namespace/:namespace/occOverview",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "namespace",
                "value": "",
                "type": "path",
                "description": "The namespace by which we would filter the list."
              },
              {
                "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": "from",
                "value": "",
                "type": "query",
                "description": "The month corresponding to this date would be considered as the starting point of the time period against which we would like to perform an aggregation."
              },
              {
                "name": "to",
                "value": "",
                "type": "query",
                "description": "The month corresponding to this date would be considered as the ending point of the time period against which we would like to perform an aggregation."
              },
              {
                "name": "workloadType",
                "value": "",
                "type": "query",
                "description": "Workload type using the resources in an availability catalog can be filtered."
              },
              {
                "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 by. Only one sort order may be provided. The default order for periodValue is chronological order(latest month item at the end).\n"
              }
            ]
          },
          "docs": "Lists an overview of all resources in that namespace in a given time interval.\n"
        },
        {
          "info": {
            "name": "List availability catalogs.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://127.0.0.1/20231107/occAvailabilityCatalogs",
            "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": "namespace",
                "value": "",
                "type": "query",
                "description": "The namespace by which we would filter the list."
              },
              {
                "name": "id",
                "value": "",
                "type": "query",
                "description": "The OCID of the availability catalog to filter the list of availability catalogs."
              },
              {
                "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": "catalogState",
                "value": "",
                "type": "query",
                "description": "Filter the list of availability catalogs based on the catalog state."
              },
              {
                "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 by. Only one sort order may be provided. The default order for displayName is ascending. The default order for timeCreated is descending.\n"
              }
            ]
          },
          "docs": "Lists all availability catalogs."
        },
        {
          "info": {
            "name": "Details about a particular availability catalog.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://127.0.0.1/20231107/occAvailabilityCatalogs/:occAvailabilityCatalogId",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "occAvailabilityCatalogId",
                "value": "",
                "type": "path",
                "description": "The OCID of the availability catalog."
              }
            ]
          },
          "docs": "Get details about availability catalog."
        },
        {
          "info": {
            "name": "Export availability catalog.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://127.0.0.1/20231107/occAvailabilityCatalogs/:occAvailabilityCatalogId/content",
            "headers": [
              {
                "name": "opc-retry-token",
                "value": ""
              },
              {
                "name": "opc-request-id",
                "value": ""
              },
              {
                "name": "if-match",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "occAvailabilityCatalogId",
                "value": "",
                "type": "path",
                "description": "The OCID of the availability catalog."
              }
            ]
          },
          "docs": "Returns the binary contents of the availability catalog. Can be saved as a csv file.\n"
        },
        {
          "info": {
            "name": "List availabilities of an availability catalog.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://127.0.0.1/20231107/occAvailabilityCatalogs/:occAvailabilityCatalogId/occAvailabilities",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "occAvailabilityCatalogId",
                "value": "",
                "type": "path",
                "description": "The OCID of the availability catalog."
              },
              {
                "name": "dateExpectedCapacityHandover",
                "value": "",
                "type": "query",
                "description": "The capacity handover date of the capacity constraint to filter the list of capacity constraints."
              },
              {
                "name": "resourceName",
                "value": "",
                "type": "query",
                "description": "The name of the resource to filter the list of capacity constraints."
              },
              {
                "name": "resourceType",
                "value": "",
                "type": "query",
                "description": "Resource type using which the capacity constraints of an availability catalog can be filtered."
              },
              {
                "name": "workloadType",
                "value": "",
                "type": "query",
                "description": "Workload type using the resources in an availability catalog can be filtered."
              },
              {
                "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 by.  Only one sort order may be provided. The default order for resource name is ascending. The default order for date of capacity handover is descending.\n"
              }
            ]
          },
          "docs": "Lists availabilities for a particular availability catalog."
        },
        {
          "info": {
            "name": "List capacity requests.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://127.0.0.1/20231107/occCapacityRequests",
            "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": "occAvailabilityCatalogId",
                "value": "",
                "type": "query",
                "description": "A filter to return the list of capacity requests based on the OCID of the availability catalog against which they were created."
              },
              {
                "name": "namespace",
                "value": "",
                "type": "query",
                "description": "The namespace by which we would filter the list."
              },
              {
                "name": "requestType",
                "value": "",
                "type": "query",
                "description": "A filter to return only the resources that match the request type. The match is not case sensitive."
              },
              {
                "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": "id",
                "value": "",
                "type": "query",
                "description": "A filter to return the list of capacity requests based on the OCID of the capacity request. This is done for the users who have INSPECT permission on the resource but do not have READ permission."
              },
              {
                "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 by. Only one sort order may be provided. The default order for display name is ascending. The default order for time created is reverse chronological order(latest date at the top).\n"
              }
            ]
          },
          "docs": "Lists all capacity requests."
        },
        {
          "info": {
            "name": "A post call to create capacity request.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "http://127.0.0.1/20231107/occCapacityRequests",
            "headers": [
              {
                "name": "opc-retry-token",
                "value": ""
              },
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create Capacity Request."
        },
        {
          "info": {
            "name": "Details about a particular capacity request.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://127.0.0.1/20231107/occCapacityRequests/:occCapacityRequestId",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "occCapacityRequestId",
                "value": "",
                "type": "path",
                "description": "The OCID of the capacity request."
              }
            ]
          },
          "docs": "Get details about the capacity request."
        },
        {
          "info": {
            "name": "Updates the capacity request.",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "http://127.0.0.1/20231107/occCapacityRequests/:occCapacityRequestId",
            "headers": [
              {
                "name": "if-match",
                "value": ""
              },
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "occCapacityRequestId",
                "value": "",
                "type": "path",
                "description": "The OCID of the capacity request."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "The request to update the capacity request. The user can perform actions like closing a partially completed request so that it doesn't go ahead for full completion."
        },
        {
          "info": {
            "name": "A patch api to update the OccCapacityRequestBaseDetails of OccCapacityRequest resource.",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "http://127.0.0.1/20231107/occCapacityRequests/:occCapacityRequestId",
            "headers": [
              {
                "name": "if-match",
                "value": ""
              },
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "occCapacityRequestId",
                "value": "",
                "type": "path",
                "description": "The OCID of the capacity request."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates the OccCapacityRequest by evaluating a sequence of instructions."
        },
        {
          "info": {
            "name": "Deletes the capacity request resource. This operation can only be done by operators and customers can't delete the capacity request resource.",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "http://127.0.0.1/20231107/occCapacityRequests/:occCapacityRequestId",
            "headers": [
              {
                "name": "if-match",
                "value": ""
              },
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "occCapacityRequestId",
                "value": "",
                "type": "path",
                "description": "The OCID of the capacity request."
              }
            ]
          },
          "docs": "Deletes the capacity request resource."
        },
        {
          "info": {
            "name": "A GET call to list the details about the specified occHandoverResourceBlock.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://127.0.0.1/20231107/occHandoverResourceBlockDetails",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "occHandoverResourceBlockId",
                "value": "",
                "type": "query",
                "description": "The OCID of the OccHandoverResource which is a required query parameter for listing OccHandoverResourceDetails.\n"
              },
              {
                "name": "hostId",
                "value": "",
                "type": "query",
                "description": "This fiter is applicable only for COMPUTE namespace. It helps in fetching of all resource block details for which the hostId is equal to the one provided in this query param.\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 by. Only one sort order may be provided. \nThe default order for handoverDate is chronological order(latest date item at the end).\n"
              }
            ]
          },
          "docs": "List details about a given occHandoverResourceBlock.\n"
        },
        {
          "info": {
            "name": "A GET call to list occ handover resource blocks.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://127.0.0.1/20231107/occHandoverResourceBlocks",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "namespace",
                "value": "",
                "type": "query",
                "description": "The namespace by which we would filter the list."
              },
              {
                "name": "compartmentId",
                "value": "",
                "type": "query",
                "description": "The OCID of the compartment or tenancy in which resources are to be listed."
              },
              {
                "name": "handoverResourceName",
                "value": "",
                "type": "query",
                "description": "A filter to return only the list of resources that match the name provided in this filter.\n"
              },
              {
                "name": "handoverDateGreaterThanOrEqualTo",
                "value": "",
                "type": "query",
                "description": "This filter helps in fetching all handed over resources for which the recordDate is greater than or equal to the startDate.\n"
              },
              {
                "name": "handoverDateLessThanOrEqualTo",
                "value": "",
                "type": "query",
                "description": "This filter helps in fetching all handed over resources for which the recordDate is less than or equal to the endDate.\n"
              },
              {
                "name": "occHandoverResourceBlockId",
                "value": "",
                "type": "query",
                "description": "This filter helps in fetching the handed over resource for which the occHandoverResourceId is equal to the one provided here.\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 by. Only one sort order may be provided. \nThe default order for handoverDate is chronological order(latest date item at the end).\n"
              }
            ]
          },
          "docs": "List Occ Handover Resource blocks.\n"
        }
      ]
    }
  ],
  "bundled": true
}