HateoasCollectionOfLicenseCollection

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/snow-software/json-schema/snow-software-hateoas-collection-of-license-collection-schema.json",
  "title": "HateoasCollectionOfLicenseCollection",
  "x-generated": "2026-11-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/snow-software-licenses-api-openapi.yml#/components/schemas/HateoasCollectionOfLicenseCollection",
  "allOf": [
    {
      "$ref": "#/$defs/FilteredResponseOfLicenseCollection"
    },
    {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "_links"
      ],
      "properties": {
        "_links": {
          "type": "array",
          "description": "A collection of links to related resources.",
          "items": {
            "$ref": "#/$defs/Link"
          }
        }
      }
    }
  ],
  "$defs": {
    "FilteredResponseOfLicenseCollection": {
      "type": "object",
      "description": "Filtered response.",
      "additionalProperties": false,
      "required": [
        "items",
        "pagination"
      ],
      "properties": {
        "items": {
          "type": "array",
          "description": "A collection of items.",
          "items": {
            "$ref": "#/$defs/LicenseCollection"
          }
        },
        "pagination": {
          "description": "The pagination details.",
          "oneOf": [
            {
              "$ref": "#/$defs/Pagination"
            }
          ]
        }
      }
    },
    "HateoasResource": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "_links"
      ],
      "properties": {
        "_links": {
          "type": "array",
          "description": "A collection of links to related resources.",
          "items": {
            "$ref": "#/$defs/Link"
          }
        }
      }
    },
    "IncompleteLicenseReason": {
      "type": "integer",
      "description": "The incomplete reason.",
      "x-enumFlags": true,
      "x-enumNames": [
        "None",
        "MissingApplication",
        "MissingLicenseCount",
        "MissingMetric",
        "MissingBaseLicenses",
        "InvalidSubscriptionPeriod",
        "MissingValidFromToDate",
        "MissingAgreementNumber",
        "MissingAssignmentType",
        "All"
      ],
      "enum": [
        0,
        1,
        2,
        4,
        8,
        16,
        32,
        64,
        128,
        255
      ]
    },
    "LicenseCollection": {
      "allOf": [
        {
          "$ref": "#/$defs/HateoasResource"
        },
        {
          "type": "object",
          "description": "The collection of licenses.",
          "additionalProperties": false,
          "properties": {
            "id": {
              "type": "string",
              "description": "The unique ID of the license.",
              "format": "guid"
            },
            "organizationId": {
              "type": [
                "string",
                "null"
              ],
              "description": "The unique ID of the organization.",
              "format": "guid"
            },
            "applicationId": {
              "type": [
                "string",
                "null"
              ],
              "description": "The unique ID of the application.",
              "format": "guid"
            },
            "contractId": {
              "type": [
                "string",
                "null"
              ],
              "description": "The unique ID of the agreement.",
              "format": "guid"
            },
            "agreementId": {
              "type": [
                "string",
                "null"
              ],
              "description": "The unique ID of the agreement.",
              "format": "guid"
            },
            "metricId": {
              "type": [
                "string",
                "null"
              ],
              "description": "The unique ID of the metric.",
              "format": "guid"
            },
            "assignmentTypeId": {
              "type": [
                "string",
                "null"
              ],
              "description": "The unique ID of the assignment type.",
              "format": "guid"
            },
            "purchaseDate": {
              "type": "string",
              "description": "The purchase date.",
              "format": "date-time"
            },
            "purchaseValue": {
              "type": [
                "number",
                "null"
              ],
              "description": "The purchase value.",
              "format": "decimal"
            },
            "purchaseCurrency": {
              "type": [
                "string",
                "null"
              ],
              "description": "The purchase currency."
            },
            "quantity": {
              "type": [
                "integer",
                "null"
              ],
              "description": "The quantity.",
              "format": "int32"
            },
            "initialQuantity": {
              "type": [
                "integer",
                "null"
              ],
              "description": "The initial quantity.",
              "format": "int32"
            },
            "mediaStorage": {
              "type": [
                "string",
                "null"
              ],
              "description": "The media storage."
            },
            "licenseProofLocation": {
              "type": [
                "string",
                "null"
              ],
              "description": "The license proof location."
            },
            "invoiceReference": {
              "type": [
                "string",
                "null"
              ],
              "description": "The invoice reference."
            },
            "vendor": {
              "type": [
                "string",
                "null"
              ],
              "description": "The vendor."
            },
            "externalId": {
              "type": [
                "string",
                "null"
              ],
              "description": "The external ID."
            },
            "productDescription": {
              "type": [
                "string",
                "null"
              ],
              "description": "The product description."
            },
            "isSubscription": {
              "type": "boolean",
              "description": "```true``` if is subscription; otherwise, ```false```."
            },
            "isCrossEdition": {
              "type": "boolean",
              "description": "```true``` if is cross-edition; otherwise, ```false```."
            },
            "isCrossPlatform": {
              "type": "boolean",
              "description": "```true``` if is cross-platform; otherwise, ```false```."
            },
            "isUpgrade": {
              "type": "boolean",
              "description": "```true``` if is upgrade; otherwise, ```false```."
            },
            "isDowngrade": {
              "type": "boolean",
              "description": "```true``` if is downgrade; otherwise, ```false```."
            },
            "isIncomplete": {
              "type": "boolean",
              "description": "```true``` if is incomplete; otherwise, ```false```."
            },
            "incompleteReasons": {
              "description": "The incomplete license reasons.",
              "oneOf": [
                {
                  "$ref": "#/$defs/IncompleteLicenseReason"
                }
              ]
            },
            "updatedDate": {
              "type": "string",
              "description": "The updated date.",
              "format": "date-time"
            },
            "createdDate": {
              "type": "string",
              "description": "The created date.",
              "format": "date-time"
            },
            "subscriptionValidFrom": {
              "type": [
                "string",
                "null"
              ],
              "description": "The subscription valid from date.",
              "format": "date-time"
            },
            "subscriptionValidTo": {
              "type": [
                "string",
                "null"
              ],
              "description": "The subscription valid to date.",
              "format": "date-time"
            },
            "activeMaintenanceCost": {
              "type": "number",
              "description": "The active maintenance cost.",
              "format": "decimal"
            },
            "totalMaintenanceCost": {
              "type": "number",
              "description": "The total maintenance cost.",
              "format": "decimal"
            },
            "activeSupportCost": {
              "type": "number",
              "description": "The active support cost.",
              "format": "decimal"
            },
            "totalSupportCost": {
              "type": "number",
              "description": "The total support cost.",
              "format": "decimal"
            },
            "totalLicenseCost": {
              "type": "number",
              "description": "The total license cost.",
              "format": "decimal"
            },
            "upgradedLicenseCount": {
              "type": [
                "integer",
                "null"
              ],
              "description": "The upgraded license count.",
              "format": "int32"
            },
            "autoAllocateOnce": {
              "type": [
                "boolean",
                "null"
              ],
              "description": "```true``` if has auto allocate once selected; otherwise, ```false```."
            },
            "isAutoAllocated": {
              "type": [
                "boolean",
                "null"
              ],
              "description": "```true``` if has auto allocate selected; otherwise, ```false```."
            },
            "maintenanceAccordingToAgreement": {
              "type": "boolean",
              "description": "```true``` if is maintenance and support periods are based on the agreement; otherwise, ```false```.."
            },
            "skuId": {
              "type": [
                "string",
                "null"
              ],
              "description": "The unique ID of the sku.",
              "format": "guid"
            },
            "upgrades": {
              "type": [
                "array",
                "null"
              ],
              "description": "The collection of license upgrades.",
              "items": {
                "$ref": "#/$defs/LicenseCollectionUpgrade"
              }
            },
            "status": {
              "type": "string",
              "description": "The status of the license.",
              "allOf": [
                {
                  "$ref": "#/$defs/Status"
                }
              ]
            },
            "archivedDate": {
              "type": [
                "string",
                "null"
              ],
              "description": "The archived date.",
              "format": "date-time"
            }
          }
        }
      ]
    },
    "LicenseCollectionUpgrade": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "licenseId": {
          "type": "string",
          "description": "The unique ID of the license.",
          "format": "guid"
        },
        "quantity": {
          "type": "integer",
          "description": "The quantity.",
          "format": "int32"
        },
        "upgradedLicenseId": {
          "type": "string",
          "description": "The unique ID of the upgraded license.",
          "format": "guid"
        },
        "upgradedQuantity": {
          "type": "integer",
          "description": "The upgraded quantity.",
          "format": "int32"
        }
      }
    },
    "Link": {
      "type": "object",
      "description": "Represents a hypermedia link referenced from a IResource, according to HATEOAS.",
      "additionalProperties": false,
      "properties": {
        "href": {
          "type": [
            "string",
            "null"
          ],
          "description": "The associated relative URL."
        },
        "rel": {
          "type": [
            "string",
            "null"
          ],
          "description": "Specifies the relationship between the current document and the linked document/resource."
        },
        "method": {
          "type": [
            "string",
            "null"
          ],
          "description": "The method to access related resources."
        }
      }
    },
    "Pagination": {
      "type": "object",
      "description": "The pagination details.",
      "additionalProperties": false,
      "required": [
        "page_size",
        "page_number"
      ],
      "properties": {
        "page_size": {
          "type": "integer",
          "description": "The page size you requested.",
          "format": "int32"
        },
        "page_number": {
          "type": "integer",
          "description": "The page number you requested.",
          "format": "int32"
        },
        "total_pages": {
          "type": [
            "integer",
            "null"
          ],
          "description": "The total number of pages.",
          "format": "int32"
        },
        "total_items": {
          "type": [
            "integer",
            "null"
          ],
          "description": "The total number of items.",
          "format": "int32"
        }
      }
    },
    "Status": {
      "type": "string",
      "description": "The status of the license.",
      "x-enumDescriptions": {
        "Active": "The license is active and affects compliance position.",
        "Archived": "The license is archived and does not affect compliance position."
      }
    }
  }
}