Ontology term detail

GET

/api/v1/projects/{projectId}/ontology/terms/{kind}/{name}/detail

curl --request GET \
  --url https://api.yggy.tech/api/v1/projects/example/ontology/terms/class/example/detail \
  --header 'Authorization: Bearer <token>'

• Production

Bounded per-term usage detail for the ontology side panel.

Authorizations

• bearerAuth
• apiKeyAuth

Parameters

Path Parameters

projectId

required

string

>= 1 characters

kind

required

string

Allowed values: class relation data-property

name

required

string

>= 1 characters <= 100 characters

Responses

200

Term detail

Media type application/json

One of:

object

object

kind

required

string

Allowed values: class

class

required

object

entities

required

number

facts

required

number

topRelations

required

Array<object>

object

relation

required

string

direction

required

string

Allowed values: out in

facts

required

number

propertyFill

required

Array<object>

object

property

required

string

share

required

number

object

object

kind

required

string

Allowed values: relation

relation

required

object

pairs

required

Array<object>

object

subject

required

string

object

required

string

facts

required

number

pairsComplete

required

boolean

examples

required

Array<object>

object

subject

required

string

object

required

string

documentId

required

string | null

documentTitle

required

string | null

object

object

kind

required

string

Allowed values: data-property

property

required

object

sampleValues

required

Array<string>

datatype

required

string

Example

{
  "kind": "class",
  "class": {
    "topRelations": [
      {
        "direction": "out"
      }
    ]
  }
}

400

Invalid request

Media type application/json

object

error

required

string

Example ^generated

{
  "error": "example"
}

401

Unauthorized

Media type application/json

object

error

required

string

Example ^generated

{
  "error": "example"
}

403

Project access required

Media type application/json

object

error

required

string

Example ^generated

{
  "error": "example"
}

404

Unknown project or unknown term

Media type application/json

object

error

required

string

Example ^generated

{
  "error": "example"
}

500

Internal server error

Media type application/json

object

error

required

string

Example ^generated

{
  "error": "example"
}

504

Term detail timed out

Media type application/json

object

error

required

string

Example ^generated

{
  "error": "example"
}