The Collector Mode API

Using the Collector Mode API, you can view the running mode of a collector.
METHOD GET
URI
https://<historianservername>/historian-rest-api/v1/collector/mode/<collector interface name>
SAMPLE QUERY PARAM GET URL
https://<historianservername>/historian-rest-api/v1/collector/mode/<collector interface name>
SAMPLE RESPONSE
{
    "ErrorCode": 0,
    "ErrorMessage": null,
    "Data": {
        "RunningMode": "Service Mode"
    }
}
SAMPLE cURL COMMAND
curl -i -H "Accept: application/json" -H "Authorization: Bearer <TOKEN>” 
https://<historianservername>/historian-rest-api/v1/collector/mode/<host name>_Simulation_<IP address>_2

Response Parameters

Parameter Data Type Required? Description
ErrorCode Integer Yes For example, ErrorCode = 0 implies the operation was successful.
ErrorMessage String Yes For example, NULL.