Add aptitudes

This endpoint allows to register a list of aptitudes for an employee.

POST /api/v1/import/aptitudes

Below is an explanation of each field in the request body.

All fields in this request are mandatory, hence they are marked with an asterisk (*).

Request body

JSON Analysis 
{
  "business": "string",
  "employeeId": "string",
  "aptitudes": [
    {
      "productId": "string",
      "aptitudes": [
        {
          "locationId": "string",
          "level": 0
        }
      ]
    }
  ]
}
Details

  • business*: external business identifier.

  • employeeId*: external employee identifier.

  • aptitudes*: set of aptitudes to be defined for the employee regarding tasks for a product.

    • productId*: external identifier of the product or section for the employee.

    • aptitudes*: list of aptitudes. Each aptitude is composed of the following fields:

      • locationId*: external identifier of the task to which the aptitude refers.

      • level*: level of competency for the task, ranging from 0 (not competent) to 3 (expert).

Request example

Once the fields have been analyzed, below is an example of the request:

POST /api/v1/import/aptitudes
{
  "business": "BUSINESSID",
  "employeeId": "001",
  "aptitudes": [
    {
      "productId": "0001-G",
      "aptitudes": [
        {
          "locationId": "01",
          "level": 3
        },
        {
          "locationId": "02",
          "level": 1
        }
      ]
    }
  ]
}

If the request data is correct, the request will return a 200 OK status.

Considerations

If the employee ID does not match any employee in the business, the request will return a 404 Not Found error, indicating Employee not found.

The task identifier (locationId) must match the one configured in Orquest at the business level: Organizational Diagram > Tasks > Outer id. If the task identifier does not match what has been configured in Orquest, the request will return a 404 Not Found error, indicating Location not found.

If duplicate aptitudes are included in the creation, the request will return a 409 Conflict error, indicating could not execute statement […​].

Accepted values for level are 0, 1, 2 and 3. Any other value will result in an error.

The same level of competence will be set for all zones of the product that have the task enabled.

Useful links

What is an aptitude?

What is a task?