DELETE /integration/workforce/r1/resources/{identificationNumber}/skills

BPMN Diagram

Business Logic

This Integration API deletes the association between a Resource and a list of its Skills.

The system searches only for resources that are not on loan, but at the level of private APIs, the delete 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.

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.

STEP 2 - Resource Existence

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

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.

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.

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.

STEP 3c - Resource Skill Relationship Existence

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

If System can obtain the Output fields, compares this list with the list of Step Skill Validation → If the second one is completely contained in the first one → continue to next step.

If System can’t obtain the Output fields or the second one is not completely contained in the first one → responds with error. Elaboration is stopped.

STEP 4 - Resource Skill Relationship Deletion

System takes Input fields and deletes the entity.

The step is executed for each Skill in input.

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

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

Path Parameters

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

Query String Parameters

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

Filters

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.

Not Applicable

Request example

{baseUrl}/integration/workforse/r1/resourse/{indentificationNumber}/skills?externalSystemCode=SAP&skillCode=aa&skillCode=bbb&skillCode=ccc

Response documentation

Response payload fields

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

Extension fields:

Response example

{
  "type": "about:blank",
  "title": "Not Found",
  "status": 404,
  "detail": "External system string does not exist",
  "instance": "/integration/inventory/r1/materials/string?externalSystemCode=string",
  "code": "IA001_001"
}

 Response error codes