API docs by Redocly

Taxonomy Model API (v0.0.121 build:4748 sha:07af2005937d933deb39f9aa3a6b56bc194aa750)

Download OpenAPI specification:Download

License: MIT

Taxonomy Model API Documentation

info

Get information about the deployed api.

Retrieve information about the deployed api, including build details and database connection status.

Authorizations:
api_keyjwt_auth

Responses

Response samples

Content type
application/json
{
  • "date": "2019-08-24T14:15:22Z",
  • "version": "string",
  • "buildNumber": "string",
  • "sha": "string",
  • "path": "http://example.com",
  • "database": "connected"
}

occupationGroups

Get occupation group children by its parent occupation group identifier in a taxonomy model.

Retrieve occupation group children by its unique parent occupation group identifier in a specific taxonomy model.

Authorizations:
api_keyjwt_auth
path Parameters
modelId
required
string^[0-9a-f]{24}$

The identifier of the model for occupation group.

id
required
string^[0-9a-f]{24}$

The id of the occupation group. It can be used to retrieve the occupation group from the server.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "limit": 10,
  • "nextCursor": "string"
}

Get an occupation group by its identifier in a taxonomy model.

Retrieve an occupation group by its unique identifier in a specific taxonomy model.

Authorizations:
api_keyjwt_auth
path Parameters
modelId
required
string^[0-9a-f]{24}$

The identifier of the model for occupation group.

id
required
string^[0-9a-f]{24}$

The id of the occupation group. It can be used to retrieve the occupation group from the server.

Responses

Response samples

