NextGen APIs
NextGen APIs
Breadcrumbs

GET /integration/territory/organizational-structures/r1/work- centers (WIP)

Http Verb

GET

Url

/integration/territory/organizational-structures/r1/work- centers

Permissions required

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

WO Configuration: View (fsm.core.workorder.configuration.view)

or

WO Configuration: Edit (fsm.core.workorder.configuration.edit)

Last Modified Version

r1

Tech Tags

MULTILANGUAGE-FIELDS

Available Async

No

BPMN Diagram (TBD)


Business Logic

This Integration API retrieves the value of Operation Center starting from Work Center.

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 - Work Center Validation

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

API Verb: GET

Resource: Work Centers

Input: code, active=true

Output: workCenterId, description

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

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

Error Type:

IA002_009
IA002_010
IA002_017
Others - see link in Resource

STEP 3 - Operation Center Validation

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

API Verb: GET

Resource: /{workCenterId}/operation-centers

Input: workCenterId, active=true

Output: operationCenterId

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 24 - Operation Center Retrieve

API Verb: GET

Resource: Operation Centers

Input: operationCenterId

Output: operationCenterCode, operationCenterDescription

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:

  • 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 &.

Filter

Field

Description

Mandatory

Constraint

1

externalSystemCode

External system code

Y

Not Blank

2

code

Work Center Code

Y

Null or Not Blank

3

_page.number

Number of the page(0-based)

N

Integer

4

_page.size

Number of the element

N

Integer

Fields

The parameter _fields allows to choose output fields. More info here How to use APIs: Output fields selection.

Header Parameters

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

Default.

Request example

HTML
{baseUrl}/integration/territory/organizational-structures/r1/work-centers?externalSystemCode=SAP&code=ABC

Response documentation

Response payload fields

Field

Field Type

Description

1

id


Id of the resource created or updated

2

code


String Code of the work-centers

3

description


String Description of the work-centers

4

operationCenterCode


String Code of Operation Center

5

operationCenterId


Id NG of OperationCenter

6

operationCenterDescription


String Description of Operation Center

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
{
  "content": [
  {
    "id": 1581,
    "code": "WC_MECH_01",
    "description": "XXX",
    "operationCenterCode": "CO-1",
    "operationCenterId": 1,
    "operationCenterDescription" :"CALIFORNIA NORD"
    },
    {
    "id": 1581,
    "code": "WC_MECH_01",
    "description": "XXX",
    "operationCenterCode": "CO-2",
    "operationCenterId": 2,
    "operationCenterDescription" :"CALIFORNIA SUD"
    }
  ],
  "page": {
    "num": 0,
    "hasMore": true
  }
}

Error 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