REST
Playground
Swagger documentation for this connector is available on our playground environment. It is also possible to test the connector on this page, use the parameters below to try it out!
Parameter
Description
URL
ApiKey
0DBFC5A3067F4E7F97CD2808B1C54A1B
EquipmentId
Use value '00001'
ProcessFunctionId
Use value 'N.PRO.02'
MeasurementPointId
Use value 'DEFAULT' or create one first
Basic URL (POST):
https://customer.ultimo.com/api/V1/Action/REST_CreateEquipmentMeasurementPoint
Header data:
Parameter
Description
ApiKey
Request an API key at (application manager or consultant)
ApplicationElementId
Fixed value “a90b326b-ff33-421a-a3a8-7d674e37ae22”
Body (example) with measurement point for equipment:
Process function
Create measurement points for a process function
Basic URL (POST):
https://customer.ultimo.com/api/V1/Action/REST_CreateProcessFunctionMeasurementPoint
Header data:
Parameter
Description
ApiKey
Request an API key at (application manager or consultant)
ApplicationElementId
Fixed value “59275fff-2bcb-425c-a933-90513542c212”
Body (example) with measurement point for process function:
Equipment measurement point
Measurements for an equipment measurement point
Basic URL (POST):
https://customer.ultimo.com/api/V1/Action/REST_EquipmentMeasurementPointValue_Import
Header data:
Parameter
Description
ApiKey
Request an API key at (application manager or consultant)
ApplicationElementId
Fixed value “e57ecb14-6c6f-46ff-fbf7-e65c22a3df61”
Body (example) with absolute value:
Body (example) with delta:
Process function measurement point
Measurements for a process function measurement point
Basic URL (POST):
https://customer.ultimo.com/api/V1/Action/REST_ProcessFunctionMeasurementPointValue_Import
Header data:
Parameter
Description
ApiKey
Request an API key at (application manager or consultant)
ApplicationElementId
Fixed value “7dc5815c-1cce-470f-9656-02113d13e635”
Body (example) with absolute value:
Body (example) with delta:
Responses
When the measurement or measurement point is accepted:
Status: 200 OK
When the measurement is rejected:
Status: 400 Bad Request
When the measurement point is rejected:
Status: 400 Bad Request
When the API-key is invalid (for a measurement or a measurement point):
Status: 401 Unauthorized
Other:
Status: 500 Internal Server Error
Last updated