SemanticOntologyUpdate

SemanticOntology update request (all fields optional; omitted = no change). entities/relations are curation lists merged by name onto the imported structure — they never add or remove types (that is sync). collection_id is not updatable: it follows the model.

name object

anyOf

• string
• null

string

Possible values: non-empty and <= 63 characters, Value must match regular expression ^[a-z][a-z0-9_]{0,62}(?![\s\S])

alias object

anyOf

• string
• null

string

folder_id object

anyOf

• string
• null

string

tags object

anyOf

• string[]
• null

Array [

string

]

description object

anyOf

• string
• null

string

comments object

anyOf

• string[]
• null

Array [

string

]

instructions object

anyOf

• string[]
• null

Array [

string

]

entities object

anyOf

• object[]
• null

Array [

nameName (string)required

visible object

anyOf

• boolean
• null

boolean

comments object

anyOf

• string[]
• null

Array [

string

]

links object

anyOf

• object[]
• null

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
• null

string

]

attributes object[]

Array [

nameName (string)required

visible object

anyOf

• boolean
• null

boolean

label object

anyOf

• string
• null

string

description object

anyOf

• string
• null

string

synonyms object

anyOf

• string[]
• null

Array [

string

]

dictionary object

anyOf

• ColumnDictionary
• null

builtin object

anyOf

• object
• null

object

external object

anyOf

• string
• null

string

values object

anyOf

• string[]
• null

Array [

string

]

samples object

anyOf

• string[]
• null

Array [

string

]

display object

anyOf

• boolean
• null

boolean

]

]

relations object

anyOf

• object[]
• null

Array [

nameName (string)required

visible object

anyOf

• boolean
• null

boolean

description object

anyOf

• string
• null

string

]

SemanticOntologyUpdate

{
  "name": "string",
  "alias": "string",
  "folder_id": "string",
  "tags": [
    "string"
  ],
  "description": "string",
  "comments": [
    "string"
  ],
  "instructions": [
    "string"
  ],
  "entities": [
    {
      "name": "string",
      "visible": true,
      "comments": [
        "string"
      ],
      "links": [
        {
          "category": "semantic.table",
          "id": "string",
          "name": "string"
        }
      ],
      "attributes": [
        {
          "name": "string",
          "visible": true,
          "label": "string",
          "description": "string",
          "synonyms": [
            "string"
          ],
          "dictionary": {
            "builtin": {},
            "external": "string"
          },
          "values": [
            "string"
          ],
          "samples": [
            "string"
          ],
          "display": true
        }
      ]
    }
  ],
  "relations": [
    {
      "name": "string",
      "visible": true,
      "description": "string"
    }
  ]
}