Skill Engine API (1.0.9)

Download OpenAPI specification:Download

The Skill Engine API is your single stop for continuous skill tracking, matching, learning management and strategic insights. This API specification describes how to augment your existing data sources with skills to build your workforce of tomorrow.

CRUD

List Employees

Get a list of all Employee ids available in the system. This can for example be used to keep track of proper synchronisation between your system and the Skill Engine API.

Authorizations:
application (read)

Responses

Response samples

Content type
application/json
[
  • "5cbdbdbe-5f44-4423-8157-520f8a2f429a",
  • "62d2c013-ab77-410e-b5fb-2f96eed9c1db",
  • "6129e3f1-663f-44ea-aa3f-2ce1077b834c"
]

Create Employee

Submit new Employee information to initialise their Skill Profile inside the Skill Engine API.

Authorizations:
application (write)
Request Body schema: application/json
external_id
required
string <uuid> (UUID) non-empty [a-zA-Z0-9_-]+

The unique ID in your system, consisting of alphanumeric characters, hyphens and underscores.

object (Location)

A geographic location, expressed in latitude and longitude. This can represent a home address, an office location... Each entity is limited to having a single location. To get the latitude and longitude for a given address, you can use the Google Maps Geocoding API or a predefined lookup table (for example by zip code).

Array of objects (WorkExperience)
Array of objects (Education)
required
Array of objects (Language)

List of ISO 639-1 codes for languages spoken by the Employee, combined with the proficiency level. The proficiency levels go from 1 (elementary proficiency) to 5 (native proficiency). If the level is omitted, the default proficiency level of 2 is used. If you want to leave this field empty, make sure to submit an empty list. This field can be filled automatically based on the resume (when present).

desired_functions
Array of strings

List of desired function titles of the Employee.

Array of objects (Certificate)

List of obtained certificates by the Employee, combined with an expiry date. If the expiry date is omitted, it is assumed that the certificate never expires.

assigned_position
string (AssignedPosition) [ 1 .. 255 ] characters

Job title of the Employee's assigned position.

object

Base64 encoded CV of the Employee in PDF (.pdf), Word (.doc or .docx) or plain-text (.txt) format.

Responses

Request samples

Content type
application/json
{
  • "external_id": "a3903505-eb84-42dc-a79f-5e7b1fe897b7",
  • "location": {
    },
  • "working_history": [
    ],
  • "education_history": [
    ],
  • "languages": [
    ],
  • "desired_functions": [
    ],
  • "certificates": [
    ],
  • "assigned_position": "Python Developer",
  • "employee_resume": {
    }
}

Response samples

Content type
application/json
Example
{
  • "title": "400 Bad Request",
  • "description": "The request body was not structured correctly."
}

Get Employee

Get the Employee information stored inside the system. As resumes are not stored inside our system, they are not returned in this call.

Authorizations:
application (read)
path Parameters
external_id
required
string <uuid> (UUID) non-empty [a-zA-Z0-9_-]+
Example: a3903505-eb84-42dc-a79f-5e7b1fe897b7

The unique ID in your system, consisting of alphanumeric characters, hyphens and underscores.

query Parameters
include
Array of strings
Items Value: "custom_properties"
Example: include=custom_properties

Additional entity attributes that will be included in the response body. This query parameter can be added multiple times to include more attributes.

Responses

Response samples

Content type
application/json
Example
{
  • "external_id": "a3903505-eb84-42dc-a79f-5e7b1fe897b7",
  • "location": {
    },
  • "working_history": [
    ],
  • "education_history": [
    ],
  • "languages": [
    ],
  • "desired_functions": [
    ],
  • "certificates": [
    ],
  • "assigned_position": "Python Developer"
}

Update Employee

Submit the most up to date Employee information to update their profile inside the system. Any field that is present will overwrite existing values within the system, while absent fields will be left as-is. Since the Employee resume is deleted after creating a skill profile, it is a required field for recalculating the skill profile based on the resume. If no resume is provided, the skill profile will be recalculated based on the other available properties.

Authorizations:
application (write)
path Parameters
external_id
required
string <uuid> (UUID) non-empty [a-zA-Z0-9_-]+
Example: a3903505-eb84-42dc-a79f-5e7b1fe897b7

The unique ID in your system, consisting of alphanumeric characters, hyphens and underscores.

Request Body schema: application/json
object (Location)

A geographic location, expressed in latitude and longitude. This can represent a home address, an office location... Each entity is limited to having a single location. To get the latitude and longitude for a given address, you can use the Google Maps Geocoding API or a predefined lookup table (for example by zip code).

Array of objects (WorkExperience)
Array of objects (Education)
required
Array of objects (Language)

List of ISO 639-1 codes for languages spoken by the Employee, combined with the proficiency level. The proficiency levels go from 1 (elementary proficiency) to 5 (native proficiency). If the level is omitted, the default proficiency level of 2 is used. If you want to leave this field empty, make sure to submit an empty list. This field can be filled automatically based on the resume (when present).

desired_functions
Array of strings

List of desired function titles of the Employee.

Array of objects (Certificate)

List of obtained certificates by the Employee, combined with an expiry date. If the expiry date is omitted, it is assumed that the certificate never expires.

assigned_position
string (AssignedPosition) [ 1 .. 255 ] characters

Job title of the Employee's assigned position.

object

Base64 encoded CV of the Employee in PDF (.pdf), Word (.doc or .docx) or plain-text (.txt) format.

Responses

Request samples

Content type
application/json
{
  • "location": {
    },
  • "working_history": [
    ],
  • "education_history": [
    ],
  • "languages": [
    ],
  • "desired_functions": [
    ],
  • "certificates": [
    ],
  • "assigned_position": "Python Developer",
  • "employee_resume": {
    }
}

Response samples

Content type
application/json
{
  • "title": "400 Bad Request",
  • "description": "The request body was not structured correctly."
}

Delete Employee

Remove an Employee from the system. This step deletes all information linked exclusively to this Employee, while leaving other (potentially linked) entities such as documents authored by the user. If these need to be removed as well, make sure to do this separately. By deleting an Employee, you delete their skill profile history, which cannot be recreated or recovered afterwards.

Authorizations:
application (write)
path Parameters
external_id
required
string <uuid> (UUID) non-empty [a-zA-Z0-9_-]+
Example: a3903505-eb84-42dc-a79f-5e7b1fe897b7

The unique ID in your system, consisting of alphanumeric characters, hyphens and underscores.

Responses

Response samples

Content type
application/json
{
  • "title": "401 Unauthorized",
  • "description": "OAuth access token is missing, invalid or expired."
}

Get all Custom Property Definitions

