The Get DHS Services API

Using the Get DHS Services API, you can view the list of DHS services in a data store.
METHOD GET
URI 
https://<historianservername>/historian-rest-api/v1/dhsservices?dHSServiceMask=&withReason=false
SAMPLE QUERY PARAM GET URL 
https://<historianservername>/historian-rest-api/v1/dhsservices?dHSServiceMask =*&withReason=false
SAMPLE RESPONSE 
{

    "ErrorCode": 0,

    "ErrorMessage": null,

    "Data": [

        {

            "LogicalName": "ConfigManager_NPI212611749M1",

            "NodeName": "NPI212611749M1",

            "ServiceType": 4,

            "Status": 1,

            "TCPPort": 14002

        },

        {

            "LogicalName": "DataArchiver_NPI212611749M1",

            "NodeName": "NPI212611749M1",

            "ServiceType": 2,

            "Status": 1,

            "TCPPort": 14001

        },

        {

            "LogicalName": "ClientManager_NPI212611749M1",

            "NodeName": "NPI212611749M1",

            "ServiceType": 3,

            "Status": 1,

            "TCPPort": 14000

        },

        {

            "LogicalName": "DiagnosticsManager_NPI212611749M1",

            "NodeName": "NPI212611749M1",

            "ServiceType": 5,

            "Status": 1,

            "TCPPort": 14003

        },

        {

            "LogicalName": "DataArchiver_distmachine2",

            "NodeName": "distmachine2",

            "ServiceType": 2,

            "Status": 0,

            "TCPPort": 14001

        },

        {

            "LogicalName": "DataArchiver_distmachine1",

            "NodeName": "distmachine1",

            "ServiceType": 2,

            "Status": 1,

            "TCPPort": 14001

        },

        {

            "LogicalName": "ClientManager_distmachine1",

            "NodeName": "distmachine1",

            "ServiceType": 3,

            "Status": 1,

            "TCPPort": 14000

        },

        {

            "LogicalName": "DiagnosticsManager_distmachine1",

            "NodeName": "distmachine1",

            "ServiceType": 5,

            "Status": 0,

            "TCPPort": 14003

        }

    ]

}

 }
SAMPLE cURL COMMAND 
curl -i -H "Accept: application/json" -H "Authorization: Bearer <TOKEN>” 
https://<historianservername>/historian-rest-api/v1/dhsservices?dHSServiceMask=*&withReason=false

Query Parameters

Parameter Description Required? Values
withReason Indicates whether the reason must be retrieved in the API response. Yes Boolean
dHSServiceMask The value of the DHS service mask. 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.