The Data Store Update API

Using the Data Store Update API, you can modify a data store.
METHOD PUT
URI
https://<historianservername>/historian-rest-api/v1/dataStore/<data store name>
SAMPLE URI
https://<historianservername>/historian-rest-api/v1/dataStore/mirror1DS1
Payload

{

            "Description": "testing",

            "Id": "5761BCBF-A04D-494F-AE6E-30F8652F4B96",

            "IsDefault": true,

            "IsSystem": false,

            "Name": "mirror1DS1",

            "NumberOfTags": 0,

            "State": 2,

            "DHSStorageName": "mirror1",

            "StorageType": 0,

            "Links": [

                {

                    "Rel": "self",

                    "Href": "/datastore/mirror1DS1"

                }

            ]

        }
SAMPLE RESPONSE
{

    "ErrorCode": 0,

    "ErrorMessage": null

}
SAMPLE cURL COMMAND
curl -i -H "Accept: application/json" -i -H "Content-Type: application/json"
-H "Authorization: Bearer <TOKEN>” -d “{ \” Description\”:\”des\”,\"IsDefault \": true,
\” IsSystem \”:false, \” Name\”:\” mirror1DS1\”,\”NumberOfTags \”:0,\”State\”:2,
\”DHSStorageName\”:\”mirror1\”,\”StorageType \”:0,\”Links\”: [{\"Rel\":\"self\",
\"Href\": \"/datastore/mirror1DS1\" }]}” -X PUT https://<historianservername>/historian-rest-api/v1/dataStore/mirror1DS1

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.