Content type
application/json
Example
{
  • "id": "string",
  • "UUID": "string",
  • "originUUID": "string",
  • "path": "http://example.com",
  • "tabiyaPath": "http://example.com",
  • "parent": {
    },
  • "children": [
    ],
  • "UUIDHistory": [
    ],
  • "originUri": "http://example.com",
  • "code": "string",
  • "description": "string",
  • "preferredLabel": "string",
  • "altLabels": [
    ],
  • "groupType": "iscogroup",
  • "modelId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Get the model history of an occupation group in a taxonomy model.

Retrieve the list of taxonomy models the occupation group appeared in, based on its UUIDHistory. Each entry is the full model information for a model the occupation group was part of. UUIDs in the history that no longer resolve to an existing occupation group are omitted.

Authorizations:
api_keyjwt_auth
path Parameters
modelId
required
string^[0-9a-f]{24}$

The identifier of the model for occupation group.

id
required
string^[0-9a-f]{24}$

The id of the occupation group. It can be used to retrieve the occupation group from the server.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get an occupation group's parent by its child occupation group identifier in a taxonomy model.

Retrieve an occupation group parent by its unique child occupation group identifier in a specific taxonomy model.

Authorizations:
api_keyjwt_auth
path Parameters
modelId
required
string^[0-9a-f]{24}$

The identifier of the model for occupation group.

id
required
string^[0-9a-f]{24}$

The id of the occupation group. It can be used to retrieve the occupation group from the server.

Responses

Response samples

Content type
application/json
Example
{
  • "id": "string",
  • "UUID": "string",
  • "originUUID": "string",
  • "path": "http://example.com",
  • "tabiyaPath": "http://example.com",
  • "parent": {
    },
  • "children": [
    ],
  • "UUIDHistory": [
    ],
  • "originUri": "http://example.com",
  • "code": "string",
  • "description": "string",
  • "preferredLabel": "string",
  • "altLabels": [
    ],
  • "groupType": "iscogroup",
  • "modelId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Link an occupation group parent.

Establish or update the parent relationship for a specific occupation group in a specific taxonomy model.

Authorizations:
api_keyjwt_auth
path Parameters
modelId
required
string^[0-9a-f]{24}$

The identifier of the model for occupation.

id
required
string

The unique ID of the child occupation group.

Request Body schema: application/json
id
required
string^[0-9a-f]{24}$
objectType
required
string
Enum: "iscogroup" "localgroup"

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "objectType": "iscogroup"
}

Response samples

Content type
application/json
Example
{
  • "id": "string",
  • "UUID": "string",
  • "originUUID": "string",
  • "path": "http://example.com",
  • "tabiyaPath": "http://example.com",
  • "parent": {
    },
  • "children": [
    ],
  • "UUIDHistory": [
    ],
  • "originUri": "http://example.com",
  • "code": "string",
  • "description": "string",
  • "preferredLabel": "string",
  • "altLabels": [
    ],
  • "groupType": "iscogroup",
  • "modelId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Get a list of paginated occupation groups and cursor if there is one in a taxonomy model.

Retrieve a list of paginated occupation groups in a specific taxonomy model.

Authorizations:
api_keyjwt_auth
path Parameters
modelId
required
string^[0-9a-f]{24}$

The identifier of the model for occupation group.

query Parameters
limit
integer [ 1 .. 100 ]
Default: 10

The maximum number of items to return.

cursor
string <= 1720 characters \S

A base64 string representing the cursor for pagination.

query
string <= 256 characters

A free-text value to search the occupation groups by. When set, the endpoint returns the occupation groups matching the value on the requested searchFields, ranked by relevance. Released models are searched with vector embeddings; unreleased models with a case-insensitive regex.

searchFields
string <= 256 characters ^(preferredLabel|description|altLabels)(,(pre...

A comma-separated list of the occupation group fields to search on (e.g. 'preferredLabel,description'). Only meaningful together with query. Defaults to 'preferredLabel'.

root
boolean

Filter only root occupation groups (occupation groups with no parent).

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "limit": 10,
  • "nextCursor": "string"
}

Create a new taxonomy occupation group.

Create a new taxonomy occupation group in a specific taxonomy model.

Authorizations:
api_keyjwt_auth
path Parameters
modelId
required
string^[0-9a-f]{24}$

The identifier of the model for occupation group.

Request Body schema: application/json
One of
UUIDHistory
required
Array of strings [ 0 .. 10000 ] items unique [ items <= 36 characters ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]... ]

The UUIDs history of the occupation group.

originUri
required
string <uri> <= 4096 characters \S

The origin URI of the occupation group.

code
required
string <= 256 characters ^\d{1,4}$

The code of the occupation group.

description
required
string <= 6000 characters

The description of the occupation group.

preferredLabel
required
string <= 256 characters \S

The preferred label of the occupation group.

altLabels
required
Array of strings [ 0 .. 200 ] items unique [ items <= 256 characters ]

The alternative labels of the occupation group.

groupType
required
string
Enum: "iscogroup" "localgroup"

The type of the occupation group, e.g., ISCOGroup or LocalGroup.

modelId
required
string^[0-9a-f]{24}$

The identifier of the model for occupation group.

Responses

Request samples

Content type
application/json
Example
{
  • "UUIDHistory": [
    ],
  • "originUri": "http://example.com",
  • "code": "string",
  • "description": "string",
  • "preferredLabel": "string",
  • "altLabels": [
    ],
  • "groupType": "iscogroup",
  • "modelId": "string"
}

Response samples

Content type
application/json
Example
{
  • "id": "string",
  • "UUID": "string",
  • "originUUID": "string",
  • "path": "http://example.com",
  • "tabiyaPath": "http://example.com",
  • "parent": {
    },
  • "children": [
    ],
  • "UUIDHistory": [
    ],
  • "originUri": "http://example.com",
  • "code": "string",
  • "description": "string",
  • "preferredLabel": "string",
  • "altLabels": [
    ],
  • "groupType": "iscogroup",
  • "modelId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

occupations

Get an occupation's children in a taxonomy model.

Retrieve the children of an occupation in a specific taxonomy model.

Authorizations:
api_keyjwt_auth
path Parameters
modelId
required
string^[0-9a-f]{24}$

The identifier of the model for occupation.

id
required
string

The unique ID of the occupation.

query Parameters
limit
integer [ 1 .. 100 ]
Default: 10

The maximum number of items to return.

cursor
string <= 1024 characters \S

A base64 string representing the cursor for pagination.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "limit": 10,
  • "nextCursor": "string"
}

Get a single occupation by its ID in a taxonomy model.

Retrieve a single occupation by its ID in a specific taxonomy model.

Authorizations:
api_keyjwt_auth
path Parameters
modelId
required
string^[0-9a-f]{24}$

The identifier of the model for occupation.

id
required
string

The unique ID of the occupation.

Responses

Response samples

Content type
application/json
Example
{
  • "id": "string",
  • "UUID": "string",
  • "originUUID": "string",
  • "path": "http://example.com",
  • "tabiyaPath": "http://example.com",
  • "parent": {
    },
  • "children": [
    ],
  • "requiresSkills": [
    ],
  • "UUIDHistory": [
    ],
  • "originUri": "http://example.com",
  • "occupationType": "localoccupation",
  • "code": "string",
  • "occupationGroupCode": "string",
  • "preferredLabel": "string",
  • "altLabels": [
    ],
  • "definition": "string",
  • "description": "string",
  • "regulatedProfessionNote": "string",
  • "scopeNote": "string",
  • "isLocalized": true,
  • "modelId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Partially update an occupation by its ID.

Update one or more fields of an existing occupation in a specific taxonomy model. Only provided fields are updated.

Authorizations:
api_keyjwt_auth
path Parameters
modelId
required
string^[0-9a-f]{24}$

The identifier of the model for occupation.

id
required
string

The unique ID of the occupation to update.

Request Body schema: application/json
One of
UUIDHistory
Array of strings [ 0 .. 10000 ] items unique [ items <= 50 characters ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]... ]

The UUIDs history of the occupation.

originUri
string <uri> <= 4096 characters \S

The origin URI of the occupation.

occupationType
required
string
Enum: "escooccupation" "localoccupation"

The occupation classification type (e.g., ESCOOccupation or LocalOccupation).

Value: "escooccupation"
code
string <= 100 characters ^\d{4}(?:\.\d+)+$

The code of the occupation.

occupationGroupCode
string <= 100 characters ^\d{1,4}$

The code of the parent occupation group.

preferredLabel
string <= 256 characters \S

The preferred label of the occupation.

altLabels
Array of strings [ 0 .. 200 ] items unique [ items <= 256 characters ]

Alternative labels for the occupation.

definition
string <= 4000 characters

The formal definition of the occupation.

description
string <= 6000 characters

Additional descriptive information about the occupation.

regulatedProfessionNote
string <= 4000 characters

Regulatory information for legally regulated professions.

scopeNote
string <= 4000 characters

Scope clarification for the occupation's application.

isLocalized
boolean

Indicates if the occupation has localized variants. Must be false for LocalOccupation.

modelId
string^[0-9a-f]{24}$

The identifier of the model containing this occupation.

Responses

Request samples

Content type
application/json
Example
{
  • "UUIDHistory": [
    ],
  • "originUri": "http://example.com",
  • "occupationType": "escooccupation",
  • "code": "string",
  • "occupationGroupCode": "string",
  • "preferredLabel": "string",
  • "altLabels": [
    ],
  • "definition": "string",
  • "description": "string",
  • "regulatedProfessionNote": "string",
  • "scopeNote": "string",
  • "isLocalized": true,
  • "modelId": "string"
}

Response samples

Content type
application/json
Example
{
  • "id": "string",
  • "UUID": "string",
  • "originUUID": "string",
  • "path": "http://example.com",
  • "tabiyaPath": "http://example.com",
  • "parent": {
    },
  • "children": [
    ],
  • "requiresSkills": [
    ],
  • "UUIDHistory": [
    ],
  • "originUri": "http://example.com",
  • "occupationType": "localoccupation",
  • "code": "string",
  • "occupationGroupCode": "string",
  • "preferredLabel": "string",
  • "altLabels": [
    ],
  • "definition": "string",
  • "description": "string",
  • "regulatedProfessionNote": "string",
  • "scopeNote": "string",
  • "isLocalized": true,
  • "modelId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Fully replace an occupation by its ID.

Completely replace all mutable fields of an existing occupation in a specific taxonomy model.

Authorizations:
api_keyjwt_auth
path Parameters
modelId
required
string^[0-9a-f]{24}$

The identifier of the model for occupation.

id
required
string

The unique ID of the occupation to replace.

Request Body schema: application/json
One of
UUIDHistory
required
Array of strings [ 0 .. 10000 ] items unique [ items <= 50 characters ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]... ]

The UUIDs history of the occupation.

originUri
required
string <uri> <= 4096 characters \S

The origin URI of the occupation.

occupationType
required
string
Enum: "escooccupation" "localoccupation"

The occupation classification type (e.g., ESCOOccupation or LocalOccupation).

Value: "escooccupation"
code
required
string <= 100 characters ^\d{4}(?:\.\d+)+$

The code of the occupation.

occupationGroupCode
required
string <= 100 characters ^\d{1,4}$

The code of the parent occupation group.

preferredLabel
required
string <= 256 characters \S

The preferred label of the occupation.

altLabels
required
Array of strings [ 0 .. 200 ] items unique [ items <= 256 characters ]

Alternative labels for the occupation.

definition
required
string <= 4000 characters

The formal definition of the occupation.

description
required
string <= 6000 characters

Additional descriptive information about the occupation.

regulatedProfessionNote
required
string <= 4000 characters

Regulatory information for legally regulated professions.

scopeNote
required
string <= 4000 characters

Scope clarification for the occupation's application.

isLocalized
required
boolean

Indicates if the occupation has localized variants. Must be false for LocalOccupation.

modelId
required
string^[0-9a-f]{24}$

The identifier of the model containing this occupation.

Responses

Request samples

Content type
application/json
Example
{
  • "UUIDHistory": [
    ],
  • "originUri": "http://example.com",
  • "occupationType": "escooccupation",
  • "code": "string",
  • "occupationGroupCode": "string",
  • "preferredLabel": "string",
  • "altLabels": [
    ],
  • "definition": "string",
  • "description": "string",
  • "regulatedProfessionNote": "string",
  • "scopeNote": "string",
  • "isLocalized": true,
  • "modelId": "string"
}

Response samples

Content type
application/json
Example
{
  • "id": "string",
  • "UUID": "string",
  • "originUUID": "string",
  • "path": "http://example.com",
  • "tabiyaPath": "http://example.com",
  • "parent": {
    },
  • "children": [
    ],
  • "requiresSkills": [
    ],
  • "UUIDHistory": [
    ],
  • "originUri": "http://example.com",
  • "occupationType": "localoccupation",
  • "code": "string",
  • "occupationGroupCode": "string",
  • "preferredLabel": "string",
  • "altLabels": [
    ],
  • "definition": "string",
  • "description": "string",
  • "regulatedProfessionNote": "string",
  • "scopeNote": "string",
  • "isLocalized": true,
  • "modelId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Get the model history of an occupation in a taxonomy model.

Retrieve the list of taxonomy models the occupation appeared in, based on its UUIDHistory. Each entry is the full model information for a model the occupation was part of. UUIDs in the history that no longer resolve to an existing model are omitted.

Authorizations:
api_keyjwt_auth
path Parameters
modelId
required
string^[0-9a-f]{24}$

The identifier of the model for occupation.

id
required
string

The unique ID of the occupation.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get an occupation's parent in a taxonomy model.

Retrieve the parent of an occupation in a specific taxonomy model.

Authorizations:
api_keyjwt_auth
path Parameters
modelId
required
string^[0-9a-f]{24}$

The identifier of the model for occupation.

id
required
string

The unique ID of the occupation.

Responses

Response samples

Content type
application/json
null

Link an occupation parent.

Establish or update the parent relationship for a specific occupation in a specific taxonomy model.

Authorizations:
api_keyjwt_auth
path Parameters
modelId
required
string^[0-9a-f]{24}$

The identifier of the model for occupation.

id
required
string

The unique ID of the child occupation.

Request Body schema: application/json
id
required
string^[0-9a-f]{24}$
objectType
required
string
Enum: "iscogroup" "localgroup" "escooccupation" "localoccupation"

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "objectType": "iscogroup"
}

Response samples

Content type
application/json
null

Get an occupation's skills in a taxonomy model.

Retrieve the skills associated with an occupation in a specific taxonomy model.

Authorizations:
api_keyjwt_auth
path Parameters
modelId
required
string^[0-9a-f]{24}$

The identifier of the model for occupation.

id
required
string

The unique ID of the occupation.

query Parameters
limit
integer [ 1 .. 100 ]
Default: 10

The maximum number of items to return.

cursor
string <= 1024 characters \S

A base64 string representing the cursor for pagination.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "limit": 10,
  • "nextCursor": "string"
}

Link an occupation skill.

Establish or update a requirement relation between an occupation and a skill in a specific taxonomy model.

Authorizations:
api_keyjwt_auth
path Parameters
modelId
required
string^[0-9a-f]{24}$

The identifier of the model for occupation.

id
required
string

The unique ID of the requiring occupation.

Request Body schema: application/json
requiredSkillId
required
string^[0-9a-f]{24}$
relationType
string
Enum: "" "essential" "optional"
signallingValueLabel
string
Enum: "" "high" "medium" "low"
signallingValue
number or null [ 0 .. 100 ]

Responses

Request samples

Content type
application/json
{
  • "requiredSkillId": "string",
  • "relationType": "",
  • "signallingValueLabel": "",
  • "signallingValue": 100
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "UUID": "string",
  • "originUUID": "string",
  • "path": "http://example.com",
  • "tabiyaPath": "http://example.com",
  • "parents": [
    ],
  • "children": [
    ],
  • "requiresSkills": [
    ],
  • "requiredBySkills": [
    ],
  • "requiredByOccupations": [
    ],
  • "UUIDHistory": [
    ],
  • "originUri": "http://example.com",
  • "preferredLabel": "string",
  • "altLabels": [
    ],
  • "definition": "string",
  • "description": "string",
  • "scopeNote": "string",
  • "skillType": "skill/competence",
  • "reuseLevel": "sector-specific",
  • "isLocalized": true,
  • "modelId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "relationType": "",
  • "signallingValue": 100,
  • "signallingValueLabel": "string"
}

Get a list of paginated occupations and cursor if there is one in a taxonomy model.

Retrieve a list of paginated occupations in a specific taxonomy model.

Authorizations:
api_keyjwt_auth
path Parameters
modelId
required
string^[0-9a-f]{24}$

The identifier of the model for occupation.

query Parameters
limit
integer [ 1 .. 100 ]
Default: 10

The maximum number of items to return.

cursor
string <= 1024 characters \S

A base64 string representing the cursor for pagination.

query
string <= 256 characters

A free-text value to search the occupations by. When set, the endpoint returns the occupations matching the value on the requested searchFields, ranked by relevance. Released models are searched with vector embeddings; unreleased models with a case-insensitive regex.

searchFields
string <= 256 characters ^(preferredLabel|description|altLabels)(,(pre...

A comma-separated list of the occupation fields to search on (e.g. 'preferredLabel,description'). Only meaningful together with query. Defaults to 'preferredLabel'.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "limit": 10,
  • "nextCursor": "string"
}

Create a new taxonomy occupation.

Create a new taxonomy occupation in a specific taxonomy model.

Authorizations:
api_keyjwt_auth
path Parameters
modelId
required
string^[0-9a-f]{24}$

The identifier of the model for occupation.

Request Body schema: application/json
One of
UUIDHistory
required
Array of strings [ 0 .. 10000 ] items unique [ items <= 50 characters ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]... ]

The UUIDs history of the occupation.

originUri
required
string <uri> <= 4096 characters \S

The origin URI of the occupation.

occupationType
required
string
Enum: "escooccupation" "localoccupation"

The occupation classification type (e.g., ESCOOccupation or LocalOccupation).

Value: "escooccupation"
code
required
string <= 100 characters ^\d{4}(?:\.\d+)+$

The code of the occupation.

occupationGroupCode
required
string <= 100 characters ^\d{1,4}$

The code of the parent occupation group.

preferredLabel
required
string <= 256 characters \S

The preferred label of the occupation.

altLabels
required
Array of strings [ 0 .. 200 ] items unique [ items <= 256 characters ]

Alternative labels for the occupation.

definition
required
string <= 4000 characters

The formal definition of the occupation.

description
required
string <= 6000 characters

Additional descriptive information about the occupation.

regulatedProfessionNote
required
string <= 4000 characters

Regulatory information for legally regulated professions.

scopeNote
required
string <= 4000 characters

Scope clarification for the occupation's application.

isLocalized
required
boolean

Indicates if the occupation has localized variants. Must be false for LocalOccupation.

modelId
required
string^[0-9a-f]{24}$

The identifier of the model containing this occupation.

Responses

Request samples

Content type
application/json
Example
{
  • "UUIDHistory": [
    ],
  • "originUri": "http://example.com",
  • "occupationType": "escooccupation",
  • "code": "string",
  • "occupationGroupCode": "string",
  • "preferredLabel": "string",
  • "altLabels": [
    ],
  • "definition": "string",
  • "description": "string",
  • "regulatedProfessionNote": "string",
  • "scopeNote": "string",
  • "isLocalized": true,
  • "modelId": "string"
}

Response samples

Content type
application/json
Example
{
  • "id": "string",
  • "UUID": "string",
  • "originUUID": "string",
  • "path": "http://example.com",
  • "tabiyaPath": "http://example.com",
  • "parent": {
    },
  • "children": [
    ],
  • "requiresSkills": [
    ],
  • "UUIDHistory": [
    ],
  • "originUri": "http://example.com",
  • "occupationType": "localoccupation",
  • "code": "string",
  • "occupationGroupCode": "string",
  • "preferredLabel": "string",
  • "altLabels": [
    ],
  • "definition": "string",
  • "description": "string",
  • "regulatedProfessionNote": "string",
  • "scopeNote": "string",
  • "isLocalized": true,
  • "modelId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

skills

Get a list of skill children.

Retrieve a paginated list of child skills or skill groups for a given skill.

Authorizations:
jwt_auth
path Parameters
modelId
required
string^[0-9a-f]{24}$

The identifier of the model for skill.

id
required
string^[0-9a-f]{24}$

The id of the skill. It can be used to retrieve the skill from the server.

query Parameters
limit
integer [ 1 .. 100 ]
Default: 10

Maximum number of items to return

cursor
string <= 1720 characters \S

Pagination cursor for fetching the next page

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "limit": 10,
  • "nextCursor": "string"
}

Get a skill by its identifier in a taxonomy model.

Retrieve a skill by its unique identifier in a specific taxonomy model.

Authorizations:
jwt_auth
path Parameters
modelId
required
string^[0-9a-f]{24}$

The identifier of the model for skill.

id
required
string^[0-9a-f]{24}$

The id of the skill. It can be used to retrieve the skill from the server.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "UUID": "string",
  • "originUUID": "string",
  • "path": "http://example.com",
  • "tabiyaPath": "http://example.com",
  • "parents": [
    ],
  • "children": [
    ],
  • "requiresSkills": [
    ],
  • "requiredBySkills": [
    ],
  • "requiredByOccupations": [
    ],
  • "UUIDHistory": [
    ],
  • "originUri": "http://example.com",
  • "preferredLabel": "string",
  • "altLabels": [
    ],
  • "definition": "string",
  • "description": "string",
  • "scopeNote": "string",
  • "skillType": "skill/competence",
  • "reuseLevel": "sector-specific",
  • "isLocalized": true,
  • "modelId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Partially update a skill by its ID.

Update one or more fields of an existing skill in a specific taxonomy model. Only provided fields are updated.

Authorizations:
api_keyjwt_auth
path Parameters
modelId
required
string^[0-9a-f]{24}$

The identifier of the model for skill.

id
required
string

The unique ID of the skill to update.

Request Body schema: application/json
UUIDHistory
Array of strings [ 0 .. 10000 ] items unique [ items <= 50 characters ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]... ]

