OccOverviewCollection

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/oracle/json-schema/oracle-occ-overview-collection-schema.json",
  "title": "OccOverviewCollection",
  "description": "A list representing response of overview API.",
  "x-generated": "2026-11-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/oracle-capacitymanagement-api-openapi.yml#/components/schemas/OccOverviewCollection",
  "properties": {
    "items": {
      "description": "An array of overview summary.",
      "items": {
        "$ref": "#/$defs/OccOverviewSummary"
      },
      "type": "array"
    }
  },
  "required": [
    "items"
  ],
  "type": "object",
  "x-example": "Example 1\n{\n  \"items\": \n    [\n    {\n      compartmentId: \"ocid1.compartment.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n      periodValue: \"MARCH 2023\",\n      resourceName: \"BM.Standard.V3\",\n      totalAvailable: 100,\n      totalDemanded: 40,\n      totalSupplied: 10,\n      totalRejected: 30,\n      totalCancelled: 0,\n      totalUnfulfilled: 0,\n      workloadTypeBreakdownDetails:\"{\n                          \"totalAvailableWorkloadTypeBreakdown\": {\"Generic\": 100},\n                          \"totalDemandedWorkloadTypeBreakdown\": {\"Generic\": 40},\n                          \"totalSuppliedWorkloadTypeBreakdown\": {\"Generic\": 10},\n                          \"totalRejectedWorkloadTypeBreakdown\": {\"Generic\": 30},\n                          \"totalCancelledWorkloadTypeBreakdown\": {},\n                          \"totalUnfulfilledWorkloadTypeBreakdown\": {},\n                        }\"\n      capacityRequests: \"[\n                           { \\\"id\\\": \\\"ocid1.occcapacityRequest.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\\\",\n                             \\\"totalDemanded\\\": 10,\n                             \\\"totalSupplied\\\": 10,\n                             \\\"totalRejected\\\": 0,\n                             \\\"totalCancelled\\\": 0,\n                             \\\"totalUnfulfilled\\\": 0,\n                             \\\"workloadTypeTotalSuppliedBreakdown\\\": {\\\"Generic\\\":10}, \n                             \\\"workloadTypeTotalDemandedBreakdown\\\": {\\\"Generic\\\":10}, \n                             \\\"workloadTypeTotalRejectedBreakdown\\\": {}, \n                             \\\"workloadTypeTotalCancelledBreakdown\\\": {}, \n                             \\\"workloadTypeTotalUnfulfilledBreakdown\\\": {}, \n                           },\n                           { \\\"id\\\": \\\"ocid1.occcapacityRequest.oc1..exampleb4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\\\",\n                             \\\"totalDemanded\\\": 30,\n                             \\\"totalSupplied\\\": 0,\n                             \\\"totalRejected\\\": 30\n                             \\\"totalCancelled\\\": 0,\n                             \\\"totalUnfulfilled\\\": 0,\n                             \\\"workloadTypeTotalSuppliedBreakdown\\\": {}, \n                             \\\"workloadTypeTotalDemandedBreakdown\\\": {\\\"Generic\\\":30}, \n                             \\\"workloadTypeTotalRejectedBreakdown\\\": {\\\"Generic\\\":30}, \n                             \\\"workloadTypeTotalCancelledBreakdown\\\": {}, \n                             \\\"workloadTypeTotalUnfulfilledBreakdown\\\": {}\n                           }\n                         ]\",\n      unit: \"Servers\"\n    }\n    ]\n}\n",
  "$defs": {
    "OccOverviewSummary": {
      "description": "The overview summary is used to represent an array item that shall be used to represent the overview of the catalog resources along with their corresponding capacity requests.\n",
      "properties": {
        "capacityRequestsBlob": {
          "description": "A raw json blob containing all the capacity requests corresponding to the resource name",
          "type": "string"
        },
        "compartmentId": {
          "description": "The OCID of the compartment from which the api call is made. This will be used for authorizing the request.",
          "type": "string"
        },
        "periodValue": {
          "description": "The name of the month along with year for which this summary corresponds to.",
          "type": "string"
        },
        "resourceName": {
          "description": "The name of the resource for which we have aggregated the value.",
          "type": "string"
        },
        "totalAvailable": {
          "description": "The quantity of the resource which is available at the end of the period of aggregationDetails model in consideration.",
          "format": "int64",
          "type": "integer"
        },
        "totalCancelled": {
          "description": "The quantity of the resource which is cancelled by the customer. Once the capacity request was submitted, the customer can still cancel it. This field sums up those values.",
          "format": "int64",
          "type": "integer"
        },
        "totalDemanded": {
          "description": "The quantity of the resource which is demanded by customers via capacity requests against the resource name at the end of the time period in consideration for overview.",
          "format": "int64",
          "type": "integer"
        },
        "totalRejected": {
          "description": "The quantity of the resource which is rejected by Oracle.",
          "format": "int64",
          "type": "integer"
        },
        "totalSupplied": {
          "description": "The quantity of the resource which is supplied by Oracle to the customer against the resource name at the end of the time period in consideration.",
          "format": "int64",
          "type": "integer"
        },
        "totalUnfulfilled": {
          "description": "The quantity of the resource which Oracle was unable to supply. For a given capacity request, Oracle sometimes cannot supply the entire value demanded by the customer. In such cases a partial value is provided, thereby leaving behind a portion of unfulfilled values. This field sums that up.",
          "format": "int64",
          "type": "integer"
        },
        "unit": {
          "description": "The unit e.g SERVER in which the above values like totalAvailable, totalSupplied etc is measured.",
          "type": "string"
        },
        "workloadTypeBreakdownBlob": {
          "description": "A raw json blob containing breakdown of totalAvailable, totalDemanded, totalSupplied, totalRejected, totalCancelled and totalUnfulfilled by workload types",
          "type": "string"
        }
      },
      "required": [
        "compartmentId",
        "periodValue",
        "resourceName",
        "totalAvailable",
        "totalDemanded",
        "totalSupplied",
        "totalCancelled",
        "totalUnfulfilled",
        "totalRejected",
        "workloadTypeBreakdownBlob",
        "unit"
      ],
      "type": "object"
    }
  }
}