The DHS Service Port Update API

Using the DHS Service Port Update API, you can change the port and other details of a DHS service.
METHOD PUT
URI
	
https://<historianservername>/historian-rest-api/v1/dhsservice/<DHS service name>
SAMPLE URI
https://<historianservername>/historian-rest-api/v1/dhsservice/ DataArchiver_xxx

{

   "LogicalName": "DataArchiver_xxx",

   "NodeName": "xxx",

   "ServiceType": 2,

   "Status": 1,

   "TCPPort": 14005

}
SAMPLE RESPONSE
{

    "ErrorCode": 0,

    "ErrorMessage": null,

    "Data": {

        "LogicalName": "DataArchiver_xxx",

        "NodeName": "xxx",

        "ServiceType": 2,

        "Status": 1,

        "TCPPort": 14005

    }

}
SAMPLE cURL COMMAND
curl -i -H "Accept: application/json" -i -H "Content-Type: application/json"
-H "Authorization: Bearer <TOKEN>” -d “{ \” LogicalName \”:\” DataArchiver_xxx \”,
\" NodeName \": \"xxx\"\”,\" ServiceType \": 2,\" Status\": 1, \" TCPPort \": 14005}” -X PUT 
https://<historianservername>/historian-rest-api/v1/dhsservice/DataArchiver_xxx

Query Parameters

Parameter Description Required? Values
Payload Contains the values of the attributes of the data store that you want to change. Yes Multiple

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.