The UUIDs history of the skill.

originUri
string <uri> <= 4096 characters \S

The origin URI of the skill.

preferredLabel
string <= 256 characters \S

The preferred label of the skill.

altLabels
Array of strings [ 0 .. 200 ] items unique [ items <= 256 characters ]

Alternative labels for the skill.

definition
string <= 4000 characters

The formal definition of the skill.

description
string <= 6000 characters

Additional descriptive information about the skill.

scopeNote
string <= 4000 characters

Scope clarification for the skill's application.

skillType
string
Enum: "skill/competence" "knowledge" "language" "attitude"

The type of the skill (e.g., skill/competence, knowledge, language, attitude).

reuseLevel
string
Enum: "sector-specific" "occupation-specific" "cross-sector" "transversal"

The reuse level of the skill (e.g., sector-specific, transversal).

isLocalized
boolean

Indicates if the skill has localized variants.

modelId
string^[0-9a-f]{24}$

The identifier of the model containing this skill.

Responses

Request samples

Content type
application/json
{
  • "UUIDHistory": [
    ],
  • "originUri": "http://example.com",
  • "preferredLabel": "string",
  • "altLabels": [
    ],
  • "definition": "string",
  • "description": "string",
  • "scopeNote": "string",
  • "skillType": "skill/competence",
  • "reuseLevel": "sector-specific",
  • "isLocalized": true,
  • "modelId": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "UUID": "string",
  • "originUUID": "string",
  • "path": "http://example.com",
  • "tabiyaPath": "http://example.com",
  • "parents": [
    ],
  • "children": [
    ],
  • "requiresSkills": [
    ],
  • "requiredBySkills": [
    ],
  • "requiredByOccupations": [
    ],
  • "UUIDHistory": [
    ],
  • "originUri": "http://example.com",
  • "preferredLabel": "string",
  • "altLabels": [
    ],
  • "definition": "string",
  • "description": "string",
  • "scopeNote": "string",
  • "skillType": "skill/competence",
  • "reuseLevel": "sector-specific",
  • "isLocalized": true,
  • "modelId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Fully replace a skill by its ID.

Completely replace all mutable fields of an existing skill in a specific taxonomy model.

Authorizations:
api_keyjwt_auth
path Parameters
modelId
required
string^[0-9a-f]{24}$

The identifier of the model for skill.

id
required
string

The unique ID of the skill to replace.

Request Body schema: application/json
UUIDHistory
required
Array of strings [ 0 .. 10000 ] items unique [ items <= 50 characters ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]... ]

