There are 5 endpoints available for the implementation of work order integration.
Create
Uri: /integration/api/v1/workOrders
Method: POST
Edit
Uri: /integration/api/v1/workOrders
Method: PATCH
Delete
Uri: /integration/api/v1/workOrders/{externalId/localId}
Method: DELETE
Detail
Uri: /integration/api/v1/workOrders/{externalId/localId}
Method: GET
List
Uri: /integration/api/v1/workOrders?page={pageNumber}
Method: GET
Headers for the request
Key | Value |
|---|---|
X-SIMA-APIKEY | {api_key} |
X-SIMA-SYSTEM-ID | {protocol_system_id} |
Accept | application/json |
Content-type | application/json |
Detail of the variables used
{api_key}: Authentication api key.
{externalId/localId}: Unique identifier of the system that integrates with SIMA of the integrated work order (externalId) or the unique identifier in SIMA (localId).
{pageNumber}: Requested page number from the list of integrated work orders.
{protocol_system_id}: Unique identifier assigned by SIMA to the integrated external entity or if you will integrate as a Third Party you must use the protocol_system_id = 8.