EntitlementUsageItemListResponse

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/outsystems/main/json-schema/outsystems-entitlement-usage-item-list-response-schema.json",
  "title": "EntitlementUsageItemListResponse",
  "description": "Represents a response containing a list of results.",
  "x-generated": "2026-10-03",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/outsystems-organization-api-openapi.yml#/components/schemas/EntitlementUsageItemListResponse",
  "type": "object",
  "properties": {
    "results": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "$ref": "#/$defs/EntitlementUsageItem"
      },
      "description": "List of results."
    }
  },
  "additionalProperties": false,
  "$defs": {
    "EntitlementUsageItem": {
      "type": "object",
      "properties": {
        "id": {
          "type": [
            "string",
            "null"
          ],
          "description": "Entitlement identifier (e.g., \"applicationObjects\")."
        },
        "name": {
          "type": [
            "string",
            "null"
          ],
          "description": "Human-readable name of the entitlement."
        },
        "aggregation": {
          "type": [
            "string",
            "null"
          ],
          "description": "Aggregation function applied (e.g., \"avg\", \"max\", \"total\")."
        },
        "lastUpdatedDate": {
          "type": [
            "string",
            "null"
          ],
          "description": "Last time this usage data was updated.",
          "format": "date-time"
        },
        "usage": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "$ref": "#/$defs/UsageDataPoint"
          },
          "description": "Time series of usage data points."
        }
      },
      "additionalProperties": false,
      "description": "Represents usage data for a single entitlement type."
    },
    "UsageDataPoint": {
      "type": "object",
      "properties": {
        "timestamp": {
          "type": "string",
          "description": "Timestamp for this data point.",
          "format": "date-time"
        },
        "value": {
          "type": [
            "number",
            "null"
          ],
          "description": "Usage value at this timestamp.",
          "format": "double"
        },
        "cumulativeValue": {
          "type": [
            "number",
            "null"
          ],
          "description": "Cumulative aggregation value up to this timestamp. Only present for certain aggregation types.",
          "format": "double"
        }
      },
      "additionalProperties": false,
      "description": "Represents a single data point in a usage time series."
    }
  }
}