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.
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.
read
) [- "5cbdbdbe-5f44-4423-8157-520f8a2f429a",
- "62d2c013-ab77-410e-b5fb-2f96eed9c1db",
- "6129e3f1-663f-44ea-aa3f-2ce1077b834c"
]
Submit new Employee information to initialise their Skill Profile inside the Skill Engine API.
write
) 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. |
{- "external_id": "a3903505-eb84-42dc-a79f-5e7b1fe897b7",
- "location": {
- "lat": 51.0216707,
- "lng": 3.6887328
}, - "working_history": [
- {
- "start_date": "2018-09-05",
- "end_date": "2020-06-17",
- "company": "TechWolf BV",
- "job_title": "HR Manager"
}
], - "education_history": [
- {
- "start_date": "2016-09-05",
- "end_date": "2018-09-05",
- "school": "Harvard University",
- "degree_name": "Master in Human Resources Management"
}
], - "languages": [
- {
- "language": "nl",
- "level": 2
}
], - "desired_functions": [
- "string"
], - "certificates": [
- {
- "certificate": "A3",
- "expiry_date": "2021-09-01"
}
], - "assigned_position": "Python Developer",
- "employee_resume": {
- "mimeType": "application/pdf",
- "base64Content": "JVBERi0xLjMNCiXi48/TDQoNCjEgMCBvYmoNCjw8DQovVHlwZSAvQ2F0YWxvZw0KL091dGxpbmVzIDIgMCBSDQovUGFnZXMgMyAwIFINCj4+DQplbmRvYmoNCg0KMiAwIG9iag0KPDwNCi9UeXBlIC9PdXRsaW5lcw0KL0NvdW50IDANCj4+DQplbmRvYmoNCg0KMyAwIG9iag0KPDwNCi9UeXBlIC9QYWdlcw0KL0NvdW50IDINCi9LaWRzIFsgNCAwIFIgNiAwIFIgXSANCj4+DQplbmRvYmoNCg0KNCAwIG9iag0KPDwNCi9UeXBlIC9QYWdlDQovUGFyZW50IDMgMCBSDQovUmVzb3VyY2VzIDw8DQovRm9udCA8PA0KL0YxIDkgMCBSIA0KPj4NCi9Qcm9jU2V0IDggMCBSDQo+Pg0KL01lZGlhQm94IFswIDAgNjEyLjAwMDAgNzkyLjAwMDBdDQovQ29udGVudHMgNSAwIFINCj4+DQplbmRvYmoNCg0KNSAwIG9iag0KPDwgL0xlbmd0aCAxMDc0ID4+DQpzdHJlYW0NCjIgSg0KQlQNCjAgMCAwIHJnDQovRjEgMDAyNyBUZg0KNTcuMzc1MCA3MjIuMjgwMCBUZA0KKCBBIFNpbXBsZSBQREYgRmlsZSApIFRqDQpFVA0KQlQNCi9GMSAwMDEwIFRmDQo2OS4yNTAwIDY4OC42MDgwIFRkDQooIFRoaXMgaXMgYSBzbWFsbCBkZW1vbnN0cmF0aW9uIC5wZGYgZmlsZSAtICkgVGoNCkVUDQpCVA0KL0YxIDAwMTAgVGYNCjY5LjI1MDAgNjY0LjcwNDAgVGQNCigganVzdCBmb3IgdXNlIGluIHRoZSBWaXJ0dWFsIE1lY2hhbmljcyB0dXRvcmlhbHMuIE1vcmUgdGV4dC4gQW5kIG1vcmUgKSBUag0KRVQNCkJUDQovRjEgMDAxMCBUZg0KNjkuMjUwMCA2NTIuNzUyMCBUZA0KKCB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiApIFRqDQpFVA0KQlQNCi9GMSAwMDEwIFRmDQo2OS4yNTAwIDYyOC44NDgwIFRkDQooIEFuZCBtb3JlIHRleHQuIEFuZCBtb3JlIHRleHQuIEFuZCBtb3JlIHRleHQuIEFuZCBtb3JlIHRleHQuIEFuZCBtb3JlICkgVGoNCkVUDQpCVA0KL0YxIDAwMTAgVGYNCjY5LjI1MDAgNjE2Ljg5NjAgVGQNCiggdGV4dC4gQW5kIG1vcmUgdGV4dC4gQm9yaW5nLCB6enp6ei4gQW5kIG1vcmUgdGV4dC4gQW5kIG1vcmUgdGV4dC4gQW5kICkgVGoNCkVUDQpCVA0KL0YxIDAwMTAgVGYNCjY5LjI1MDAgNjA0Ljk0NDAgVGQNCiggbW9yZSB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiApIFRqDQpFVA0KQlQNCi9GMSAwMDEwIFRmDQo2OS4yNTAwIDU5Mi45OTIwIFRkDQooIEFuZCBtb3JlIHRleHQuIEFuZCBtb3JlIHRleHQuICkgVGoNCkVUDQpCVA0KL0YxIDAwMTAgVGYNCjY5LjI1MDAgNTY5LjA4ODAgVGQNCiggQW5kIG1vcmUgdGV4dC4gQW5kIG1vcmUgdGV4dC4gQW5kIG1vcmUgdGV4dC4gQW5kIG1vcmUgdGV4dC4gQW5kIG1vcmUgKSBUag0KRVQNCkJUDQovRjEgMDAxMCBUZg0KNjkuMjUwMCA1NTcuMTM2MCBUZA0KKCB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiBFdmVuIG1vcmUuIENvbnRpbnVlZCBvbiBwYWdlIDIgLi4uKSBUag0KRVQNCmVuZHN0cmVhbQ0KZW5kb2JqDQoNCjYgMCBvYmoNCjw8DQovVHlwZSAvUGFnZQ0KL1BhcmVudCAzIDAgUg0KL1Jlc291cmNlcyA8PA0KL0ZvbnQgPDwNCi9GMSA5IDAgUiANCj4+DQovUHJvY1NldCA4IDAgUg0KPj4NCi9NZWRpYUJveCBbMCAwIDYxMi4wMDAwIDc5Mi4wMDAwXQ0KL0NvbnRlbnRzIDcgMCBSDQo+Pg0KZW5kb2JqDQoNCjcgMCBvYmoNCjw8IC9MZW5ndGggNjc2ID4+DQpzdHJlYW0NCjIgSg0KQlQNCjAgMCAwIHJnDQovRjEgMDAyNyBUZg0KNTcuMzc1MCA3MjIuMjgwMCBUZA0KKCBTaW1wbGUgUERGIEZpbGUgMiApIFRqDQpFVA0KQlQNCi9GMSAwMDEwIFRmDQo2OS4yNTAwIDY4OC42MDgwIFRkDQooIC4uLmNvbnRpbnVlZCBmcm9tIHBhZ2UgMS4gWWV0IG1vcmUgdGV4dC4gQW5kIG1vcmUgdGV4dC4gQW5kIG1vcmUgdGV4dC4gKSBUag0KRVQNCkJUDQovRjEgMDAxMCBUZg0KNjkuMjUwMCA2NzYuNjU2MCBUZA0KKCBBbmQgbW9yZSB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiBBbmQgbW9yZSApIFRqDQpFVA0KQlQNCi9GMSAwMDEwIFRmDQo2OS4yNTAwIDY2NC43MDQwIFRkDQooIHRleHQuIE9oLCBob3cgYm9yaW5nIHR5cGluZyB0aGlzIHN0dWZmLiBCdXQgbm90IGFzIGJvcmluZyBhcyB3YXRjaGluZyApIFRqDQpFVA0KQlQNCi9GMSAwMDEwIFRmDQo2OS4yNTAwIDY1Mi43NTIwIFRkDQooIHBhaW50IGRyeS4gQW5kIG1vcmUgdGV4dC4gQW5kIG1vcmUgdGV4dC4gQW5kIG1vcmUgdGV4dC4gQW5kIG1vcmUgdGV4dC4gKSBUag0KRVQNCkJUDQovRjEgMDAxMCBUZg0KNjkuMjUwMCA2NDAuODAwMCBUZA0KKCBCb3JpbmcuICBNb3JlLCBhIGxpdHRsZSBtb3JlIHRleHQuIFRoZSBlbmQsIGFuZCBqdXN0IGFzIHdlbGwuICkgVGoNCkVUDQplbmRzdHJlYW0NCmVuZG9iag0KDQo4IDAgb2JqDQpbL1BERiAvVGV4dF0NCmVuZG9iag0KDQo5IDAgb2JqDQo8PA0KL1R5cGUgL0ZvbnQNCi9TdWJ0eXBlIC9UeXBlMQ0KL05hbWUgL0YxDQovQmFzZUZvbnQgL0hlbHZldGljYQ0KL0VuY29kaW5nIC9XaW5BbnNpRW5jb2RpbmcNCj4+DQplbmRvYmoNCg0KMTAgMCBvYmoNCjw8DQovQ3JlYXRvciAoUmF2ZSBcKGh0dHA6Ly93d3cubmV2cm9uYS5jb20vcmF2ZVwpKQ0KL1Byb2R1Y2VyIChOZXZyb25hIERlc2lnbnMpDQovQ3JlYXRpb25EYXRlIChEOjIwMDYwMzAxMDcyODI2KQ0KPj4NCmVuZG9iag0KDQp4cmVmDQowIDExDQowMDAwMDAwMDAwIDY1NTM1IGYNCjAwMDAwMDAwMTkgMDAwMDAgbg0KMDAwMDAwMDA5MyAwMDAwMCBuDQowMDAwMDAwMTQ3IDAwMDAwIG4NCjAwMDAwMDAyMjIgMDAwMDAgbg0KMDAwMDAwMDM5MCAwMDAwMCBuDQowMDAwMDAxNTIyIDAwMDAwIG4NCjAwMDAwMDE2OTAgMDAwMDAgbg0KMDAwMDAwMjQyMyAwMDAwMCBuDQowMDAwMDAyNDU2IDAwMDAwIG4NCjAwMDAwMDI1NzQgMDAwMDAgbg0KDQp0cmFpbGVyDQo8PA0KL1NpemUgMTENCi9Sb290IDEgMCBSDQovSW5mbyAxMCAwIFINCj4+DQoNCnN0YXJ0eHJlZg0KMjcxNA0KJSVFT0YNCg=="
}
}
{- "title": "400 Bad Request",
- "description": "The request body was not structured correctly."
}
Get the Employee information stored inside the system. As resumes are not stored inside our system, they are not returned in this call.
read
) 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. |
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. |
{- "external_id": "a3903505-eb84-42dc-a79f-5e7b1fe897b7",
- "location": {
- "lat": 51.0216707,
- "lng": 3.6887328
}, - "working_history": [
- {
- "start_date": "2018-09-05",
- "end_date": "2020-06-17",
- "company": "TechWolf BV",
- "job_title": "HR Manager"
}
], - "education_history": [
- {
- "start_date": "2016-09-05",
- "end_date": "2018-09-05",
- "school": "Harvard University",
- "degree_name": "Master in Human Resources Management"
}
], - "languages": [
- {
- "language": "nl",
- "level": 2
}
], - "desired_functions": [
- "string"
], - "certificates": [
- {
- "certificate": "A3",
- "expiry_date": "2021-09-01"
}
], - "assigned_position": "Python Developer"
}
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.
write
) 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. |
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. |
{- "location": {
- "lat": 51.0216707,
- "lng": 3.6887328
}, - "working_history": [
- {
- "start_date": "2018-09-05",
- "end_date": "2020-06-17",
- "company": "TechWolf BV",
- "job_title": "HR Manager"
}
], - "education_history": [
- {
- "start_date": "2016-09-05",
- "end_date": "2018-09-05",
- "school": "Harvard University",
- "degree_name": "Master in Human Resources Management"
}
], - "languages": [
- {
- "language": "nl",
- "level": 2
}
], - "desired_functions": [
- "string"
], - "certificates": [
- {
- "certificate": "A3",
- "expiry_date": "2021-09-01"
}
], - "assigned_position": "Python Developer",
- "employee_resume": {
- "mimeType": "application/pdf",
- "base64Content": "JVBERi0xLjMNCiXi48/TDQoNCjEgMCBvYmoNCjw8DQovVHlwZSAvQ2F0YWxvZw0KL091dGxpbmVzIDIgMCBSDQovUGFnZXMgMyAwIFINCj4+DQplbmRvYmoNCg0KMiAwIG9iag0KPDwNCi9UeXBlIC9PdXRsaW5lcw0KL0NvdW50IDANCj4+DQplbmRvYmoNCg0KMyAwIG9iag0KPDwNCi9UeXBlIC9QYWdlcw0KL0NvdW50IDINCi9LaWRzIFsgNCAwIFIgNiAwIFIgXSANCj4+DQplbmRvYmoNCg0KNCAwIG9iag0KPDwNCi9UeXBlIC9QYWdlDQovUGFyZW50IDMgMCBSDQovUmVzb3VyY2VzIDw8DQovRm9udCA8PA0KL0YxIDkgMCBSIA0KPj4NCi9Qcm9jU2V0IDggMCBSDQo+Pg0KL01lZGlhQm94IFswIDAgNjEyLjAwMDAgNzkyLjAwMDBdDQovQ29udGVudHMgNSAwIFINCj4+DQplbmRvYmoNCg0KNSAwIG9iag0KPDwgL0xlbmd0aCAxMDc0ID4+DQpzdHJlYW0NCjIgSg0KQlQNCjAgMCAwIHJnDQovRjEgMDAyNyBUZg0KNTcuMzc1MCA3MjIuMjgwMCBUZA0KKCBBIFNpbXBsZSBQREYgRmlsZSApIFRqDQpFVA0KQlQNCi9GMSAwMDEwIFRmDQo2OS4yNTAwIDY4OC42MDgwIFRkDQooIFRoaXMgaXMgYSBzbWFsbCBkZW1vbnN0cmF0aW9uIC5wZGYgZmlsZSAtICkgVGoNCkVUDQpCVA0KL0YxIDAwMTAgVGYNCjY5LjI1MDAgNjY0LjcwNDAgVGQNCigganVzdCBmb3IgdXNlIGluIHRoZSBWaXJ0dWFsIE1lY2hhbmljcyB0dXRvcmlhbHMuIE1vcmUgdGV4dC4gQW5kIG1vcmUgKSBUag0KRVQNCkJUDQovRjEgMDAxMCBUZg0KNjkuMjUwMCA2NTIuNzUyMCBUZA0KKCB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiApIFRqDQpFVA0KQlQNCi9GMSAwMDEwIFRmDQo2OS4yNTAwIDYyOC44NDgwIFRkDQooIEFuZCBtb3JlIHRleHQuIEFuZCBtb3JlIHRleHQuIEFuZCBtb3JlIHRleHQuIEFuZCBtb3JlIHRleHQuIEFuZCBtb3JlICkgVGoNCkVUDQpCVA0KL0YxIDAwMTAgVGYNCjY5LjI1MDAgNjE2Ljg5NjAgVGQNCiggdGV4dC4gQW5kIG1vcmUgdGV4dC4gQm9yaW5nLCB6enp6ei4gQW5kIG1vcmUgdGV4dC4gQW5kIG1vcmUgdGV4dC4gQW5kICkgVGoNCkVUDQpCVA0KL0YxIDAwMTAgVGYNCjY5LjI1MDAgNjA0Ljk0NDAgVGQNCiggbW9yZSB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiApIFRqDQpFVA0KQlQNCi9GMSAwMDEwIFRmDQo2OS4yNTAwIDU5Mi45OTIwIFRkDQooIEFuZCBtb3JlIHRleHQuIEFuZCBtb3JlIHRleHQuICkgVGoNCkVUDQpCVA0KL0YxIDAwMTAgVGYNCjY5LjI1MDAgNTY5LjA4ODAgVGQNCiggQW5kIG1vcmUgdGV4dC4gQW5kIG1vcmUgdGV4dC4gQW5kIG1vcmUgdGV4dC4gQW5kIG1vcmUgdGV4dC4gQW5kIG1vcmUgKSBUag0KRVQNCkJUDQovRjEgMDAxMCBUZg0KNjkuMjUwMCA1NTcuMTM2MCBUZA0KKCB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiBFdmVuIG1vcmUuIENvbnRpbnVlZCBvbiBwYWdlIDIgLi4uKSBUag0KRVQNCmVuZHN0cmVhbQ0KZW5kb2JqDQoNCjYgMCBvYmoNCjw8DQovVHlwZSAvUGFnZQ0KL1BhcmVudCAzIDAgUg0KL1Jlc291cmNlcyA8PA0KL0ZvbnQgPDwNCi9GMSA5IDAgUiANCj4+DQovUHJvY1NldCA4IDAgUg0KPj4NCi9NZWRpYUJveCBbMCAwIDYxMi4wMDAwIDc5Mi4wMDAwXQ0KL0NvbnRlbnRzIDcgMCBSDQo+Pg0KZW5kb2JqDQoNCjcgMCBvYmoNCjw8IC9MZW5ndGggNjc2ID4+DQpzdHJlYW0NCjIgSg0KQlQNCjAgMCAwIHJnDQovRjEgMDAyNyBUZg0KNTcuMzc1MCA3MjIuMjgwMCBUZA0KKCBTaW1wbGUgUERGIEZpbGUgMiApIFRqDQpFVA0KQlQNCi9GMSAwMDEwIFRmDQo2OS4yNTAwIDY4OC42MDgwIFRkDQooIC4uLmNvbnRpbnVlZCBmcm9tIHBhZ2UgMS4gWWV0IG1vcmUgdGV4dC4gQW5kIG1vcmUgdGV4dC4gQW5kIG1vcmUgdGV4dC4gKSBUag0KRVQNCkJUDQovRjEgMDAxMCBUZg0KNjkuMjUwMCA2NzYuNjU2MCBUZA0KKCBBbmQgbW9yZSB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiBBbmQgbW9yZSApIFRqDQpFVA0KQlQNCi9GMSAwMDEwIFRmDQo2OS4yNTAwIDY2NC43MDQwIFRkDQooIHRleHQuIE9oLCBob3cgYm9yaW5nIHR5cGluZyB0aGlzIHN0dWZmLiBCdXQgbm90IGFzIGJvcmluZyBhcyB3YXRjaGluZyApIFRqDQpFVA0KQlQNCi9GMSAwMDEwIFRmDQo2OS4yNTAwIDY1Mi43NTIwIFRkDQooIHBhaW50IGRyeS4gQW5kIG1vcmUgdGV4dC4gQW5kIG1vcmUgdGV4dC4gQW5kIG1vcmUgdGV4dC4gQW5kIG1vcmUgdGV4dC4gKSBUag0KRVQNCkJUDQovRjEgMDAxMCBUZg0KNjkuMjUwMCA2NDAuODAwMCBUZA0KKCBCb3JpbmcuICBNb3JlLCBhIGxpdHRsZSBtb3JlIHRleHQuIFRoZSBlbmQsIGFuZCBqdXN0IGFzIHdlbGwuICkgVGoNCkVUDQplbmRzdHJlYW0NCmVuZG9iag0KDQo4IDAgb2JqDQpbL1BERiAvVGV4dF0NCmVuZG9iag0KDQo5IDAgb2JqDQo8PA0KL1R5cGUgL0ZvbnQNCi9TdWJ0eXBlIC9UeXBlMQ0KL05hbWUgL0YxDQovQmFzZUZvbnQgL0hlbHZldGljYQ0KL0VuY29kaW5nIC9XaW5BbnNpRW5jb2RpbmcNCj4+DQplbmRvYmoNCg0KMTAgMCBvYmoNCjw8DQovQ3JlYXRvciAoUmF2ZSBcKGh0dHA6Ly93d3cubmV2cm9uYS5jb20vcmF2ZVwpKQ0KL1Byb2R1Y2VyIChOZXZyb25hIERlc2lnbnMpDQovQ3JlYXRpb25EYXRlIChEOjIwMDYwMzAxMDcyODI2KQ0KPj4NCmVuZG9iag0KDQp4cmVmDQowIDExDQowMDAwMDAwMDAwIDY1NTM1IGYNCjAwMDAwMDAwMTkgMDAwMDAgbg0KMDAwMDAwMDA5MyAwMDAwMCBuDQowMDAwMDAwMTQ3IDAwMDAwIG4NCjAwMDAwMDAyMjIgMDAwMDAgbg0KMDAwMDAwMDM5MCAwMDAwMCBuDQowMDAwMDAxNTIyIDAwMDAwIG4NCjAwMDAwMDE2OTAgMDAwMDAgbg0KMDAwMDAwMjQyMyAwMDAwMCBuDQowMDAwMDAyNDU2IDAwMDAwIG4NCjAwMDAwMDI1NzQgMDAwMDAgbg0KDQp0cmFpbGVyDQo8PA0KL1NpemUgMTENCi9Sb290IDEgMCBSDQovSW5mbyAxMCAwIFINCj4+DQoNCnN0YXJ0eHJlZg0KMjcxNA0KJSVFT0YNCg=="
}
}
{- "title": "400 Bad Request",
- "description": "The request body was not structured correctly."
}
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.
write
) 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. |
{- "title": "401 Unauthorized",
- "description": "OAuth access token is missing, invalid or expired."
}
Get a list of all the Custom Property Definitions stored inside the system.
read
) [- {
- "property_name": "wage",
- "property_type": "number"
}, - {
- "property_name": "sector",
- "property_type": "text"
}
]
Create a new Custom Property Definition in the system.
write
) 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. |
{- "property_name": "sector",
- "property_type": "text"
}
{- "title": "400 Bad Request",
- "description": "The request body was not structured correctly."
}
Get the Custom Property Definition information stored inside the system.
read
) property_name required | string non-empty Example: sector |
{- "property_name": "sector",
- "property_type": "text"
}
Rename a Custom Property Definition.
write
) property_name required | string non-empty Example: sector |
property_name required | string non-empty The name of the custom property. |
{- "property_name": "sector"
}
{- "title": "400 Bad Request",
- "description": "The request body was not structured correctly."
}
Remove a Custom Property Definition from the system.
write
) property_name required | string non-empty Example: sector |
{- "title": "401 Unauthorized",
- "description": "OAuth access token is missing, invalid or expired."
}
Fetch all Employee properties from the system (if any exists, otherwise an empty list is returned).
read
) 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. |
[- {
- "property_name": "yearly_wage",
- "property_value": 50000
}, - {
- "property_name": "start_date",
- "property_value": "20200112"
}, - {
- "property_name": "direct_manager",
- "property_value": "John Doe"
}
]
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).
write
) 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. |
property_name | string non-empty |
object |
[- {
- "property_name": "yearly_wage",
- "property_value": 50000
}, - {
- "property_name": "start_date",
- "property_value": "20200112"
}, - {
- "property_name": "direct_manager",
- "property_value": "John Doe"
}
]
{- "title": "400 Bad Request",
- "description": "The request body was not structured correctly."
}
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).
write
) 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. |
property_name | string non-empty |
object |
[- {
- "property_name": "yearly_wage",
- "property_value": 50000
}, - {
- "property_name": "start_date",
- "property_value": "20200112"
}, - {
- "property_name": "direct_manager",
- "property_value": "John Doe"
}
]
{- "title": "400 Bad Request",
- "description": "The request body was not structured correctly."
}
Drop all Employee properties from the system (if any exists).
write
) 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. |
{- "title": "401 Unauthorized",
- "description": "OAuth access token is missing, invalid or expired."
}
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!
read
) 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. |
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. |
{- "external_id": "a3903505-eb84-42dc-a79f-5e7b1fe897b7",
- "skills": [
- {
- "skill": "Machine Learning",
- "score": 3.18
}, - {
- "skill": "Python",
- "score": 5
}, - {
- "skill": "Tensorflow",
- "score": 4.35
}
]
}
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.
write
) 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. |
feedback_format | string Default: "skills" Enum: "skills" "competencies" Example: feedback_format=skills The format in which feedback for the skill profile is given. |
Array of objects (SkillWithScoreArray) The skills contained in this profile, along with their scores. |
{- "skills": [
- {
- "skill": "Machine Learning",
- "score": 3.18
}, - {
- "skill": "Python",
- "score": 5
}, - {
- "skill": "Tensorflow",
- "score": 4.35
}
]
}
{- "title": "400 Bad Request",
- "description": "The request body was not structured correctly."
}
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.
read
) 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. |
{- "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 the total number of Employee objects stored inside the system.
read
) {- "entity_type": "Employee",
- "entity_id": "a3903505-eb84-42dc-a79f-5e7b1fe897b7",
- "metric_name": "count",
- "metric_value": 1000,
- "last_update": "2020-09-01T11:45:49Z"
}
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.
read
) 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. |
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 |
{- "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"
}
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.
read
) [- "5cbdbdbe-5f44-4423-8157-520f8a2f429a",
- "62d2c013-ab77-410e-b5fb-2f96eed9c1db",
- "6129e3f1-663f-44ea-aa3f-2ce1077b834c"
]
Submit new Vacancy information to initialise their Skill Profile inside the Skill Engine API.
write
) 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). |
{- "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": {
- "lat": 51.0216707,
- "lng": 3.6887328
}
}
{- "title": "400 Bad Request",
- "description": "The request body was not structured correctly."
}
Get the Vacancy information stored inside the system.
read
) 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. |
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. |
{- "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": {
- "lat": 51.0216707,
- "lng": 3.6887328
}
}
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.
write
) 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. |
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). |
{- "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": {
- "lat": 51.0216707,
- "lng": 3.6887328
}
}
{- "title": "400 Bad Request",
- "description": "The request body was not structured correctly."
}
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.
write
) 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. |
{- "title": "401 Unauthorized",
- "description": "OAuth access token is missing, invalid or expired."
}
Get a list of all the Custom Property Definitions stored inside the system.
read
) [- {
- "property_name": "wage",
- "property_type": "number"
}, - {
- "property_name": "sector",
- "property_type": "text"
}
]
Create a new Custom Property Definition in the system.
write
) 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. |
{- "property_name": "sector",
- "property_type": "text"
}
{- "title": "400 Bad Request",
- "description": "The request body was not structured correctly."
}
Get the Custom Property Definition information stored inside the system.
read
) property_name required | string non-empty Example: sector |
{- "property_name": "sector",
- "property_type": "text"
}
Rename a Custom Property Definition.
write
) property_name required | string non-empty Example: sector |
property_name required | string non-empty The name of the custom property. |
{- "property_name": "sector"
}
{- "title": "400 Bad Request",
- "description": "The request body was not structured correctly."
}
Remove a Custom Property Definition from the system.
write
) property_name required | string non-empty Example: sector |
{- "title": "401 Unauthorized",
- "description": "OAuth access token is missing, invalid or expired."
}
Fetch all Vacancy properties from the system (if any exists, otherwise an empty list is returned).
read
) 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. |
[- {
- "property_name": "language",
- "property_value": "Dutch"
}, - {
- "property_name": "start_date",
- "property_value": "20200112"
}, - {
- "property_name": "experience",
- "property_value": 5
}
]
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).
write
) 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. |
property_name | string non-empty |
object |
[- {
- "property_name": "language",
- "property_value": "Dutch"
}, - {
- "property_name": "start_date",
- "property_value": "20200112"
}, - {
- "property_name": "experience",
- "property_value": 5
}
]
{- "title": "400 Bad Request",
- "description": "The request body was not structured correctly."
}
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).
write
) 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. |
property_name | string non-empty |
object |
[- {
- "property_name": "language",
- "property_value": "Dutch"
}, - {
- "property_name": "start_date",
- "property_value": "20200112"
}, - {
- "property_name": "experience",
- "property_value": 5
}
]
{- "title": "400 Bad Request",
- "description": "The request body was not structured correctly."
}
Drop all Vacancy properties from the system (if any exists).
write
) 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. |
{- "title": "401 Unauthorized",
- "description": "OAuth access token is missing, invalid or expired."
}
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!
read
) 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. |
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. |
{- "external_id": "a3903505-eb84-42dc-a79f-5e7b1fe897b7",
- "skills": [
- {
- "skill": "Machine Learning",
- "score": 3.18
}, - {
- "skill": "Python",
- "score": 5
}, - {
- "skill": "Tensorflow",
- "score": 4.35
}
]
}
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.
write
) 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. |
feedback_format | string Default: "skills" Enum: "skills" "competencies" Example: feedback_format=skills The format in which feedback for the skill profile is given. |
Array of objects (SkillWithScoreArray) The skills contained in this profile, along with their scores. |
{- "skills": [
- {
- "skill": "Machine Learning",
- "score": 3.18
}, - {
- "skill": "Python",
- "score": 5
}, - {
- "skill": "Tensorflow",
- "score": 4.35
}
]
}
{- "title": "400 Bad Request",
- "description": "The request body was not structured correctly."
}
Get the total number of Vacancy objects stored inside the system.
read
) {- "entity_type": "Vacancy",
- "entity_id": "a3903505-eb84-42dc-a79f-5e7b1fe897b7",
- "metric_name": "count",
- "metric_value": 1000,
- "last_update": "2020-09-01T11:45:49Z"
}
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.
read
) [- "5cbdbdbe-5f44-4423-8157-520f8a2f429a",
- "62d2c013-ab77-410e-b5fb-2f96eed9c1db",
- "6129e3f1-663f-44ea-aa3f-2ce1077b834c"
]
Submit new Course information to initialise its Skill Profile inside the Skill Engine API.
write
) 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. |
{- "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."
}
{- "title": "400 Bad Request",
- "description": "The request body was not structured correctly."
}
Get the Course information stored inside the system.
read
) 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. |
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. |
{- "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."
}
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.
write
) 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. |
course_title | string non-empty Title of the Course. |
course_description | string non-empty Textual description of the Course. |
{- "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."
}
{- "title": "400 Bad Request",
- "description": "The request body was not structured correctly."
}
Remove a Course from the system. This step deletes all information linked exclusively to this Course and cannot be undone.
write
) 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. |
{- "title": "401 Unauthorized",
- "description": "OAuth access token is missing, invalid or expired."
}
Get a list of all the Custom Property Definitions stored inside the system.
read
) [- {
- "property_name": "wage",
- "property_type": "number"
}, - {
- "property_name": "sector",
- "property_type": "text"
}
]
Create a new Custom Property Definition in the system.
write
) 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. |
{- "property_name": "sector",
- "property_type": "text"
}
{- "title": "400 Bad Request",
- "description": "The request body was not structured correctly."
}
Get the Custom Property Definition information stored inside the system.
read
) property_name required | string non-empty Example: sector |
{- "property_name": "sector",
- "property_type": "text"
}
Rename a Custom Property Definition.
write
) property_name required | string non-empty Example: sector |
property_name required | string non-empty The name of the custom property. |
{- "property_name": "sector"
}
{- "title": "400 Bad Request",
- "description": "The request body was not structured correctly."
}
Remove a Custom Property Definition from the system.
write
) property_name required | string non-empty Example: sector |
{- "title": "401 Unauthorized",
- "description": "OAuth access token is missing, invalid or expired."
}
Fetch all Course properties from the system (if any exists, otherwise an empty list is returned).
read
) 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. |
[- {
- "property_name": "source",
}, - {
- "property_name": "price",
- "property_value": 399
}, - {
- "property_name": "online",
- "property_value": 1
}
]
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).
write
) 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. |
property_name | string non-empty |
object |
[- {
- "property_name": "source",
}, - {
- "property_name": "price",
- "property_value": 399
}, - {
- "property_name": "online",
- "property_value": 1
}
]
{- "title": "400 Bad Request",
- "description": "The request body was not structured correctly."
}
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).
write
) 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. |
property_name | string non-empty |
object |
[- {
- "property_name": "source",
}, - {
- "property_name": "price",
- "property_value": 399
}, - {
- "property_name": "online",
- "property_value": 1
}
]
{- "title": "400 Bad Request",
- "description": "The request body was not structured correctly."
}
Drop all Course properties from the system (if any exists).
write
) 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. |
{- "title": "401 Unauthorized",
- "description": "OAuth access token is missing, invalid or expired."
}
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!
read
) 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. |
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. |
{- "external_id": "a3903505-eb84-42dc-a79f-5e7b1fe897b7",
- "skills": [
- {
- "skill": "Machine Learning",
- "score": 3.18
}, - {
- "skill": "Python",
- "score": 5
}, - {
- "skill": "Tensorflow",
- "score": 4.35
}
]
}
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.
write
) 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. |
feedback_format | string Default: "skills" Enum: "skills" "competencies" Example: feedback_format=skills The format in which feedback for the skill profile is given. |
Array of objects (SkillWithScoreArray) The skills contained in this profile, along with their scores. |
{- "skills": [
- {
- "skill": "Machine Learning",
- "score": 3.18
}, - {
- "skill": "Python",
- "score": 5
}, - {
- "skill": "Tensorflow",
- "score": 4.35
}
]
}
{- "title": "400 Bad Request",
- "description": "The request body was not structured correctly."
}
Get the total number of Course objects stored inside the system.
read
) {- "entity_type": "Course",
- "entity_id": "a3903505-eb84-42dc-a79f-5e7b1fe897b7",
- "metric_name": "count",
- "metric_value": 1000,
- "last_update": "2020-09-01T11:45:49Z"
}
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.
read
) [- "5cbdbdbe-5f44-4423-8157-520f8a2f429a",
- "62d2c013-ab77-410e-b5fb-2f96eed9c1db",
- "6129e3f1-663f-44ea-aa3f-2ce1077b834c"
]
Submit new Occupation information to initialise their Skill Profile inside the Skill Engine API.
write
) 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 |
{- "external_id": "a3903505-eb84-42dc-a79f-5e7b1fe897b7",
- "occupation_name": "Python Developer",
- "occupation_description": "Developer that is skilled at the Python language.",
- "occupation_titles": [
- "Python Programmer",
- "Python Software Developer"
]
}
{- "title": "400 Bad Request",
- "description": "The request body was not structured correctly."
}
Get the Occupation information stored inside the system.
read
) 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. |
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. |
{- "external_id": "a3903505-eb84-42dc-a79f-5e7b1fe897b7",
- "occupation_name": "Python Developer",
- "occupation_description": "Developer that is skilled at the Python language.",
- "occupation_titles": [
- "Python Programmer",
- "Python Software Developer"
]
}
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.
write
) 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. |
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 |
{- "occupation_name": "Python Developer",
- "occupation_description": "Developer that is skilled at the Python language.",
- "occupation_titles": [
- "Python Programmer",
- "Python Software Developer"
]
}
{- "title": "400 Bad Request",
- "description": "The request body was not structured correctly."
}
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.
write
) 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. |
{- "title": "401 Unauthorized",
- "description": "OAuth access token is missing, invalid or expired."
}
Get a list of all the Custom Property Definitions stored inside the system.
read
) [- {
- "property_name": "wage",
- "property_type": "number"
}, - {
- "property_name": "sector",
- "property_type": "text"
}
]
Create a new Custom Property Definition in the system.
write
) 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. |
{- "property_name": "sector",
- "property_type": "text"
}
{- "title": "400 Bad Request",
- "description": "The request body was not structured correctly."
}
Get the Custom Property Definition information stored inside the system.
read
) property_name required | string non-empty Example: sector |
{- "property_name": "sector",
- "property_type": "text"
}
Rename a Custom Property Definition.
write
) property_name required | string non-empty Example: sector |
property_name required | string non-empty The name of the custom property. |
{- "property_name": "sector"
}
{- "title": "400 Bad Request",
- "description": "The request body was not structured correctly."
}
Remove a Custom Property Definition from the system.
write
) property_name required | string non-empty Example: sector |
{- "title": "401 Unauthorized",
- "description": "OAuth access token is missing, invalid or expired."
}
Fetch all Occupation properties from the system (if any exists, otherwise an empty list is returned).
read
) 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. |
[- {
- "property_name": "language",
- "property_value": "Dutch"
}, - {
- "property_name": "start_date",
- "property_value": "20200112"
}, - {
- "property_name": "experience",
- "property_value": 5
}
]
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).
write
) 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. |
property_name | string non-empty |
object |
[- {
- "property_name": "language",
- "property_value": "Dutch"
}, - {
- "property_name": "start_date",
- "property_value": "20200112"
}, - {
- "property_name": "experience",
- "property_value": 5
}
]
{- "title": "400 Bad Request",
- "description": "The request body was not structured correctly."
}
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).
write
) 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. |
property_name | string non-empty |
object |
[- {
- "property_name": "language",
- "property_value": "Dutch"
}, - {
- "property_name": "start_date",
- "property_value": "20200112"
}, - {
- "property_name": "experience",
- "property_value": 5
}
]
{- "title": "400 Bad Request",
- "description": "The request body was not structured correctly."
}
Drop all Occupation properties from the system (if any exists).
write
) 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. |
{- "title": "401 Unauthorized",
- "description": "OAuth access token is missing, invalid or expired."
}
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!
read
) 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. |
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. |
{- "external_id": "a3903505-eb84-42dc-a79f-5e7b1fe897b7",
- "skills": [
- {
- "skill": "Machine Learning",
- "score": 3.18
}, - {
- "skill": "Python",
- "score": 5
}, - {
- "skill": "Tensorflow",
- "score": 4.35
}
]
}
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.
write
) 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. |
feedback_format | string Default: "skills" Enum: "skills" "competencies" Example: feedback_format=skills The format in which feedback for the skill profile is given. |
Array of objects (SkillWithScoreArray) The skills contained in this profile, along with their scores. |
{- "skills": [
- {
- "skill": "Machine Learning",
- "score": 3.18
}, - {
- "skill": "Python",
- "score": 5
}, - {
- "skill": "Tensorflow",
- "score": 4.35
}
]
}
{- "title": "400 Bad Request",
- "description": "The request body was not structured correctly."
}
Get the total number of Occupation objects stored inside the system.
read
) {- "entity_type": "Occupation",
- "entity_id": "a3903505-eb84-42dc-a79f-5e7b1fe897b7",
- "metric_name": "count",
- "metric_value": 1000,
- "last_update": "2020-09-01T11:45:49Z"
}
Search for Occupations similar to the provided job title. The most similar Occupations in the system are returned first.
read
) 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. |
{- "title": "Python Developer",
- "limit": 10
}
{- "title": "Python Developer",
- "matches": [
- {
- "external_id": "a3903505-eb84-42dc-a79f-5e7b1fe897b7",
- "occupation_name": "Python Engineer",
- "score": 0.93657
}
]
}
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.
read
) [- "5cbdbdbe-5f44-4423-8157-520f8a2f429a",
- "62d2c013-ab77-410e-b5fb-2f96eed9c1db",
- "6129e3f1-663f-44ea-aa3f-2ce1077b834c"
]
Submit new Competency information to initialise its Skill Profile inside the Skill Engine API.
write
) 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. |
{- "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"
}
{- "title": "400 Bad Request",
- "description": "The request body was not structured correctly."
}
Get the Competency information stored inside the system.
read
) 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. |
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. |
{- "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"
}
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.
write
) 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. |
competency_name | string non-empty Name of the Competency. |
competency_description | string non-empty Textual description of the Competency. |
{- "competency_name": "Audit",
- "competency_description": "The ability and skill to conduct audits, identifying exceptions and developing specific solutions or recommendations"
}
{- "title": "400 Bad Request",
- "description": "The request body was not structured correctly."
}
Remove a Competency from the system. This step deletes all information linked exclusively to this Competency and cannot be undone.
write
) 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. |
{- "title": "401 Unauthorized",
- "description": "OAuth access token is missing, invalid or expired."
}
Get a list of all the Custom Property Definitions stored inside the system.
read
)