NextGen APIs
NextGen APIs
Breadcrumbs

POST /integration/workforce/r1/resource-skills

Http Verb

POST

Url

/integration/workforce/r1/resource-skills

Permissions required

Core Additional Parameters: Edit (fsm.core.additionalparameter.edit)

Resource Configuration: View (fsm.core.resource.configuration.view)

Last Modified Version

r1

Tech Tags


Available Async

No

BPMN Diagram

diagram (27).svg

Business Logic

This Integration API creates or updates the relationship between a Resource and its Skills.

The system searches only for resources that are not on loan, but at the level of private APIs, the creation/update of skill relationships also occurs on resources that are on loan.

System verifies Permission Required and starts the elaboration that is organized in steps.

STEP 1 - External System Validation

System takes Input fields and checks their existence in internal configuration.

API Verb: GET

Resource: External Systems

Input: externalSystemCode, active=true

Output: externalSystemId

If System can obtain the Output fields → continue to next step.

If System can’t obtain the Output fields → responds with error. Elaboration is stopped.

Error Type:

STEP 2 - Resource Existence

System takes Input fields and checks their existence in internal configuration.

API Verb: GET

Resource: Resources

Input: identificationNumber, loan=false

Output: resourceId

If System can obtain the Output fields → continue to next step.

If System can’t obtain the Output fields → responds with error. Elaboration is stopped.

Error Type:

STEP 3 - Skills Management

The following steps are executed for each Skill in input.

STEP 3a - Skill Validation

System takes Input fields and checks their existence in internal configuration.

API Verb: GET

Resource: Skills

Input: code, active=true

Output: skillId

If System can obtain the Output fields → continue to next step.

If System can’t obtain the Output fields → responds with error. Elaboration is stopped.

Error Type:

STEP 3b - Skill Level Validation

System takes Input fields and checks their existence in internal configuration.

API Verb: GET

Resource: Skill Levels

Input: levelCode

Output: skillLevelId

If System can obtain the Output fields → continue to next step.

If System can’t obtain the Output fields → responds with error. Elaboration is stopped.

Error Type:

STEP 3c - Resource Skill Relationship Existence

System takes Input fields and checks their existence in internal configuration.

API Verb: GET

Resource: {resourceId}/skills/{skillId}

Input: resourceId, skillId

Output: resourceSkillId

If System can obtain the Output fields → Update → continue to step Resource Skill Relationship Update.

If System can’t obtain the Output fields → Creation → continue to step Resource Skill Relationship Creation.

Error Type:

  • Others - see link in Resource

STEP 3d - Resource Skill Relationship Creation

System takes Input fields and creates the entity.

API Verb: POST

Resource: {resourceId}/skills

Input: resourceId, skillId, skillLevelId

Output: Response State

If Response State is SUCCESS → elaboration is stopped. See Response payload fields.

If Response State is ERROR → elaboration is stopped. See Response payload fields.

Error Type:

  • Others - see link in Resource

STEP 3e - Resource Skill Relationship Update

System takes Input fields and updates the entity.

API Verb: PATCH

Resource: {resourceId}/skills/{skillId}

Input: resourceId, skillId, skillLevelId

Output: Response State

If Response State is SUCCESS → elaboration is stopped. See Response payload fields.

If Response State is ERROR → elaboration is stopped. See Response payload fields.

Error Type:

  • Others - see link in Resource

Path Parameters

As their name suggests, they are included in the URL path of the endpoint.

Not applicable.

Query String Parameters

Start with a ? and includes parameters listed one after the another separated by &.

Not applicable.

Header Parameters

Parameters included in the request headers. Generally, request headers are used to keep authorization parameters.

Default.

Request Body Parameters

Request body parameters are used when clients send data to the API. They are shipped in a JSON Object only in POST, PUT, or PATCH requests.

 

Field

Description

Mandatory

Constraint

1

resource

externalSystemCode

External System Code

Y

Not Blank

2

identificationNumber

Resource Identification Number

Y

Not Blank

3

skills

(minOccurs=1,

maxOccurs=N)

code

Skill Code

Y

Not Blank

4

levelCode

Skill Level Code

Y

Not Blank

The objects in input could have also the extension object that allows to add additional, customized data to this API. More info here How to use APIs: Custom data via Extension.

Request example

JSON
{ 
  "extension": {},
  "resource": {
    "extension": {
        "myFieldName": "myValue"
    },
    "externalSystemCode": "SAP",
    "identificationNumber": "res-8990"
  },
  "skills": [ 
    {
      "extension": {
         "myFieldName": "myValue"
      },
      "code": "ELEC",
      "levelCode": "3"
    }
  ]
}

 

Response documentation

Response payload fields

Compliant with RFC Standard https://www.rfc-editor.org/rfc/rfc9457.html

Extension fields:

Field

Description

Note

code

Extension member of a Problem Details Object that contains the error code

Only for ERROR

Response example

JSON
{
  "type": "about:blank",
  "title": "Not Found",
  "status": 404,
  "detail": "External system string does not exist",
  "instance": "/integration/workforce/r1/resource-skills",
  "code": "IA001_001"
}

 Response error codes