The UUIDs history of the skill.

originUri
required
string <uri> <= 4096 characters \S

The origin URI of the skill.

preferredLabel
required
string <= 256 characters \S

The preferred label of the skill.

altLabels
required
Array of strings [ 0 .. 200 ] items unique [ items <= 256 characters ]

Alternative labels for the skill.

definition
required
string <= 4000 characters

The formal definition of the skill.

description
required
string <= 6000 characters

Additional descriptive information about the skill.

scopeNote
required
string <= 4000 characters

Scope clarification for the skill's application.

skillType
required
string
Enum: "skill/competence" "knowledge" "language" "attitude"

The type of the skill (e.g., skill/competence, knowledge, language, attitude).

reuseLevel
required
string
Enum: "sector-specific" "occupation-specific" "cross-sector" "transversal"

The reuse level of the skill (e.g., sector-specific, transversal).

isLocalized
required
boolean

Indicates if the skill has localized variants.

modelId
required
string^[0-9a-f]{24}$

The identifier of the model containing this skill.

Responses

Request samples

Content type
application/json
{
  • "UUIDHistory": [
    ],
  • "originUri": "http://example.com",
  • "preferredLabel": "string",
  • "altLabels": [
    ],
  • "definition": "string",
  • "description": "string",
  • "scopeNote": "string",
  • "skillType": "skill/competence",
  • "reuseLevel": "sector-specific",
  • "isLocalized": true,
  • "modelId": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "UUID": "string",
  • "originUUID": "string",
  • "path": "http://example.com",
  • "tabiyaPath": "http://example.com",
  • "parents": [
    ],
  • "children": [
    ],
  • "requiresSkills": [
    ],
  • "requiredBySkills": [
    ],
  • "requiredByOccupations": [
    ],
  • "UUIDHistory": [
    ],
  • "originUri": "http://example.com",
  • "preferredLabel": "string",
  • "altLabels": [
    ],
  • "definition": "string",
  • "description": "string",
  • "scopeNote": "string",
  • "skillType": "skill/competence",
  • "reuseLevel": "sector-specific",
  • "isLocalized": true,
  • "modelId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Get the model history of a skill.

Retrieve the list of taxonomy models the skill appeared in, based on its UUIDHistory. Each entry is the full model information for a model the skill was part of. UUIDs in the history that no longer resolve to an existing skill are omitted.

Authorizations:
jwt_auth
path Parameters
modelId
required
string^[0-9a-f]{24}$

The identifier of the model for skill.

id
required
string^[0-9a-f]{24}$

The id of the skill. It can be used to retrieve the skill from the server.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get a list of skill occupations.

Retrieve a paginated list of occupations that require a given skill.

Authorizations:
jwt_auth
path Parameters
modelId
required
string^[0-9a-f]{24}$

The identifier of the model for skill.

id
required
string^[0-9a-f]{24}$

The id of the skill. It can be used to retrieve the skill from the server.

query Parameters
limit
integer [ 1 .. 100 ]
Default: 10

Maximum number of items to return

cursor
string <= 1720 characters \S

Pagination cursor for fetching the next page

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "limit": 10,
  • "nextCursor": "string"
}