Get a list of all the Custom Property Definitions stored inside the system.

Authorizations:
application (read)

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Create a Custom Property Definition

Create a new Custom Property Definition in the system.

Authorizations:
application (write)
Request Body schema: application/json
property_name
required
string non-empty

The name of the custom property.

property_type
required
string non-empty
Enum: "text" "number" "boolean"

Expected type of the custom property.

Responses

Request samples

Content type
application/json
{
  • "property_name": "sector",
  • "property_type": "text"
}

Response samples

Content type
application/json
{
  • "title": "400 Bad Request",
  • "description": "The request body was not structured correctly."
}

Get Custom Property Definition

Get the Custom Property Definition information stored inside the system.

Authorizations:
application (read)
path Parameters
property_name
required
string non-empty
Example: sector

Responses

Response samples

Content type
application/json
{
  • "property_name": "sector",
  • "property_type": "text"
}

Rename a Custom Property Definition

Rename a Custom Property Definition.

Authorizations:
application (write)
path Parameters
property_name
required
string non-empty
Example: sector
Request Body schema: application/json
property_name
required
string non-empty

The name of the custom property.

Responses

Request samples

Content type
application/json
{
  • "property_name": "sector"
}

Response samples

Content type
application/json
{
  • "title": "400 Bad Request",
  • "description": "The request body was not structured correctly."
}

Remove a Custom Property Definition from the system

Remove a Custom Property Definition from the system.

Authorizations:
application (write)
path Parameters
property_name
required
string non-empty
Example: sector

Responses

Response samples

Content type
application/json
{
  • "title": "401 Unauthorized",
  • "description": "OAuth access token is missing, invalid or expired."
}

Retrieve all custom Employee properties

Fetch all Employee properties from the system (if any exists, otherwise an empty list is returned).

Authorizations:
application (read)
path Parameters
external_id
required
string <uuid> (UUID) non-empty [a-zA-Z0-9_-]+
Example: a3903505-eb84-42dc-a79f-5e7b1fe897b7

The unique ID in your system, consisting of alphanumeric characters, hyphens and underscores.

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    }
]

Replace custom Employee properties

In addition to the default fields available for each Employee, a set of custom properties can be added. Each Employee is allowed to have a maximum of 100 properties, with properties being numbers or strings (maximum length 1000 characters).

Authorizations:
application (write)
path Parameters
external_id
required
string <uuid> (UUID) non-empty [a-zA-Z0-9_-]+
Example: a3903505-eb84-42dc-a79f-5e7b1fe897b7

The unique ID in your system, consisting of alphanumeric characters, hyphens and underscores.

Request Body schema: application/json
Array ([ 1 .. 100 ] items)
property_name
string non-empty
object

Responses

Request samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    }
]

Response samples

Content type
application/json
Example
{
  • "title": "400 Bad Request",
  • "description": "The request body was not structured correctly."
}

Update custom Employee properties

In addition to the default fields available for each Employee, a set of custom properties can be added. Each Employee is allowed to have a maximum of 100 properties, with properties being numbers or strings (maximum length 1000 characters).

Authorizations:
application (write)
path Parameters
external_id
required
string <uuid> (UUID) non-empty [a-zA-Z0-9_-]+
Example: a3903505-eb84-42dc-a79f-5e7b1fe897b7

The unique ID in your system, consisting of alphanumeric characters, hyphens and underscores.

Request Body schema: application/json
Array ([ 1 .. 100 ] items)
property_name
string non-empty
object

Responses

Request samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    }
]

Response samples

Content type
application/json
Example
{
  • "title": "400 Bad Request",
  • "description": "The request body was not structured correctly."
}

Delete all custom Employee properties

Drop all Employee properties from the system (if any exists).

Authorizations:
application (write)
path Parameters
external_id
required
string <uuid> (UUID) non-empty [a-zA-Z0-9_-]+
Example: a3903505-eb84-42dc-a79f-5e7b1fe897b7

The unique ID in your system, consisting of alphanumeric characters, hyphens and underscores.

Responses

Response samples

Content type
application/json
{
  • "title": "401 Unauthorized",
  • "description": "OAuth access token is missing, invalid or expired."
}

Skill Profile

Get the skill profile for an Employee

Get an export of the Employee skill profile to leverage it for user interaction. Check our tutorials for a clear overview of how to get the most out of each format!

Authorizations:
application (read)
path Parameters
external_id
required
string <uuid> (UUID) non-empty [a-zA-Z0-9_-]+
Example: a3903505-eb84-42dc-a79f-5e7b1fe897b7

The unique ID in your system, consisting of alphanumeric characters, hyphens and underscores.

query Parameters
response_format
string
Default: "list"
Enum: "list" "trending" "competencies"
Example: response_format=list

The format in which the skill profile needs to be returned. List returns the skills, trending indicates per skill if it is trending and competencies return the skill profile in your own Competencies. More info about adding your Competencies can be found in the tutorials.

Responses

Response samples

Content type
application/json
Example
{
  • "external_id": "a3903505-eb84-42dc-a79f-5e7b1fe897b7",
  • "skills": [
    ]
}

Update an Employee skill profile with feedback

Provide feedback about an existing Employee skill profile to update it inside the system. The body of the feedback message replaces the existing skill profile, so if a skill is not present in the body or has weight 0, it will be removed. The feedback can contain updates (e.g. score changes or skills added through related skills / skill search) and removals. The feedback_format query parameter indicates the format in which the feedback is given (currently skills and competencies). Typically used to process insights gained from end users through a front-end application.

Authorizations:
application (write)
path Parameters
external_id
required
string <uuid> (UUID) non-empty [a-zA-Z0-9_-]+
Example: a3903505-eb84-42dc-a79f-5e7b1fe897b7

The unique ID in your system, consisting of alphanumeric characters, hyphens and underscores.

query Parameters
feedback_format
string
Default: "skills"
Enum: "skills" "competencies"
Example: feedback_format=skills

The format in which feedback for the skill profile is given.

Request Body schema: application/json
One of
Array of objects (SkillWithScoreArray)

The skills contained in this profile, along with their scores.

Responses

Request samples

Content type
application/json
Example
{
  • "skills": [
    ]
}

Response samples

Content type
application/json
{
  • "title": "400 Bad Request",
  • "description": "The request body was not structured correctly."
}

Metrics

Get the employability metric

Retrieve the employability for this Employee. Employability is an indication of the extent to which an Employee fits the open Vacancies within your company. It is reported as a number between 0 and 1, with the upper end indicating that an Employee has many matching opportunities, while a lower score indicates fewer opportunities (or only lower-quality matches) are available.

