|
Http Verb |
DELETE |
|---|---|
|
Url |
/integration/territory/organizational-structures/r1/operation-centers/{code} |
|
Permissions required |
Core Additional Parameters: Edit (fsm.core.additionalparameter.edit) Organizational Structure Entities: View (fsm.core.structure.view) Organizational Structure Entities: Edit (fsm.core.structure.edit) |
|
Last Modified Version |
r1 |
|
Tech Tags |
|
|
Available Async |
No |
BPMN Diagram
.svg?cb=b30c85ed2fa2721db0a436edf6247d04)
Business Logic
This Integration API logically deletes an existing Operation 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.
STEP 2 - Operation Center 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 3 - Operation Center Update
System takes Input field and updates the entity.
API Verb: PATCH
Resource: Operation Center
Input: operationCenterId, active = false
Output: Response State, code
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.
|
Field |
Description |
Mandatory |
Constraint |
|
|---|---|---|---|---|
|
1 |
code |
Operation center code |
Y |
Not Blank |
Query String Parameters
Start with a ? and includes parameters listed one after the another separated by &.
Filters
|
Field |
Description |
Mandatory |
Constraint |
|
|---|---|---|---|---|
|
1 |
externalSystemCode |
External System Code |
Y |
Not Blank |
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/territory/organizational-structures/r1/operation-centers/OC-123?externalSystemCode=SAP
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
{
"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"
}