Skip to content

Upsert Ontology Concept

PUT
/knowledge-ontology/{concept_id}

Define or redefine one concept in the ontology.

An upsert: the same concept_id twice edits rather than duplicating, which makes it safe to retry.

Authorizations

Parameters

Path Parameters

concept_id
required
string
>= 1 characters <= 255 characters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Define or redefine one concept in the org’s ontology.

object
body
required
string
>= 1 characters <= 2000000 characters
concept_id
required
string
>= 1 characters <= 255 characters
concept_type
required
string
>= 1 characters <= 100 characters
definition_override
Any of:
string
<= 10000 characters
extensions
object
key
additional properties
any
ontology
object
key
additional properties
any
relationships
Array<object>
<= 100 items

How one concept relates to another. Open-shaped, matching the app.

object
key
additional properties
any
review_at
Any of:
string format: date-time
source_owner
Any of:
string
<= 255 characters
sources
Array<object>
<= 50 items

Where a concept came from. Open-shaped, matching the app’s SourceInput.

object
key
additional properties
any
stale_after
Any of:
string format: date-time
standard_component_id
Any of:
string
<= 100 characters
title
required
string
>= 1 characters <= 500 characters
trust_tier

How much to trust this definition. Defaults to human-reviewed, matching the app — a concept written through the API is treated as authored, not inferred.

string
default: human_reviewed

Responses

200

Successful Response

object
data
required

An open envelope for a settings object.

Open because an ontology concept and an SSO config both grow fields as the product does, and on a settings read a dropped field reads as “not configured” rather than “we did not tell you”.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string