Authorizations:
application (read)
path Parameters
external_id
required
string <uuid> (UUID) non-empty [a-zA-Z0-9_-]+
Example: a3903505-eb84-42dc-a79f-5e7b1fe897b7

Unique external ID linked to this Employee, consisting of alphanumeric characters, hyphens and underscores.

Responses

Response samples

Content type
application/json
{
  • "entity_type": "Employee",
  • "entity_id": "a3903505-eb84-42dc-a79f-5e7b1fe897b7",
  • "metric_name": "employability",
  • "metric_value": 0.8,
  • "last_update": "2020-09-01T11:45:49Z"
}

Get Employee count

Get the total number of Employee objects stored inside the system.

Authorizations:
application (read)

Responses

Response samples

Content type
application/json
{
  • "entity_type": "Employee",
  • "entity_id": "a3903505-eb84-42dc-a79f-5e7b1fe897b7",
  • "metric_name": "count",
  • "metric_value": 1000,
  • "last_update": "2020-09-01T11:45:49Z"
}

Get the position alignment metric

Retrieve the position alignment for this Employee. Position alignment is an indication of the extent to which an Employee fits their assigned position within your company. It is reported as a number between 0 and 1, with the upper end indicating that an Employee is a good fit for their assigned position, while a lower score indicates that the employee may have some missing skills.

Authorizations:
application (read)
path Parameters
external_id
required
string <uuid> (UUID) non-empty [a-zA-Z0-9_-]+
Example: a3903505-eb84-42dc-a79f-5e7b1fe897b7

Unique external ID linked to this Employee, consisting of alphanumeric characters, hyphens and underscores.

query Parameters
response_format
string
Default: "simple"
Enum: "simple" "explained"
Example: response_format=simple

The format in which the position alignment metric needs to be returned. The simple response format only returns the position alignment score. While the explained response format also returns relevant experience and skills.

Responses

Response samples

Content type
application/json
Example
{
  • "entity_type": "Employee",
  • "entity_id": "a3903505-eb84-42dc-a79f-5e7b1fe897b7",
  • "metric_name": "position_alignment",
  • "metric_value": 0.8,
  • "last_update": "2020-09-01T11:45:49Z"
}

CRUD

List Vacancies

Get a list of all Vacancy ids available in the system. This can for example be used to keep track of proper synchronisation between your system and the Skill Engine API.

Authorizations:
application (read)

Responses

Response samples

Content type
application/json
[
  • "5cbdbdbe-5f44-4423-8157-520f8a2f429a",
  • "62d2c013-ab77-410e-b5fb-2f96eed9c1db",
  • "6129e3f1-663f-44ea-aa3f-2ce1077b834c"
]

Create Vacancy

Submit new Vacancy information to initialise their Skill Profile inside the Skill Engine API.

Authorizations:
application (write)
Request Body schema: application/json
external_id
required
string <uuid> (UUID) non-empty [a-zA-Z0-9_-]+

The unique ID in your system, consisting of alphanumeric characters, hyphens and underscores.

job_title
required
string non-empty

Title of the Job.

job_description
required
string non-empty

Textual description of the Job (job posting).

object (Location)

A geographic location, expressed in latitude and longitude. This can represent a home address, an office location... Each entity is limited to having a single location. To get the latitude and longitude for a given address, you can use the Google Maps Geocoding API or a predefined lookup table (for example by zip code).

Responses

Request samples

Content type
application/json
{
  • "external_id": "a3903505-eb84-42dc-a79f-5e7b1fe897b7",
  • "job_title": "Software engineer",
  • "job_description": "We are looking for a software engineer with great communication skills in Ghent. Experience in front-end development, git, agile working is a plus.",
  • "location": {
    }
}

Response samples

Content type
application/json
Example
{
  • "title": "400 Bad Request",
  • "description": "The request body was not structured correctly."
}

Get Vacancy

Get the Vacancy information stored inside the system.

Authorizations:
application (read)
path Parameters
external_id
required
string <uuid> (UUID) non-empty [a-zA-Z0-9_-]+
Example: a3903505-eb84-42dc-a79f-5e7b1fe897b7

The unique ID in your system, consisting of alphanumeric characters, hyphens and underscores.

query Parameters
include
Array of strings
Items Value: "custom_properties"
Example: include=custom_properties

Additional entity attributes that will be included in the response body. This query parameter can be added multiple times to include more attributes.

Responses

Response samples

Content type
application/json
Example
{
  • "external_id": "a3903505-eb84-42dc-a79f-5e7b1fe897b7",
  • "job_title": "Software engineer",
  • "job_description": "We are looking for a software engineer with great communication skills in Ghent. Experience in front-end development, git, agile working is a plus.",
  • "location": {
    }
}

Update Vacancy

Submit the most up to date Vacancy information to update their profile inside the system. Any field that is present will overwrite existing values within the system, while absent fields will be left as-is.

Authorizations:
application (write)
path Parameters
external_id
required
string <uuid> (UUID) non-empty [a-zA-Z0-9_-]+
Example: a3903505-eb84-42dc-a79f-5e7b1fe897b7

The unique ID in your system, consisting of alphanumeric characters, hyphens and underscores.

Request Body schema: application/json
job_title
string non-empty

Title of the Job.

job_description
string non-empty

Textual description of the Job (job posting).

object (Location)

A geographic location, expressed in latitude and longitude. This can represent a home address, an office location... Each entity is limited to having a single location. To get the latitude and longitude for a given address, you can use the Google Maps Geocoding API or a predefined lookup table (for example by zip code).

Responses

Request samples

Content type
application/json
{
  • "job_title": "Software engineer",
  • "job_description": "We are looking for a software engineer with great communication skills in Ghent. Experience in front-end development, git, agile working is a plus.",
  • "location": {
    }
}

Response samples

Content type
application/json
{
  • "title": "400 Bad Request",
  • "description": "The request body was not structured correctly."
}

Delete Vacancy

Remove a Vacancy from the system. This step deletes all information linked exclusively to this Vacancy, while leaving other (potentially linked) entities such as documents authored by the user. If these need to be removed as well, make sure to do this separately. By deleting a Vacancy, you delete their skill profile history, which cannot be recreated or recovered afterwards.

Authorizations:
application (write)
path Parameters
external_id
required
string <uuid> (UUID) non-empty [a-zA-Z0-9_-]+
Example: a3903505-eb84-42dc-a79f-5e7b1fe897b7

The unique ID in your system, consisting of alphanumeric characters, hyphens and underscores.

Responses

Response samples

Content type
application/json
{
  • "title": "401 Unauthorized",
  • "description": "OAuth access token is missing, invalid or expired."
}

