license-terms-batch

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/folio/main/json-schema/folio-license-terms-batch-schema.json",
  "title": "license-terms-batch",
  "description": "License terms response",
  "x-generated": "2026-10-09",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/folio-edge-erm-openapi.yml#/components/schemas/license-terms-batch",
  "type": "object",
  "properties": {
    "results": {
      "type": "array",
      "description": "license term items found by provided ids",
      "items": {
        "type": "object",
        "description": "license term item response",
        "$ref": "#/$defs/license-terms-batch-item"
      }
    }
  },
  "required": [
    "results"
  ],
  "$defs": {
    "license-term-item": {
      "description": "License term item record",
      "type": "object",
      "properties": {
        "id": {
          "description": "License term id",
          "type": "number"
        },
        "name": {
          "description": "License term name",
          "type": "string"
        },
        "label": {
          "description": "License term label",
          "type": "string"
        },
        "description": {
          "description": "License term description",
          "type": "string"
        },
        "visibility": {
          "description": "License term visibility",
          "type": "string"
        },
        "primary": {
          "description": "Indicates if this license term is primary",
          "type": "boolean"
        },
        "value": {
          "description": "Free-form JSON value (can be string, object, array, etc).",
          "x-java-type": "java.lang.Object"
        },
        "weight": {
          "description": "License term weight for sorting",
          "type": "number"
        },
        "publicNote": {
          "description": "Public note for this license term",
          "type": "string"
        }
      },
      "required": [
        "id",
        "name",
        "label",
        "description",
        "visibility",
        "primary",
        "value",
        "weight",
        "publicNote"
      ]
    },
    "license-terms-batch-item": {
      "description": "License term item response",
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "id field"
        },
        "licenseTerms": {
          "description": "Array of license term objects with found values",
          "type": "array",
          "items": {
            "type": "object",
            "description": "license term item object",
            "$ref": "#/$defs/license-term-item"
          }
        }
      },
      "required": [
        "id",
        "licenseTerms"
      ]
    }
  }
}