The Get Storages API

Using the Get Storages API, you can view the list of locations in a system.
METHOD GET
URI
https://<historianservername>/historian-rest-api/v1/storages?storageMask=
SAMPLE QUERY PARAM GET URL
https://<historianservername>/historian-rest-api/v1/storages?storageMask=*
SAMPLE RESPONSE
{

    "ErrorCode": 0,

    "ErrorMessage": null,

    "Data": [

        {

            "StorageName": "System Storage",

            "StorageType": 2,

            "NumberOfDataStores": 1,

            "NumberOfArchivers": 0,

            "DataStores": [

                "System"

            ],

            "Id": "861C2743-72E0-46FC-9B31-90E28CC39B8D",

            "IsDefault": false,

            "LastModifiedUser": null,

            "LastModifiedTime": "1970-01-01T00:00:00.000Z",

            "ArchiverServices": []

        },

        {

            "StorageName": "srinivaswin10",

            "StorageType": 0,

            "NumberOfDataStores": 3,

            "NumberOfArchivers": 1,

            "DataStores": [

                "ScadaBuffer",

                "DHSSystem",

                "User"

            ],

            "Id": "5F267DF3-879A-4222-8A0E-D31EDEA83C14",

            "IsDefault": true,

            "LastModifiedUser": null,

            "LastModifiedTime": "1970-01-01T00:00:00.000Z",

            "ArchiverServices": [

                {

                    "LogicalName": "DataArchiver_xyz",

                    "NodeName": "xyz",

                    "ServiceType": 2,

                    "TCPPort": 14001

                }

            ]

        }

    ]

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

Query Parameters

Parameter Description Required? Values
storageMask The value of the location 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.