Get all Custom Property Definitions

Get a list of all the Custom Property Definitions stored inside the system.

Authorizations:
application (read)

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Create a Custom Property Definition

Create a new Custom Property Definition in the system.

Authorizations:
application (write)
Request Body schema: application/json
property_name
required
string non-empty

The name of the custom property.

property_type
required
string non-empty
Enum: "text" "number" "boolean"

Expected type of the custom property.

Responses

Request samples

Content type
application/json
{
  • "property_name": "sector",
  • "property_type": "text"
}

Response samples

Content type
application/json
{
  • "title": "400 Bad Request",
  • "description": "The request body was not structured correctly."
}

Get Custom Property Definition

Get the Custom Property Definition information stored inside the system.

Authorizations:
application (read)
path Parameters
property_name
required
string non-empty
Example: sector

Responses

Response samples

Content type
application/json
{
  • "property_name": "sector",
  • "property_type": "text"
}

Rename a Custom Property Definition

Rename a Custom Property Definition.

Authorizations:
application (write)
path Parameters
property_name
required
string non-empty
Example: sector
Request Body schema: application/json
property_name
required
string non-empty

The name of the custom property.

Responses

Request samples

Content type
application/json
{
  • "property_name": "sector"
}

Response samples

Content type
application/json
{
  • "title": "400 Bad Request",
  • "description": "The request body was not structured correctly."
}

Remove a Custom Property Definition from the system

Remove a Custom Property Definition from the system.

Authorizations:
application (write)
path Parameters
property_name
required
string non-empty
Example: sector

Responses

Response samples

Content type
application/json
{
  • "title": "401 Unauthorized",
  • "description": "OAuth access token is missing, invalid or expired."
}

Retrieve all custom Vacancy properties

Fetch all Vacancy properties from the system (if any exists, otherwise an empty list is returned).

Authorizations:
application (read)
path Parameters
external_id
required
string <uuid> (UUID) non-empty [a-zA-Z0-9_-]+
Example: a3903505-eb84-42dc-a79f-5e7b1fe897b7

The unique ID in your system, consisting of alphanumeric characters, hyphens and underscores.

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    }
]

Replace custom Vacancy properties

In addition to the default fields available for each Vacancy, a set of custom properties can be added. Each Vacancy is allowed to have a maximum of 100 properties, with properties being numbers or strings (maximum length 1000 characters).

Authorizations:
application (write)
path Parameters
external_id
required
string <uuid> (UUID) non-empty [a-zA-Z0-9_-]+
Example: a3903505-eb84-42dc-a79f-5e7b1fe897b7

The unique ID in your system, consisting of alphanumeric characters, hyphens and underscores.

Request Body schema: application/json
Array ([ 1 .. 100 ] items)
property_name
string non-empty
object

Responses

Request samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    }
]

Response samples

Content type
application/json
Example
{
  • "title": "400 Bad Request",
  • "description": "The request body was not structured correctly."
}

Update custom Vacancy properties

In addition to the default fields available for each Vacancy, a set of custom properties can be added. Each Vacancy is allowed to have a maximum of 100 properties, with properties being numbers or strings (maximum length 1000 characters).

Authorizations:
application (write)
path Parameters
external_id
required
string <uuid> (UUID) non-empty [a-zA-Z0-9_-]+
Example: a3903505-eb84-42dc-a79f-5e7b1fe897b7

The unique ID in your system, consisting of alphanumeric characters, hyphens and underscores.

Request Body schema: application/json
Array ([ 1 .. 100 ] items)
property_name
string non-empty
object

Responses

Request samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    }
]

Response samples

Content type
application/json
Example
{
  • "title": "400 Bad Request",
  • "description": "The request body was not structured correctly."
}

Delete all custom Vacancy properties

Drop all Vacancy properties from the system (if any exists).

Authorizations:
application (write)
path Parameters
external_id
required
string <uuid> (UUID) non-empty [a-zA-Z0-9_-]+
Example: a3903505-eb84-42dc-a79f-5e7b1fe897b7

The unique ID in your system, consisting of alphanumeric characters, hyphens and underscores.

Responses

Response samples

Content type
application/json
{
  • "title": "401 Unauthorized",
  • "description": "OAuth access token is missing, invalid or expired."
}

Skill Profile

Get the skill profile for a Vacancy

Get an export of the Vacancy skill profile to leverage it for user interaction. Check our tutorials for a clear overview of how to get the most out of each format!

Authorizations:
application (read)
path Parameters
external_id
required
string <uuid> (UUID) non-empty [a-zA-Z0-9_-]+
Example: a3903505-eb84-42dc-a79f-5e7b1fe897b7

The unique ID in your system, consisting of alphanumeric characters, hyphens and underscores.

query Parameters
response_format
string
Default: "list"
Enum: "list" "trending" "competencies"
Example: response_format=list

The format in which the skill profile needs to be returned. List returns the skills, trending indicates per skill if it is trending and competencies return the skill profile in your own Competencies. More info about adding your Competencies can be found in the tutorials.

Responses

Response samples

Content type
application/json
Example
{
  • "external_id": "a3903505-eb84-42dc-a79f-5e7b1fe897b7",
  • "skills": [
    ]
}

Update a Vacancy skill profile with feedback

Provide feedback about an existing Vacancy skill profile to update it inside the system. The body of the feedback message replaces the existing skill profile, so if a skill is not present in the body or has weight 0, it will be removed. The feedback can contain updates (e.g. score changes or skills added through related skills / skill search) and removals. The feedback_format query parameter indicates the format in which the feedback is given (currently skills and competencies). Typically used to process insights gained from end users through a front-end application.

Authorizations:
application (write)
path Parameters
external_id
required
string <uuid> (UUID) non-empty [a-zA-Z0-9_-]+
Example: a3903505-eb84-42dc-a79f-5e7b1fe897b7

The unique ID in your system, consisting of alphanumeric characters, hyphens and underscores.

query Parameters
feedback_format
string
Default: "skills"
Enum: "skills" "competencies"
Example: feedback_format=skills

The format in which feedback for the skill profile is given.

Request Body schema: application/json
One of
Array of objects (SkillWithScoreArray)

The skills contained in this profile, along with their scores.

Responses

Request samples

Content type
application/json
Example
{
  • "skills": [
    ]
}

Response samples

Content type
application/json
{
  • "title": "400 Bad Request",
  • "description": "The request body was not structured correctly."
}

Metrics

Get Vacancy count

Get the total number of Vacancy objects stored inside the system.

Authorizations:
application (read)

Responses

Response samples

