fabric-rest-api-specs/ontology/definitions.json

{
  "swagger": "2.0",
  "info": {
    "version": "v1",
    "title": "Ontology data types"
  },
  "paths": {},
  "definitions": {
    "Ontologies": {
      "description": "A list of ontologies.",
      "required": [ "value" ],
      "type": "object",
      "properties": {
        "value": {
          "description": "A list of ontologies.",
          "type": "array",
          "items": {
            "$ref": "#/definitions/Ontology"
          }
        }
      },
      "allOf": [
        {
          "$ref": "../common/definitions.json#/definitions/PaginatedResponse"
        }
      ]
    },
    "Ontology": {
      "description": "An ontology object.",
      "type": "object",
      "required": [ "type" ],
      "allOf": [
        {
          "$ref": "../common/definitions.json#/definitions/Item"
        }
      ],
      "properties": {
        "properties": {
          "description": "The ontology properties.",
          "$ref": "#/definitions/OntologyProperties"
        }
      }
    },
    "OntologyProperties": {
      "description": "The properties of an ontology item.",
      "type": "object",
      "properties": {
        "generation": {
          "description": "The resolved ontology generation (`1` or `2`). The value reflects the generation created, regardless of creation mode.",
          "type": "integer",
          "format": "int32",
          "readOnly": true
        }
      }
    },
    "CreateOntologyRequest": {
      "description": "Create ontology request payload.",
      "required": [ "displayName" ],
      "properties": {
        "displayName": {
          "description": "The ontology display name. The display name must follow naming rules according to item type i.e., It should start with letter, only has numbers and letters or _ and is less than 100.",
          "type": "string",
          "readOnly": false
        },
        "description": {
          "description": "The ontology description. Maximum length is 256 characters.",
          "type": "string",
          "readOnly": false
        },
        "definition": {
          "description": "The [Ontology public definition](/rest/api/fabric/articles/item-management/definitions/ontology-definition).",
          "$ref": "#/definitions/OntologyDefinition",
          "readOnly": false
        },
        "sensitivityLabelSettings": {
          "description": "The sensitivity label settings for the Ontology.",
          "$ref": "../common/definitions.json#/definitions/SensitivityLabelSettings",
          "readOnly": false
        }
      }
    },
    "UpdateOntologyDefinitionRequest": {
      "description": "Update ontology public definition request payload.",
      "required": [ "definition" ],
      "properties": {
        "definition": {
          "$ref": "#/definitions/OntologyDefinition"
        }
      }
    },
    "OntologyDefinitionResponse": {
      "description": "Ontology public definition response.",
      "required": [ "definition" ],
      "properties": {
        "definition": {
          "$ref": "#/definitions/OntologyDefinition",
          "readOnly": true
        }
      }
    },
    "OntologyDefinition": {
      "description": "Ontology public definition object. Refer to this [article](/rest/api/fabric/articles/item-management/definitions/ontology-definition) for more details on the structure of the Ontology definition.",
      "type": "object",
      "required": [ "parts" ],
      "properties": {
        "format": {
          "description": "The format of the Ontology definition.",
          "type": "string",
          "readOnly": false
        },
        "parts": {
          "description": "A list of definition parts.",
          "type": "array",
          "items": {
            "$ref": "#/definitions/OntologyDefinitionPart"
          },
          "readOnly": false
        }
      }
    },
    "OntologyDefinitionPart": {
      "description": "Ontology definition part object.",
      "type": "object",
      "required": [ "path", "payload", "payloadType" ],
      "properties": {
        "path": {
          "description": "The ontology part path.",
          "type": "string",
          "readOnly": false
        },
        "payload": {
          "description": "The ontology part payload.",
          "type": "string",
          "readOnly": false
        },
        "payloadType": {
          "description": "The payload type.",
          "$ref": "../common/definitions.json#/definitions/PayloadType",
          "readOnly": false
        }
      }
    },
    "UpdateOntologyRequest": {
      "description": "Update ontology request.",
      "properties": {
        "displayName": {
          "description": "The ontology display name. The display name must follow naming rules according to item type.",
          "type": "string",
          "readOnly": false
        },
        "description": {
          "description": "The ontology description. Maximum length is 256 characters.",
          "type": "string",
          "readOnly": false
        }
      }
    }
  }
}