Link a skill occupation.

Establish or update a requirement relation between an occupation and a skill in a specific taxonomy model.

Authorizations:
api_keyjwt_auth
path Parameters
modelId
required
string^[0-9a-f]{24}$

The identifier of the model for skill.

id
required
string

The unique ID of the required skill.

Request Body schema: application/json
requiringOccupationId
required
string^[0-9a-f]{24}$
relationType
string
Enum: "" "essential" "optional"
signallingValueLabel
string
Enum: "" "high" "medium" "low"
signallingValue
number or null [ 0 .. 100 ]

Responses

Request samples

Content type
application/json
{
  • "requiringOccupationId": "string",
  • "relationType": "",
  • "signallingValueLabel": "",
  • "signallingValue": 100
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "UUID": "string",
  • "originUUID": "string",
  • "path": "http://example.com",
  • "tabiyaPath": "http://example.com",
  • "parent": {
    },
  • "children": [
    ],
  • "requiresSkills": [
    ],
  • "UUIDHistory": [
    ],
  • "originUri": "http://example.com",
  • "occupationType": "escooccupation",
  • "code": "string",
  • "occupationGroupCode": "string",
  • "preferredLabel": "string",
  • "altLabels": [
    ],
  • "definition": "string",
  • "description": "string",
  • "regulatedProfessionNote": "string",
  • "scopeNote": "string",
  • "isLocalized": true,
  • "modelId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "relationType": "",
  • "signallingValue": 100,
  • "signallingValueLabel": "string"
}