Content type
application/json
{
  • "entity_type": "Vacancy",
  • "entity_id": "a3903505-eb84-42dc-a79f-5e7b1fe897b7",
  • "metric_name": "count",
  • "metric_value": 1000,
  • "last_update": "2020-09-01T11:45:49Z"
}

CRUD

List Courses

Get a list of all Course ids available in the system. This can for example be used to keep track of proper synchronisation between your system and the Skill Engine API.

Authorizations:
application (read)

Responses

Response samples

Content type
application/json
[
  • "5cbdbdbe-5f44-4423-8157-520f8a2f429a",
  • "62d2c013-ab77-410e-b5fb-2f96eed9c1db",
  • "6129e3f1-663f-44ea-aa3f-2ce1077b834c"
]

Create Course

Submit new Course information to initialise its Skill Profile inside the Skill Engine API.

Authorizations:
application (write)
Request Body schema: application/json
external_id
required
string <uuid> (UUID) non-empty [a-zA-Z0-9_-]+

The unique ID in your system, consisting of alphanumeric characters, hyphens and underscores.

course_title
required
string non-empty

Title of the Course.

course_description
required
string non-empty

Textual description of the Course.

Responses

Request samples

Content type
application/json
{
  • "external_id": "a3903505-eb84-42dc-a79f-5e7b1fe897b7",
  • "course_title": "Computer Science 101",
  • "course_description": "This Professional Certificate will start you at the absolute beginning teaching you about the fundamental binary language of modern computers. You’ll learn about the Turing Machine—a model for the digital computer. You’ll also learn the basics of analytic logic and how learning and applying basic principles of logic can help you both work with and work on technical solutions. You’ll work in a managed environment and learn to code your very first program in Python – a powerful but simple programming language used by app developers and data scientists."
}

Response samples

Content type
application/json
Example
{
  • "title": "400 Bad Request",
  • "description": "The request body was not structured correctly."
}

Get Course

Get the Course information stored inside the system.

Authorizations:
application (read)
path Parameters
external_id
required
string <uuid> (UUID) non-empty [a-zA-Z0-9_-]+
Example: a3903505-eb84-42dc-a79f-5e7b1fe897b7

The unique ID in your system, consisting of alphanumeric characters, hyphens and underscores.

query Parameters
include
Array of strings
Items Value: "custom_properties"
Example: include=custom_properties

Additional entity attributes that will be included in the response body. This query parameter can be added multiple times to include more attributes.

Responses

Response samples

Content type
application/json
Example
{
  • "external_id": "a3903505-eb84-42dc-a79f-5e7b1fe897b7",
  • "course_title": "Computer Science 101",
  • "course_description": "This Professional Certificate will start you at the absolute beginning teaching you about the fundamental binary language of modern computers. You’ll learn about the Turing Machine—a model for the digital computer. You’ll also learn the basics of analytic logic and how learning and applying basic principles of logic can help you both work with and work on technical solutions. You’ll work in a managed environment and learn to code your very first program in Python – a powerful but simple programming language used by app developers and data scientists."
}

Update Course

Submit the most up to date Course information to update their profile inside the system. Any field that is present will overwrite existing values within the system, while absent fields will be left as-is.

Authorizations:
application (write)
path Parameters
external_id
required
string <uuid> (UUID) non-empty [a-zA-Z0-9_-]+
Example: a3903505-eb84-42dc-a79f-5e7b1fe897b7

The unique ID in your system, consisting of alphanumeric characters, hyphens and underscores.

Request Body schema: application/json
course_title
string non-empty

Title of the Course.

course_description
string non-empty

Textual description of the Course.

Responses

Request samples

Content type
application/json
{
  • "course_title": "Computer Science 101",
  • "course_description": "This Professional Certificate will start you at the absolute beginning teaching you about the fundamental binary language of modern computers. You’ll learn about the Turing Machine—a model for the digital computer. You’ll also learn the basics of analytic logic and how learning and applying basic principles of logic can help you both work with and work on technical solutions. You’ll work in a managed environment and learn to code your very first program in Python – a powerful but simple programming language used by app developers and data scientists."
}

Response samples

Content type
application/json
{
  • "title": "400 Bad Request",
  • "description": "The request body was not structured correctly."
}

Delete Course

Remove a Course from the system. This step deletes all information linked exclusively to this Course and cannot be undone.

Authorizations:
application (write)
path Parameters
external_id
required
string <uuid> (UUID) non-empty [a-zA-Z0-9_-]+
Example: a3903505-eb84-42dc-a79f-5e7b1fe897b7

The unique ID in your system, consisting of alphanumeric characters, hyphens and underscores.

Responses

Response samples

Content type
application/json
{
  • "title": "401 Unauthorized",
  • "description": "OAuth access token is missing, invalid or expired."
}

Get all Custom Property Definitions

Get a list of all the Custom Property Definitions stored inside the system.

Authorizations:
application (read)

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Create a Custom Property Definition

Create a new Custom Property Definition in the system.

Authorizations:
application (write)
Request Body schema: application/json
property_name
required
string non-empty

The name of the custom property.

property_type
required
string non-empty
Enum: "text" "number" "boolean"

Expected type of the custom property.

Responses

Request samples

Content type
application/json
{
  • "property_name": "sector",
  • "property_type": "text"
}

Response samples

Content type
application/json
{
  • "title": "400 Bad Request",
  • "description": "The request body was not structured correctly."
}

Get Custom Property Definition

Get the Custom Property Definition information stored inside the system.

Authorizations:
application (read)
path Parameters
property_name
required
string non-empty
Example: sector

Responses

Response samples

Content type
application/json
{
  • "property_name": "sector",
  • "property_type": "text"
}

Rename a Custom Property Definition

Rename a Custom Property Definition.

Authorizations:
application (write)
path Parameters
property_name
required
string non-empty
Example: sector
Request Body schema: application/json
property_name
required
string non-empty

The name of the custom property.

Responses

Request samples

Content type
application/json
{
  • "property_name": "sector"
}

Response samples

Content type
application/json
{
  • "title": "400 Bad Request",
  • "description": "The request body was not structured correctly."
}

Remove a Custom Property Definition from the system

Remove a Custom Property Definition from the system.

Authorizations:
application (write)
path Parameters
property_name
required
string non-empty
Example: sector

Responses

Response samples

Content type
application/json
{
  • "title": "401 Unauthorized",
  • "description": "OAuth access token is missing, invalid or expired."
}

Retrieve all custom Course properties

Fetch all Course properties from the system (if any exists, otherwise an empty list is returned).

Authorizations:
application (read)
path Parameters
external_id
required
string <uuid> (UUID) non-empty [a-zA-Z0-9_-]+
Example: a3903505-eb84-42dc-a79f-5e7b1fe897b7

