LinkEntityDefinitionList

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/clarivate/main/json-schema/clarivate-link-entity-definition-list-schema.json",
  "title": "LinkEntityDefinitionList",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/clarivate-configuration-link-entity-definitions-api-openapi.yml#/components/schemas/LinkEntityDefinitionList",
  "required": [
    "count",
    "data",
    "nrRecordsAll",
    "nrRecordsFound",
    "startRecord"
  ],
  "type": "object",
  "properties": {
    "startRecord": {
      "type": "integer"
    },
    "count": {
      "type": "integer"
    },
    "nrRecordsAll": {
      "type": "integer"
    },
    "nrRecordsFound": {
      "type": "integer"
    },
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/LinkEntityDefinition"
      }
    }
  },
  "$defs": {
    "AttributeDefinition": {
      "required": [
        "name"
      ],
      "type": "object",
      "properties": {
        "id": {
          "type": "integer",
          "format": "int64"
        },
        "name": {
          "type": "string"
        },
        "dataInput": {
          "$ref": "#/$defs/AttributeInputDefinition"
        },
        "multilanguage": {
          "type": "boolean"
        },
        "description": {
          "type": "string"
        },
        "labels": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/LabelDefinition"
          }
        },
        "mandatory": {
          "type": "boolean"
        },
        "allowPublicSearch": {
          "type": "boolean"
        },
        "internallySearcheable": {
          "type": "boolean"
        },
        "includeInPageExport": {
          "type": "boolean"
        }
      }
    },
    "AttributeInputDefinition": {
      "properties": {
        "dataType": {
          "type": "string"
        },
        "renderingTypeHint": {
          "type": "string"
        },
        "inputPattern": {
          "type": "string"
        },
        "defaultExpression": {
          "type": "string"
        }
      }
    },
    "LabelDefinition": {
      "required": [
        "language",
        "value"
      ],
      "type": "object",
      "properties": {
        "language": {
          "type": "string",
          "description": "The system language abbreviation"
        },
        "value": {
          "type": "string",
          "description": "The value of the label"
        }
      }
    },
    "LinkEntityDefinition": {
      "required": [
        "attributes",
        "description",
        "id",
        "isTree",
        "leftDefinitionUrl",
        "name",
        "rightDefinitionUrl"
      ],
      "type": "object",
      "properties": {
        "id": {
          "type": "integer",
          "format": "int64"
        },
        "name": {
          "type": "string"
        },
        "isTree": {
          "type": "boolean"
        },
        "description": {
          "type": "string"
        },
        "leftDefinitionUrl": {
          "type": "string"
        },
        "rightDefinitionUrl": {
          "type": "string"
        },
        "attributes": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/AttributeDefinition"
          }
        }
      }
    }
  }
}