Get a list of skill parents.

Retrieve a paginated list of parent skills or skill groups for a given skill.

Authorizations:
jwt_auth
path Parameters
modelId
required
string^[0-9a-f]{24}$

The identifier of the model for skill.

id
required
string^[0-9a-f]{24}$

The id of the skill. It can be used to retrieve the skill from the server.

query Parameters
limit
integer [ 1 .. 100 ]
Default: 10

Maximum number of items to return

cursor
string <= 1720 characters \S

Pagination cursor for fetching the next page

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "limit": 10,
  • "nextCursor": "string"
}

Link a skill parent.

Establish a parent relationship for a specific skill in a specific taxonomy model.

Authorizations:
api_keyjwt_auth
path Parameters
modelId
required
string^[0-9a-f]{24}$

The identifier of the model for skill.

id
required
string

The unique ID of the child skill.

Request Body schema: application/json
parentId
required
string^[0-9a-f]{24}$
parentType
required
string
Enum: "skillgroup" "skill"

Responses

Request samples

Content type
application/json
{
  • "parentId": "string",
  • "parentType": "skillgroup"
}

Response samples

Content type
application/json
null

Get a list of related skills.

Retrieve a paginated list of related skills for a given skill.

Authorizations:
jwt_auth
path Parameters
modelId
required
string^[0-9a-f]{24}$

The identifier of the model for skill.

id
required
string^[0-9a-f]{24}$

The id of the skill. It can be used to retrieve the skill from the server.

query Parameters
limit
integer [ 1 .. 100 ]
Default: 10

Maximum number of items to return

cursor
string <= 1720 characters \S

Pagination cursor for fetching the next page

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "limit": 10,
  • "nextCursor": "string"
}

Link a related skill.

Establish or update a relation between two skills in a specific taxonomy model.

Authorizations:
api_keyjwt_auth
path Parameters
modelId
required
string^[0-9a-f]{24}$

The identifier of the model for skill.

id
required
string

The unique ID of the requiring skill.

Request Body schema: application/json
requiredSkillId
required
string^[0-9a-f]{24}$
relationType
required
string
Enum: "essential" "optional"

Responses

Request samples

Content type
application/json
{
  • "requiredSkillId": "string",
  • "relationType": "essential"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "UUID": "string",
  • "originUUID": "string",
  • "path": "http://example.com",
  • "tabiyaPath": "http://example.com",
  • "parents": [
    ],
  • "children": [
    ],
  • "requiresSkills": [
    ],
  • "requiredBySkills": [
    ],
  • "requiredByOccupations": [
    ],
  • "UUIDHistory": [
    ],
  • "originUri": "http://example.com",
  • "preferredLabel": "string",
  • "altLabels": [
    ],
  • "definition": "string",
  • "description": "string",
  • "scopeNote": "string",
  • "skillType": "skill/competence",
  • "reuseLevel": "sector-specific",
  • "isLocalized": true,
  • "modelId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "relationType": "essential"
}

Get a paginated list of skills in a taxonomy model.

Retrieve a paginated list of skills in a specific taxonomy model.

Authorizations:
api_keyjwt_auth
path Parameters
modelId
required
string^[0-9a-f]{24}$

The identifier of the model for skill.

query Parameters
limit
integer [ 1 .. 100 ]
Default: 10

The maximum number of items to return.

cursor
string <= 1720 characters \S

A base64 string representing the cursor for pagination.

query
string [ 1 .. 256 ] characters

A free-text value to search the skills by. When set, the endpoint returns the skills matching the value on the requested searchFields, ranked by relevance. Released models are searched with vector embeddings; unreleased models with a case-insensitive regex.

searchFields
string <= 256 characters ^(preferredLabel|description|altLabels)(,(pre...

A comma-separated list of the skill fields to search on (e.g. 'preferredLabel,description'). Only meaningful together with query. Defaults to 'preferredLabel'.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "limit": 10,
  • "nextCursor": "string"
}

Create a new taxonomy skill.

Create a new taxonomy skill in a specific taxonomy model.

Authorizations:
api_keyjwt_auth
path Parameters
modelId
required
string^[0-9a-f]{24}$

The identifier of the model for skill.

Request Body schema: application/json
UUIDHistory
required
Array of strings [ 0 .. 10000 ] items unique [ items <= 50 characters ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]... ]

The UUIDs history of the skill.

originUri
required
string <uri> <= 4096 characters \S

The origin URI of the skill.

preferredLabel
required
string <= 256 characters \S

The preferred label of the skill.

altLabels
required
Array of strings [ 0 .. 200 ] items unique [ items <= 256 characters ]

Alternative labels for the skill.

definition
required
string <= 4000 characters

The formal definition of the skill.

description
required
string <= 6000 characters

Additional descriptive information about the skill.

scopeNote
required
string <= 4000 characters

Scope clarification for the skill's application.

skillType
required
string
Enum: "skill/competence" "knowledge" "language" "attitude"

The type of the skill (e.g., skill/competence, knowledge, language, attitude).

reuseLevel
required
string
Enum: "sector-specific" "occupation-specific" "cross-sector" "transversal"

The reuse level of the skill (e.g., sector-specific, transversal).

isLocalized
required
boolean

Indicates if the skill has localized variants.

modelId
required
string^[0-9a-f]{24}$

The identifier of the model containing this skill.

Responses

Request samples