The unique ID in your system, consisting of alphanumeric characters, hyphens and underscores.

Responses

Response samples

Content type
application/json
[]

Update custom Course properties

In addition to the default fields available for each Course, a set of custom properties can be added. Each Course is allowed to have a maximum of 100 properties, with properties being numbers or strings (maximum length 1000 characters).

Authorizations:
application (write)
path Parameters
external_id
required
string <uuid> (UUID) non-empty [a-zA-Z0-9_-]+
Example: a3903505-eb84-42dc-a79f-5e7b1fe897b7

The unique ID in your system, consisting of alphanumeric characters, hyphens and underscores.

Request Body schema: application/json
Array ([ 1 .. 100 ] items)
property_name
string non-empty
object

Responses

Request samples

Content type
application/json
[]

Response samples

Content type
application/json
Example
{
  • "title": "400 Bad Request",
  • "description": "The request body was not structured correctly."
}

Replace custom Course properties

In addition to the default fields available for each Course, a set of custom properties can be added. Each Course is allowed to have a maximum of 100 properties, with properties being numbers or strings (maximum length 1000 characters).

Authorizations:
application (write)
path Parameters
external_id
required
string <uuid> (UUID) non-empty [a-zA-Z0-9_-]+
Example: a3903505-eb84-42dc-a79f-5e7b1fe897b7

The unique ID in your system, consisting of alphanumeric characters, hyphens and underscores.

Request Body schema: application/json
Array ([ 1 .. 100 ] items)
property_name
string non-empty
object

Responses

Request samples

Content type
application/json
[]

Response samples

Content type
application/json
Example
{
  • "title": "400 Bad Request",
  • "description": "The request body was not structured correctly."
}

Delete all custom Course properties

Drop all Course properties from the system (if any exists).

Authorizations:
application (write)
path Parameters
external_id
required
string <uuid> (UUID) non-empty [a-zA-Z0-9_-]+
Example: a3903505-eb84-42dc-a79f-5e7b1fe897b7

The unique ID in your system, consisting of alphanumeric characters, hyphens and underscores.

Responses

Response samples

Content type
application/json
{
  • "title": "401 Unauthorized",
  • "description": "OAuth access token is missing, invalid or expired."
}

Skill Profile

Get the skill profile for a Course

Get an export of the Course skill profile to leverage it for user interaction. Check our tutorials for a clear overview of how to get the most out of each format!

Authorizations:
application (read)
path Parameters
external_id
required
string <uuid> (UUID) non-empty [a-zA-Z0-9_-]+
Example: a3903505-eb84-42dc-a79f-5e7b1fe897b7

The unique ID in your system, consisting of alphanumeric characters, hyphens and underscores.

query Parameters
response_format
string
Default: "list"
Enum: "list" "trending" "competencies"
Example: response_format=list

The format in which the skill profile needs to be returned. List returns the skills, trending indicates per skill if it is trending and competencies return the skill profile in your own Competencies. More info about adding your Competencies can be found in the tutorials.

Responses

Response samples

Content type
application/json
Example
{
  • "external_id": "a3903505-eb84-42dc-a79f-5e7b1fe897b7",
  • "skills": [
    ]
}

Update a Course skill profile with feedback

Provide feedback about an existing Course skill profile to update it inside the system. The body of the feedback message replaces the existing skill profile, so if a skill is not present in the body or has weight 0, it will be removed. The feedback can contain updates (e.g. score changes or skills added through related skills / skill search) and removals. The feedback_format query parameter indicates the format in which the feedback is given (currently skills and competencies). Typically used to process insights gained from end users through a front-end application.

Authorizations:
application (write)
path Parameters
external_id
required
string <uuid> (UUID) non-empty [a-zA-Z0-9_-]+
Example: a3903505-eb84-42dc-a79f-5e7b1fe897b7

The unique ID in your system, consisting of alphanumeric characters, hyphens and underscores.

query Parameters
feedback_format
string
Default: "skills"
Enum: "skills" "competencies"
Example: feedback_format=skills

The format in which feedback for the skill profile is given.

Request Body schema: application/json
One of
Array of objects (SkillWithScoreArray)

The skills contained in this profile, along with their scores.

Responses

Request samples

Content type
application/json
Example
{
  • "skills": [
    ]
}

Response samples

Content type
application/json
{
  • "title": "400 Bad Request",
  • "description": "The request body was not structured correctly."
}

Metrics

Get Course count

Get the total number of Course objects stored inside the system.

Authorizations:
application (read)

Responses

Response samples

Content type
application/json
{
  • "entity_type": "Course",
  • "entity_id": "a3903505-eb84-42dc-a79f-5e7b1fe897b7",
  • "metric_name": "count",
  • "metric_value": 1000,
  • "last_update": "2020-09-01T11:45:49Z"
}

CRUD

List Occupations

Get a list of all Occupation ids available in the system. This can for example be used to keep track of proper synchronisation between your system and the Skill Engine API.

Authorizations:
application (read)

Responses

Response samples

Content type
application/json
[
  • "5cbdbdbe-5f44-4423-8157-520f8a2f429a",
  • "62d2c013-ab77-410e-b5fb-2f96eed9c1db",
  • "6129e3f1-663f-44ea-aa3f-2ce1077b834c"
]

Create Occupation

Submit new Occupation information to initialise their Skill Profile inside the Skill Engine API.

Authorizations:
application (write)
Request Body schema: application/json
external_id
required
string <uuid> (UUID) non-empty [a-zA-Z0-9_-]+

The unique ID in your system, consisting of alphanumeric characters, hyphens and underscores.

occupation_name
required
string non-empty

Title of the Occupation.

occupation_description
required
string non-empty

Textual description of the Occupation.

occupation_titles
Array of strings

A list of alternate names for the occupation

Responses

Request samples

Content type
application/json
{
  • "external_id": "a3903505-eb84-42dc-a79f-5e7b1fe897b7",
  • "occupation_name": "Python Developer",
  • "occupation_description": "Developer that is skilled at the Python language.",
  • "occupation_titles": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "title": "400 Bad Request",
  • "description": "The request body was not structured correctly."
}

Get Occupation

Get the Occupation information stored inside the system.

Authorizations:
application (read)
path Parameters
external_id
required
string <uuid> (UUID) non-empty [a-zA-Z0-9_-]+
Example: a3903505-eb84-42dc-a79f-5e7b1fe897b7

The unique ID in your system, consisting of alphanumeric characters, hyphens and underscores.

query Parameters
include
Array of strings
Items Value: "custom_properties"
Example: include=custom_properties

