Entities

We built the Skill Engine API around a domain-driven philosophy: our goal is to express functionality in the same language that our customers and end-users speak. That way, the Skill Engine API maps onto your use case with the least amount of friction. This page describes the available entity types and their meaning and functionality.

Throughout this developer portal, entity names are capitalized. For example, 'Employee' indicates an Employee entity.

The Skill Engine API supports four entity types:

  • Employee: represents either a person within your organization or a candidate within the job market.
  • Vacancy: corresponds to job postings or open positions.
  • Course: any internal or external training or education.
  • Occupation: a generic role or function defined by your organization.
Entity
external_id
custom_properties
skill_profile
Employee
location
languages
desired_functions
skill_events
...
Vacancy
location
job_title
job_description
...
Course
course_title
course_description
...
Occupation
occupation_name
occupation_description
occupation_titles
...

All of these entities share the following properties:

  1. An entity in the Skill Engine API corresponds to the same one in your organization and is mapped one-on-one with them. For example, each Employee entity links to one (and only one) employee in your core systems.
  2. An entity has a single and meaningful skill profile.
  3. An entity's lifecycle is explicitly managed: you are in control of its continued existence.
  4. An entity can have custom properties that are used for filtering, enhanced matching, and advanced querying.

Flexible Data Models

We know that your use case may require unique business logic. We accommodated the Skill Engine to integrate your logic on demand. It has customization built-in, rather than worrying about it after the fact.

Do you want to use properties like work regimes, country preferences, or ratings? Custom properties will be your go-to tool. Head over to the custom properties tutorial to get started with your desired custom properties. We also provide our customers with integration support, so if you want to learn even more about mapping your use case, don't hesitate to get in touch!