Content type
application/json
{
  • "UUIDHistory": [
    ],
  • "originUri": "http://example.com",
  • "preferredLabel": "string",
  • "altLabels": [
    ],
  • "definition": "string",
  • "description": "string",
  • "scopeNote": "string",
  • "skillType": "skill/competence",
  • "reuseLevel": "sector-specific",
  • "isLocalized": true,
  • "modelId": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "UUID": "string",
  • "originUUID": "string",
  • "path": "http://example.com",
  • "tabiyaPath": "http://example.com",
  • "parents": [
    ],
  • "children": [
    ],
  • "requiresSkills": [
    ],
  • "requiredBySkills": [
    ],
  • "requiredByOccupations": [
    ],
  • "UUIDHistory": [
    ],
  • "originUri": "http://example.com",
  • "preferredLabel": "string",
  • "altLabels": [
    ],
  • "definition": "string",
  • "description": "string",
  • "scopeNote": "string",
  • "skillType": "skill/competence",
  • "reuseLevel": "sector-specific",
  • "isLocalized": true,
  • "modelId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

skillGroups

Get an skill group's children by its identifier in a taxonomy model.

Retrieve a collection of children for skill group by its unique identifier in a specific taxonomy model.

Authorizations:
api_keyjwt_auth
path Parameters
modelId
required
string^[0-9a-f]{24}$

The identifier of the model for skill group.

id
required
string^[0-9a-f]{24}$

The id of the skill group. It can be used to retrieve the skill group from the server.

query Parameters
limit
integer [ 1 .. 100 ]
Default: 20

Maximum number of items to return

cursor
string <= 1720 characters \S

Pagination cursor for fetching the next page

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "limit": 20,
  • "nextCursor": "string"
}

Get an skill group by its identifier in a taxonomy model.

Retrieve an skill group by its unique identifier in a specific taxonomy model.

Authorizations:
api_keyjwt_auth
path Parameters
modelId
required
string^[0-9a-f]{24}$

The identifier of the model for skill group.

id
required
string^[0-9a-f]{24}$

The id of the skill group. It can be used to retrieve the skill group from the server.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "UUID": "string",
  • "originUUID": "string",
  • "path": "http://example.com",
  • "tabiyaPath": "http://example.com",
  • "parents": [
    ],
  • "children": [
    ],
  • "UUIDHistory": [
    ],
  • "originUri": "http://example.com",
  • "code": "string",
  • "description": "string",
  • "scopeNote": "string",
  • "preferredLabel": "string",
  • "altLabels": [
    ],
  • "modelId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Get the model history of a skill group in a taxonomy model.

Retrieve the list of taxonomy models the skill group appeared in, based on its UUIDHistory. Each entry is the full model information for a model the skill group was part of. UUIDs in the history that no longer resolve to an existing skill group are omitted.

Authorizations:
api_keyjwt_auth
path Parameters
modelId
required
string^[0-9a-f]{24}$

The identifier of the model for skill group.

id
required
string^[0-9a-f]{24}$

The id of the skill group. It can be used to retrieve the skill group from the server.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get an skill group's parents by its identifier in a taxonomy model.

Retrieve a collection of parents for skill group by its unique identifier in a specific taxonomy model.

Authorizations:
api_keyjwt_auth
path Parameters
modelId
required
string^[0-9a-f]{24}$

The identifier of the model for skill group.

id
required
string^[0-9a-f]{24}$

The id of the skill group. It can be used to retrieve the skill group from the server.

query Parameters
limit
integer [ 1 .. 100 ]
Default: 20

Maximum number of items to return

cursor
string <= 1720 characters \S

Pagination cursor for fetching the next page

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "limit": 20,
  • "nextCursor": "string"
}

Link a skill group parent.

Establish or update the parent relationship for a specific skill group in a specific taxonomy model.

Authorizations:
api_keyjwt_auth
path Parameters
modelId
required
string^[0-9a-f]{24}$

The identifier of the model for skill group.

id
required
string

The unique ID of the child skill group.

Request Body schema: application/json
parentId
required
string^[0-9a-f]{24}$
parentType
required
string
Value: "skillgroup"

Responses

Request samples

Content type
application/json
{
  • "parentId": "string",
  • "parentType": "skillgroup"
}

Response samples

Content type
application/json
null

Get a list of paginated skill groups and cursor if there is one in a taxonomy model.

Retrieve a list of paginated skill groups in a specific taxonomy model.

Authorizations:
api_keyjwt_auth
path Parameters
modelId
required
string^[0-9a-f]{24}$

The identifier of the model for skill group.

query Parameters
limit
integer [ 1 .. 100 ]
Default: 20

The maximum number of items to return.

cursor
string <= 1720 characters \S

A base64 string representing the cursor for pagination.

query
string <= 256 characters

A free-text value to search the skill groups by. When set, the endpoint returns the skill groups matching the value on the requested searchFields, ranked by relevance. Released models are searched with vector embeddings; unreleased models with a case-insensitive regex.

searchFields
string <= 256 characters ^(preferredLabel|description|altLabels|scopeN...

A comma-separated list of the skill group fields to search on (e.g. 'preferredLabel,description'). Only meaningful together with query. Defaults to 'preferredLabel'.

childrenIds
string^[0-9a-f]{24}(;[0-9a-f]{24})*$

Semicolon-separated IDs of children used to filter parent skill groups.

childrenType
string
Enum: "skill" "skillgroup"

Type of the children referenced in childrenIds.

root
boolean

Filter only root skill groups (skill groups with no parent).

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "limit": 20,
  • "nextCursor": "string"
}

Create a new taxonomy skill group.

Create a new taxonomy skill group in a specific taxonomy model.

Authorizations:
api_keyjwt_auth
path Parameters
modelId
required
string^[0-9a-f]{24}$

The identifier of the model for skill group.

Request Body schema: application/json
UUIDHistory
required
Array of strings [ 0 .. 10000 ] items unique [ items <= 36 characters ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]... ]

The UUIDs history of the skill group.

originUri
required
string <uri> <= 4096 characters \S

The origin URI of the skill group.

code
required
string <= 256 characters ^([a-zA-Z]\d+(\.\d+)*|[a-zA-Z])$

The code of the skill group.

description
required
string <= 6000 characters

The description of the skill group.

scopeNote
required
string <= 4000 characters

The scope note of the skill group.

preferredLabel
required
string <= 256 characters \S

The preferred label of the skill group.

altLabels
required
Array of strings [ 0 .. 200 ] items unique [ items <= 256 characters ]

The alternative labels of the skill group.

modelId
required
string^[0-9a-f]{24}$

The identifier of the model for skill group.

Responses

Request samples

