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	https://devdocs.ultimo.net/docs/index.html?version=v1&apiKey=A655245BECB74A7285B52FB26A9C2ACC
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:

{
 "EquipmentId": "00001",
 "MeasurementPointId": "TEMP",
 "Description": "Description for measurement point"
}

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:

{
 "ProcessFunctionId": "00001",
 "MeasurementPointId": "TEMP",
 "Description": "Description for measurement point"
}

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:

{
    "EquipmentId": "00001",
    "MeasurementPointId": "TEMP",
    "Date": "2018-08-20 15:57:59",
    "Value": "22",
    "Text": "Some remarks for measurement"
}

Body (example) with delta:

{
    "EquipmentId": "00001",
    "MeasurementPointId": "RUNHOURS",
    "Date": "2018-08-21 15:17:59",
    "Delta": "5",
    "Text": "Some remarks for measurement"
}

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:

{
    "ProcessFunctionId": "0001",
    "MeasurementPointId": "RUNHOURS",
    "Date": "2018-08-21 15:17:59",
    "Value": "25482",
    "Text": "Some remarks for measurement"
}

Body (example) with delta:

{
    "ProcessFunctionId": "0001",
    "MeasurementPointId": "RUNHOURS",
    "Date": "2018-08-21 15:17:59",
    "Delta": "5",
    "Text": "Some remarks for measurement"
}

Responses

When the measurement or measurement point is accepted:

Status: 200 OK

{
    "properties": {} 
}

When the measurement is rejected:

Status: 400 Bad Request

{
    "message": "Value 5 measured on 21-8-2018 15:17 cannot be processed.\r\nCause: measurement point '000011222 - DEFAULT' was not found.",
    "type": 3, 
    "code": "3095" 
}

When the measurement point is rejected:

Status: 400 Bad Request

{
 "message": "Measurement point cannot be added.\r\nCause:equipment '000011222' was not found.",
 "type": 3,
 "code": "3395"
}

{
 "message": "Measurement point TEMP cannot be added.\r\nCause: equipment 00001 has already been linked to the selected measurement point.",
 "type": 3,
 "code": "0687"
}

When the API-key is invalid (for a measurement or a measurement point):

Status: 401 Unauthorized

{
    "message": "The API key is invalid",
    "code": "InvalidApiKey"
}

Other:

Status: 500 Internal Server Error

{
    "message": "An error has occured", 
    "exceptionType": "System.FormatException", 
    "detailMessage": "Guid should contain 32 digits with 4 dashes (xxxxxxxx-xxxx-xxxx-xxxx-xx)",  
    "type": 1, 
    "stackTrace": " at System.Guid.TryParseGuidMithDashes (....)”,
    "code": "InternalServerError" 
}