Additional entity attributes that will be included in the response body. This query parameter can be added multiple times to include more attributes.

Responses

Response samples

Content type
application/json
Example
{
  • "external_id": "a3903505-eb84-42dc-a79f-5e7b1fe897b7",
  • "occupation_name": "Python Developer",
  • "occupation_description": "Developer that is skilled at the Python language.",
  • "occupation_titles": [
    ]
}

Update Occupation

Submit the most up to date Occupation information to update their profile inside the system. Any field that is present will overwrite existing values within the system, while absent fields will be left as-is.

Authorizations:
application (write)
path Parameters
external_id
required
string <uuid> (UUID) non-empty [a-zA-Z0-9_-]+
Example: a3903505-eb84-42dc-a79f-5e7b1fe897b7

The unique ID in your system, consisting of alphanumeric characters, hyphens and underscores.

Request Body schema: application/json
occupation_name
string non-empty

Title of the Occupation.

occupation_description
string non-empty

Textual description of the Occupation.

occupation_titles
Array of strings

A list of alternate names for the occupation

Responses

Request samples

Content type
application/json
{
  • "occupation_name": "Python Developer",
  • "occupation_description": "Developer that is skilled at the Python language.",
  • "occupation_titles": [
    ]
}

Response samples

Content type
application/json
{
  • "title": "400 Bad Request",
  • "description": "The request body was not structured correctly."
}

Delete Occupation

Remove a Occupation from the system. This step deletes all information linked exclusively to this Occupation, while leaving other (potentially linked) entities such as documents authored by the user. If these need to be removed as well, make sure to do this separately. By deleting a Occupation, you delete their skill profile history, which cannot be recreated or recovered afterwards.

Authorizations:
application (write)
path Parameters
external_id
required
string <uuid> (UUID) non-empty [a-zA-Z0-9_-]+
Example: a3903505-eb84-42dc-a79f-5e7b1fe897b7

The unique ID in your system, consisting of alphanumeric characters, hyphens and underscores.

Responses

Response samples

Content type
application/json
{
  • "title": "401 Unauthorized",
  • "description": "OAuth access token is missing, invalid or expired."
}

Get all Custom Property Definitions

Get a list of all the Custom Property Definitions stored inside the system.

Authorizations:
application (read)

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Create a Custom Property Definition

Create a new Custom Property Definition in the system.

Authorizations:
application (write)
Request Body schema: application/json
property_name
required
string non-empty

The name of the custom property.

property_type
required
string non-empty
Enum: "text" "number" "boolean"

Expected type of the custom property.

Responses

Request samples

Content type
application/json
{
  • "property_name": "sector",
  • "property_type": "text"
}

Response samples

Content type
application/json
{
  • "title": "400 Bad Request",
  • "description": "The request body was not structured correctly."
}

Get Custom Property Definition

Get the Custom Property Definition information stored inside the system.

Authorizations:
application (read)
path Parameters
property_name
required
string non-empty
Example: sector

Responses

Response samples

Content type
application/json
{
  • "property_name": "sector",
  • "property_type": "text"
}

Rename a Custom Property Definition

Rename a Custom Property Definition.

Authorizations:
application (write)
path Parameters
property_name
required
string non-empty
Example: sector
Request Body schema: application/json
property_name
required
string non-empty

The name of the custom property.

Responses

Request samples

Content type
application/json
{
  • "property_name": "sector"
}

Response samples

Content type
application/json
{
  • "title": "400 Bad Request",
  • "description": "The request body was not structured correctly."
}

Remove a Custom Property Definition from the system

Remove a Custom Property Definition from the system.

Authorizations:
application (write)
path Parameters
property_name
required
string non-empty
Example: sector

Responses

Response samples

Content type
application/json
{
  • "title": "401 Unauthorized",
  • "description": "OAuth access token is missing, invalid or expired."
}

Retrieve all custom Occupation properties

Fetch all Occupation properties from the system (if any exists, otherwise an empty list is returned).

Authorizations:
application (read)
path Parameters
external_id
required
string <uuid> (UUID) non-empty [a-zA-Z0-9_-]+
Example: a3903505-eb84-42dc-a79f-5e7b1fe897b7

The unique ID in your system, consisting of alphanumeric characters, hyphens and underscores.

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    }
]

Replace custom Occupation properties

In addition to the default fields available for each Occupation, a set of custom properties can be added. Each Occupation is allowed to have a maximum of 100 properties, with properties being numbers or strings (maximum length 1000 characters).

Authorizations:
application (write)
path Parameters
external_id
required
string <uuid> (UUID) non-empty [a-zA-Z0-9_-]+
Example: a3903505-eb84-42dc-a79f-5e7b1fe897b7

The unique ID in your system, consisting of alphanumeric characters, hyphens and underscores.

Request Body schema: application/json
Array ([ 1 .. 100 ] items)
property_name
string non-empty
object

Responses

Request samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    }
]

Response samples

Content type
application/json
Example
{
  • "title": "400 Bad Request",
  • "description": "The request body was not structured correctly."
}

Update custom Occupation properties

In addition to the default fields available for each Occupation, a set of custom properties can be added. Each Occupation is allowed to have a maximum of 100 properties, with properties being numbers or strings (maximum length 1000 characters).

Authorizations:
application (write)
path Parameters
external_id
required
string <uuid> (UUID) non-empty [a-zA-Z0-9_-]+
Example: a3903505-eb84-42dc-a79f-5e7b1fe897b7

The unique ID in your system, consisting of alphanumeric characters, hyphens and underscores.

Request Body schema: application/json
Array ([ 1 .. 100 ] items)
property_name
string non-empty
object

Responses

Request samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    }
]

Response samples

Content type
application/json
Example
{
  • "title": "400 Bad Request",
  • "description": "The request body was not structured correctly."
}

Delete all custom Occupation properties

Drop all Occupation properties from the system (if any exists).

Authorizations:
application (write)
path Parameters
external_id
required
string <uuid> (UUID) non-empty [a-zA-Z0-9_-]+
Example: a3903505-eb84-42dc-a79f-5e7b1fe897b7

The unique ID in your system, consisting of alphanumeric characters, hyphens and underscores.

Responses

Response samples

Content type
application/json
{
  • "title": "401 Unauthorized",
  • "description": "OAuth access token is missing, invalid or expired."
}

Skill Profile

Get the skill profile for a Occupation

Get an export of the Occupation skill profile to leverage it for user interaction. Check our tutorials for a clear overview of how to get the most out of each format!

Authorizations:
application (read)
path Parameters
external_id
required
string <uuid> (UUID) non-empty [a-zA-Z0-9_-]+
Example: a3903505-eb84-42dc-a79f-5e7b1fe897b7

