API docs by Redocly

Taxonomy Model API (v0.0.119 build:4504 sha:d9aab1899d38328edd4a8d46b661c8ed48298b41)

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

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 .. 100 ] 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"
}

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.

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 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"
}

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"
}

occupations

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 .. 100 ] 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 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.

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"
}

Get the parent occupation of a specific occupation.

Retrieve the parent occupation of a specific occupation in a 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

Get the children of an occupation.

Retrieve the direct children of a specific occupation in a 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^[0-9a-f]{24}$

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

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 the skills of an occupation.

Retrieve the skills required by a specific occupation in a 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^[0-9a-f]{24}$

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

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"
}

skills

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

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

Authorizations:
jwt_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.

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"
}

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"
}

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 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"
}

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"
}

skillGroups

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.

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 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"
}

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"
}

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

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": {
    },
  • "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
[
  • {
    }
]