Migrating from Internal System Integration

This guide will highlight the breaking changes you need to be aware of when migrating from Internal System Integration to Custom Integration.

While Internal System Integration is still functioning for those who use it, migrating to the newer type is encouraged, as any new features will only be supported on the newer type.

Setting up the integration from the UI

As part of the migration, you will need to add a Custom System from the MineOS UI, and delete your existing Internal System from your data inventory.

More information:

Internal system integration was setup by: Data Inventory -> Data Sources -> Add -> Internal System Integration

The new Custom Integration is setup by: Data Inventory -> Data Sources -> Add -> Custom System

Request Payload

There are some minor changes in the request payload that is sent to your endpoint.

• integrationId- this new property is sent with each request. Use this value when calling the Update custom integration status endpoint. This was introduced to support more than one instance of custom integration.
• ticketInfo was renamed request
• evidence was removed. If you need to obtain evidence information, you can call Ticket endpoint.
• eventId was renamed to traceId

Delete Response Code

You will need to change the response code you send back to MineOS from 200 OK to 202 Accepted.

More information:

Internal system integration required you to return 200 OK to signal MineOS the request was received and the deletion process started.

In Custom Integration, you can return 202 Accepted to signal MineOS the request was received and the deletion process started.

You can also return 200 OK to signal the deletion process has completed. In this case you don't need to call the Update Status Endpoint.

Update Status Endpoint

You will need to change the update status API call from Update internal system integration status to using the new Update custom integration status.