Skip to content
Docs
Follow yggy on LinkedInFollow @yggy_tech on X

List project ontology classes

GET
/api/v1/projects/{projectId}/ontology/classes
 
curl --request GET \
  --url 'https://api.yggy.tech/api/v1/projects/example/ontology/classes?page=1&pageSize=25&unused=0' \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
projectId
required
string
>= 1 characters

Query Parameters

Section titled “Query Parameters ”
page
integer
default: 1 >= 1
pageSize
integer
default: 25 >= 1 <= 100
q
string
cluster
string
unused
string
Allowed values: 0 1 true false

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Paged ontology classes

Media type application/json
object
items
required
Array<object>
object
name
required
string
parent
string
description
string
count
required
number
origin
required
string
Allowed values: base project unsupported
state
required
string
Allowed values: ACTIVE DEPRECATED
replacementTerm
string
countsAvailable
required
boolean
total
required
number
page
required
number
pageSize
required
number
totalPages
required
number
Example 
{
  "items": [
    {
      "origin": "base",
      "state": "ACTIVE"
    }
  ]
}

401

Section titled “401 ”

Unauthorized

Media type application/json
object
error
required
string
Example generated
{
  "error": "example"
}

500

Section titled “500 ”

Internal server error

Media type application/json
object
error
required
string
Example generated
{
  "error": "example"
}