The unique ID in your system, consisting of alphanumeric characters, hyphens and underscores.

query Parameters
response_format
string
Default: "list"
Enum: "list" "trending" "competencies"
Example: response_format=list

The format in which the skill profile needs to be returned. List returns the skills, trending indicates per skill if it is trending and competencies return the skill profile in your own Competencies. More info about adding your Competencies can be found in the tutorials.

Responses

Response samples

Content type
application/json
Example
{
  • "external_id": "a3903505-eb84-42dc-a79f-5e7b1fe897b7",
  • "skills": [
    ]
}

Update a Occupation skill profile with feedback

Provide feedback about an existing Occupation skill profile to update it inside the system. The body of the feedback message replaces the existing skill profile, so if a skill is not present in the body or has weight 0, it will be removed. The feedback can contain updates (e.g. score changes or skills added through related skills / skill search) and removals. The feedback_format query parameter indicates the format in which the feedback is given (currently skills and competencies). Typically used to process insights gained from end users through a front-end application.

Authorizations:
application (write)
path Parameters
external_id
required
string <uuid> (UUID) non-empty [a-zA-Z0-9_-]+
Example: a3903505-eb84-42dc-a79f-5e7b1fe897b7

The unique ID in your system, consisting of alphanumeric characters, hyphens and underscores.

query Parameters
feedback_format
string
Default: "skills"
Enum: "skills" "competencies"
Example: feedback_format=skills

The format in which feedback for the skill profile is given.

Request Body schema: application/json
One of
Array of objects (SkillWithScoreArray)

The skills contained in this profile, along with their scores.

Responses

Request samples

Content type
application/json
Example
{
  • "skills": [
    ]
}

Response samples

Content type
application/json
{
  • "title": "400 Bad Request",
  • "description": "The request body was not structured correctly."
}

Metrics

Get Occupation count

Get the total number of Occupation objects stored inside the system.

Authorizations:
application (read)

Responses

Response samples

Content type
application/json
{
  • "entity_type": "Occupation",
  • "entity_id": "a3903505-eb84-42dc-a79f-5e7b1fe897b7",
  • "metric_name": "count",
  • "metric_value": 1000,
  • "last_update": "2020-09-01T11:45:49Z"
}

Occupation Search

Search for Occupations similar to the provided title.

Search for Occupations similar to the provided job title. The most similar Occupations in the system are returned first.

Authorizations:
application (read)
Request Body schema: application/json

filters for the occupation search

title
required
string non-empty

The job title for which the most similar Occupation entities are searched.

limit
number <integer> [ 1 .. 100 ]
Default: 10

The number of search results to return.

Responses

Request samples

Content type
application/json
{
  • "title": "Python Developer",
  • "limit": 10
}

Response samples

Content type
application/json
{
  • "title": "Python Developer",
  • "matches": [
    ]
}

CRUD

List Competencies

Get a list of all Competency ids available in the system. This can for example be used to keep track of proper synchronisation between your system and the Skill Engine API.

Authorizations:
application (read)

Responses

Response samples

Content type
application/json
[
  • "5cbdbdbe-5f44-4423-8157-520f8a2f429a",
  • "62d2c013-ab77-410e-b5fb-2f96eed9c1db",
  • "6129e3f1-663f-44ea-aa3f-2ce1077b834c"
]

Create Competency

Submit new Competency information to initialise its Skill Profile inside the Skill Engine API.

Authorizations:
application (write)
Request Body schema: application/json
external_id
required
string <uuid> (UUID) non-empty [a-zA-Z0-9_-]+

The unique ID in your system, consisting of alphanumeric characters, hyphens and underscores.

competency_name
required
string non-empty

Name of the Competency.

competency_description
required
string non-empty

Textual description of the Competency.

Responses

Request samples

Content type
application/json
{
  • "external_id": "a3903505-eb84-42dc-a79f-5e7b1fe897b7",
  • "competency_name": "Audit",
  • "competency_description": "The ability and skill to conduct audits, identifying exceptions and developing specific solutions or recommendations"
}

Response samples

Content type
application/json
Example
{
  • "title": "400 Bad Request",
  • "description": "The request body was not structured correctly."
}

Get Competency

Get the Competency information stored inside the system.

Authorizations:
application (read)
path Parameters
external_id
required
string <uuid> (UUID) non-empty [a-zA-Z0-9_-]+
Example: a3903505-eb84-42dc-a79f-5e7b1fe897b7

The unique ID in your system, consisting of alphanumeric characters, hyphens and underscores.

query Parameters
include
Array of strings
Items Value: "custom_properties"
Example: include=custom_properties

Additional entity attributes that will be included in the response body. This query parameter can be added multiple times to include more attributes.

Responses

Response samples

Content type
application/json
Example
{
  • "external_id": "a3903505-eb84-42dc-a79f-5e7b1fe897b7",
  • "competency_name": "Audit",
  • "competency_description": "The ability and skill to conduct audits, identifying exceptions and developing specific solutions or recommendations"
}

Update Competency

Submit the most up to date Competency information to update their profile inside the system. Any field that is present will overwrite existing values within the system, while absent fields will be left as-is.

Authorizations:
application (write)
path Parameters
external_id
required
string <uuid> (UUID) non-empty [a-zA-Z0-9_-]+
Example: a3903505-eb84-42dc-a79f-5e7b1fe897b7

The unique ID in your system, consisting of alphanumeric characters, hyphens and underscores.

Request Body schema: application/json
competency_name
string non-empty

Name of the Competency.

competency_description
string non-empty

Textual description of the Competency.

Responses

Request samples

Content type
application/json
{
  • "competency_name": "Audit",
  • "competency_description": "The ability and skill to conduct audits, identifying exceptions and developing specific solutions or recommendations"
}

Response samples

Content type
application/json
{
  • "title": "400 Bad Request",
  • "description": "The request body was not structured correctly."
}

Delete Competency

Remove a Competency from the system. This step deletes all information linked exclusively to this Competency and cannot be undone.

Authorizations:
application (write)
path Parameters
external_id
required
string <uuid> (UUID) non-empty [a-zA-Z0-9_-]+
Example: a3903505-eb84-42dc-a79f-5e7b1fe897b7

The unique ID in your system, consisting of alphanumeric characters, hyphens and underscores.

Responses

Response samples

Content type
application/json
{
  • "title": "401 Unauthorized",
  • "description": "OAuth access token is missing, invalid or expired."
}

Get all Custom Property Definitions

Get a list of all the Custom Property Definitions stored inside the system.

Authorizations:
application (read)

Responses