Content type
application/json
{
  • "UUIDHistory": [
    ],
  • "originUri": "http://example.com",
  • "code": "string",
  • "description": "string",
  • "scopeNote": "string",
  • "preferredLabel": "string",
  • "altLabels": [
    ],
  • "modelId": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "UUID": "string",
  • "originUUID": "string",
  • "path": "http://example.com",
  • "tabiyaPath": "http://example.com",
  • "parents": [
    ],
  • "children": [
    ],
  • "UUIDHistory": [
    ],
  • "originUri": "http://example.com",
  • "code": "string",
  • "description": "string",
  • "scopeNote": "string",
  • "preferredLabel": "string",
  • "altLabels": [
    ],
  • "modelId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

export

Trigger the export process.

Asynchronously trigger the export process for a given model.

Authorizations:
api_keyjwt_auth
Request Body schema: application/json
modelId
required
string^[0-9a-f]{24}$

The identifier of the model to be exported.

Responses

Request samples

Content type
application/json
{
  • "modelId": "string"
}

Response samples

Content type
application/json
{
  • "errorCode": "MALFORMED_BODY",
  • "message": "string",
  • "details": "string"
}

import

Trigger the import process.

Asynchronously trigger the import process for a given model.

Authorizations:
api_keyjwt_auth
Request Body schema: application/json
modelId
required
string^[0-9a-f]{24}$

The identifier of the model for importing the files to.

required
object or object or object or object or object or object or object or object

A key value map of the files to import. The key represents the type of the file, and the value the path to the file. The path is relative to the root of the upload bucket and starts with the folder name that the presigned url was generated for.

isOriginalESCOModel
required
boolean

Flag indicating if the model is an original ESCO model.

Responses

Request samples

Content type
application/json
{
  • "modelId": "string",
  • "filePaths": {
    },
  • "isOriginalESCOModel": true
}

Response samples

Content type
application/json
{
  • "errorCode": "MALFORMED_BODY",
  • "message": "string",
  • "details": "string"
}

Get a presigned url that can be used to upload files to the import.

Returns a presigned url that can be used to upload files to the import. There url expires after 1 hour. The maximum file size is 10 MB.

Authorizations:
api_keyjwt_auth

Responses

Response samples

Content type
application/json
{
  • "url": "http://example.com",
  • "fields": [
    ],
  • "folder": "string"
}

model

Release a taxonomy model.

Release a taxonomy model. Once released, the model's ESCO entities become read-only and the model becomes visible to all users, not just model managers. This endpoint can only be used to release a model; it cannot be used to un-release one or to edit any other model field.

Authorizations:
api_keyjwt_auth
path Parameters
modelId
required
string
Request Body schema: application/json
released
required
boolean

Releases the model. This endpoint can only be used to release a model (set it to true); it cannot be used to un-release one.

Value: true
releaseNotes
string <= 100000 characters

The release notes to record for this release of the model.

Responses

Request samples

Content type
application/json
{
  • "released": true,
  • "releaseNotes": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "UUID": "string",
  • "path": "http://example.com",
  • "tabiyaPath": "http://example.com",
  • "released": true,
  • "releaseNotes": "string",
  • "version": "string",
  • "exportProcessState": [
    ],
  • "importProcessState": {
    },
  • "embeddingProcessState": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "description": "string",
  • "license": "string",
  • "locale": {
    },
  • "UUIDHistory": [
    ],
  • "modelHistory": [
    ]
}

Trigger the generation of the embeddings of a model.

Asynchronously trigger the generation of the embeddings for all the entities of a released model. The entities are pushed to the embeddings queue and processed in the background.

Authorizations:
api_keyjwt_auth
path Parameters
modelId
required
string
Request Body schema: application/json
embeddingServiceId
required
string
Value: "77bb8ff3-a6b0-460b-bcaa-00631a907852"

The identifier of the embedding model to use for generating the embeddings of the model.

Responses

Request samples

Content type
application/json
{
  • "embeddingServiceId": "77bb8ff3-a6b0-460b-bcaa-00631a907852"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "status": "pending",
  • "embeddingServiceId": "77bb8ff3-a6b0-460b-bcaa-00631a907852",
  • "totalDocuments": 0,
  • "errorCounts": 0,
  • "warningCounts": 0,
  • "completedDocuments": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "modelId": "string"
}

Create a new taxonomy model.

Create a new taxonomy model that can be used to import data into it.

Authorizations:
api_keyjwt_auth
Request Body schema: application/json
name
required
string <= 256 characters \S

The name of the model

description
required
string <= 6000 characters

The description of the model

license
required
string <= 100000 characters

The license of the model

required
object (LocaleSchema)
UUIDHistory
required
Array of strings >= 0 items

The UUIDs history of the model.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "license": "string",
  • "locale": {
    },
  • "UUIDHistory": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "UUID": "string",
  • "path": "http://example.com",
  • "tabiyaPath": "http://example.com",
  • "released": true,
  • "releaseNotes": "string",
  • "version": "string",
  • "exportProcessState": [
    ],
  • "importProcessState": {
    },
  • "embeddingProcessState": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "description": "string",
  • "license": "string",
  • "locale": {
    },
  • "UUIDHistory": [
    ],
  • "modelHistory": [
    ]
}

Get a taxonomy model information

Retrieve information about a specific taxonomy model.

Authorizations:
api_keyjwt_auth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

embeddings

Trigger the generation of the embeddings of a model.

Asynchronously trigger the generation of the embeddings for all the entities of a released model. The entities are pushed to the embeddings queue and processed in the background.

Authorizations:
api_keyjwt_auth
path Parameters
modelId
required
string
Request Body schema: application/json
embeddingServiceId
required
string
Value: "77bb8ff3-a6b0-460b-bcaa-00631a907852"

The identifier of the embedding model to use for generating the embeddings of the model.

Responses

Request samples

Content type
application/json
{
  • "embeddingServiceId": "77bb8ff3-a6b0-460b-bcaa-00631a907852"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "status": "pending",
  • "embeddingServiceId": "77bb8ff3-a6b0-460b-bcaa-00631a907852",
  • "totalDocuments": 0,
  • "errorCounts": 0,
  • "warningCounts": 0,
  • "completedDocuments": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "modelId": "string"
}