Skip to main content

SemanticOntologyResponse

SemanticOntology detail/list response — the LLM-facing layer over one OntologyModel: imported structure + curation.

idId (string)required

Server-assigned unique identifier

nameName (string)required

Resource name

alias object

Display name shown to users.

anyOf
string
categoryCategory (string)required

Resource type tag

type object

Subtype within category

anyOf
string
collection_id object

Parent collection ID

anyOf
string
folder_id object

Identifier of the containing folder.

anyOf
string
tags object

Classification labels

anyOf
  • Array [
  • string
  • ]
  • description object

    Resource description

    anyOf
    string
    markingsstring[]

    Mandatory marking ids this resource requires; read-only — set via the marking guard endpoints, not Create/PATCH.

    Default value: []
    created_at object

    Creation timestamp (Unix ms)

    anyOf
    integer
    updated_at object

    Last update timestamp (Unix ms)

    anyOf
    integer
    owners object[]

    Users and groups that own the resource.

  • Array [
  • idId (string)required

    "user." | "group." | "public.all"

    typeType (string)required

    Possible values: [user, group, public]

    display_nameDisplay Name (string)required
    avatar_url object
    anyOf
    string
    avatar_config object
    anyOf
    object
    email object
    anyOf
    string<email>
  • ]
  • my_share_scope object

    How the current caller received access to the resource.

    anyOf
    string

    Possible values: [owner, grant, admin]

    model_idModel Id (string)required

    Owning OntologyModel id (ontology.model.*)

    commentsstring[]
    instructionsstring[]
    entities object[]
  • Array [
  • nameName (string)required
    description object
    anyOf
    string
    commentsstring[]
    visibleVisible (boolean)
    Default value: true
    missingMissing (boolean)
    Default value: false
    attributes object[]
  • Array [
  • nameName (string)required
    data_type object
    anyOf
    nameName (string)required

    Arrow type name, e.g. 'int64', 'utf8', 'decimal'

    unit object
    anyOf
    string

    Possible values: [s, ms, us, ns]

    timezone object
    anyOf
    string
    precision object
    anyOf
    integer

    Possible values: >= 1 and <= 76

    scale object
    anyOf
    integer

    Possible values: >= 0

    label object
    anyOf
    string
    description object
    anyOf
    string
    synonymsstring[]
    keyKey (boolean)
    Default value: false
    visibleVisible (boolean)
    Default value: true
    dictionary object
    anyOf
    builtin object
    anyOf
    object
    external object
    anyOf
    string
    valuesstring[]
    samplesstring[]
    displayDisplay (boolean)
    Default value: false
  • ]
  • links object[]
  • Array [
  • categoryCategory (string)required

    Allowed values: semantic.table, semantic.ontology.

    Possible values: [semantic.table, semantic.ontology]

    idId (string)required

    Target resource id

    name object

    Entity name inside the target (ontology only)

    anyOf
    string
  • ]
  • ]
  • relations object[]
  • Array [
  • nameName (string)required
    description object
    anyOf
    string
    sourceSource (string)required
    targetTarget (string)required
    cardinalityCardinality (string)
    Default value: many_to_many
    visibleVisible (boolean)
    Default value: true
    missingMissing (boolean)
    Default value: false
  • ]
  • synced_at object
    anyOf
    integer
    itemItem (string)requireddeprecated
    SemanticOntologyResponse
    {
    "id": "string",
    "name": "string",
    "alias": "string",
    "category": "string",
    "type": "string",
    "collection_id": "string",
    "folder_id": "string",
    "tags": [
    "string"
    ],
    "description": "string",
    "markings": [
    "string"
    ],
    "created_at": 0,
    "updated_at": 0,
    "owners": [
    {
    "id": "string",
    "type": "user",
    "display_name": "string",
    "avatar_url": "string",
    "avatar_config": {},
    "email": "user@example.com"
    }
    ],
    "my_share_scope": "owner",
    "model_id": "string",
    "comments": [
    "string"
    ],
    "instructions": [
    "string"
    ],
    "entities": [
    {
    "name": "string",
    "description": "string",
    "comments": [
    "string"
    ],
    "visible": true,
    "missing": false,
    "attributes": [
    {
    "name": "string",
    "data_type": {
    "name": "string",
    "unit": "s",
    "timezone": "string",
    "precision": 0,
    "scale": 0
    },
    "label": "string",
    "description": "string",
    "synonyms": [
    "string"
    ],
    "key": false,
    "visible": true,
    "dictionary": {
    "builtin": {},
    "external": "string"
    },
    "values": [
    "string"
    ],
    "samples": [
    "string"
    ],
    "display": false
    }
    ],
    "links": [
    {
    "category": "semantic.table",
    "id": "string",
    "name": "string"
    }
    ]
    }
    ],
    "relations": [
    {
    "name": "string",
    "description": "string",
    "source": "string",
    "target": "string",
    "cardinality": "many_to_many",
    "visible": true,
    "missing": false
    }
    ],
    "synced_at": 0
    }