The Get Data Stores API

Using the Get Data Stores API, you can view the list of data stores in a system.
METHOD GET
URI
https://<historianservername>/historian-rest-api/v1/datastores?dataStoreMask=
SAMPLE QUERY PARAM GET URL
https://<historianservername>/historian-rest-api/v1/datastores?dataStoreMask=*
SAMPLE RESPONSE
{

    "ErrorCode": 0,

    "ErrorMessage": null,

    "Data": [

        {

            "Description": "The System Data Store.",

            "Id": "D3C23639-81CD-40F7-9CB0-37484FC5190D",

            "IsDefault": false,

            "IsSystem": true,

            "Name": "System",

            "NumberOfTags": 0,

            "State": 2,

            "DHSStorageName": "System Storage",

            "StorageType": 0,

            "Links": [

                {

                    "Rel": "self",

                    "Href": "/datastore/System"

                }

            ]

        },

        {

            "Description": "The Scada Buffer Data Store.",

            "Id": "39B39D42-DC7A-4048-9BA8-E4BAB4644B0C",

            "IsDefault": false,

            "IsSystem": false,

            "Name": "ScadaBuffer",

            "NumberOfTags": 0,

            "State": 2,

            "DHSStorageName": "xyz",

            "StorageType": 1,

            "Links": [

                {

                    "Rel": "self",

                    "Href": "/datastore/ScadaBuffer"

                }

            ]

        },

        {

            "Description": "The DHS System Data Store.",

            "Id": "56C1DFE9-D0BF-427F-B5D8-B127E38B5C11",

            "IsDefault": false,

            "IsSystem": false,

            "Name": "DHSSystem",

            "NumberOfTags": 0,

            "State": 2,

            "DHSStorageName": "xyz",

            "StorageType": 0,

            "Links": [

                {

                    "Rel": "self",

                    "Href": "/datastore/DHSSystem"

                }

            ]

        },

        {

            "Description": "The User Data Store.",

            "Id": "33BA016D-B005-4702-96DB-42CF7238C8FF",

            "IsDefault": true,

            "IsSystem": false,

            "Name": "User",

            "NumberOfTags": 5,

            "State": 2,

            "DHSStorageName": "xyz",

            "StorageType": 0,

            "Links": [

                {

                    "Rel": "self",

                    "Href": "/datastore/User"

                }

            ]

        }

    ]

}

   }

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

Query Parameters

Parameter Description Required? Values
dataStoreMask The value of the data store mask. No 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.