The Restart Collector API

Using the Restart Collector API, you can restart a collector.
METHOD PUT
URI 
https://<historianservername>/historian-rest-api/v1/collector/restart
SAMPLE URI 
https://<historianservername>/historian-rest-api/v1/collector/restart

Payload
{
   ?interfaceName":"RSSERVER2012-02_Simulation" 
   "winUserName":"",
   "winPassword":""                   
}
SAMPLE RESPONSE 
{
    "ErrorCode": 0,
    "ErrorMessage": null,
    "Data": "Collector Restart Initiated"
}
SAMPLE cURL COMMAND 
curl -i -H "Accept: application/json" -i -H "Content-Type: application/json" 
-H "Authorization: Bearer <TOKEN> -d  ?{ \ ?interfaceName\ ?:\ ?RSSERVER2012-02_Simulation \ ?} -X PUT https://<historianservername>/historian-rest-api/v1/collector/restart

Query Parameters

Query parameters include the Payload parameter, which is a JSON file, which contains the following properties.

Parameter Description Required? Values
interfaceName The interface name of the collector. Yes String
winUserName The Windows username. Yes String
winPassword The Windows password Yes String

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.
Data String No Indicates if the task has been initiated.