CustomPropertyDefinition

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/folio/main/json-schema/folio-custom-property-definition-schema.json",
  "title": "CustomPropertyDefinition",
  "x-generated": "2026-10-09",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/folio-mod-licenses-openapi.yml#/components/schemas/CustomPropertyDefinition",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "label": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "primary": {
      "type": "boolean"
    },
    "defaultInternal": {
      "type": "boolean"
    },
    "retired": {
      "type": "boolean"
    },
    "weight": {
      "type": "integer"
    },
    "type": {
      "type": "string",
      "description": "Java class name indicating the property type (e.g. CustomPropertyInteger, CustomPropertyText, CustomPropertyRefdata)"
    },
    "category": {
      "$ref": "#/$defs/RefDataCategory"
    }
  },
  "$defs": {
    "RefData": {
      "type": "object",
      "required": [
        "id"
      ],
      "properties": {
        "id": {
          "type": "string",
          "readOnly": true
        },
        "label": {
          "type": "string"
        },
        "value": {
          "type": "string"
        },
        "owner": {
          "$ref": "#/$defs/RefDataCategory"
        }
      }
    },
    "RefDataCategory": {
      "type": "object",
      "required": [
        "id"
      ],
      "properties": {
        "desc": {
          "type": "string"
        },
        "id": {
          "type": "string",
          "readOnly": true
        },
        "internal": {
          "type": "boolean"
        },
        "values": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/RefData"
          }
        }
      }
    }
  }
}