GET /system/cloud/providers/atrius
FROM API REVISION 6.0
Used when you are operating a browser without access to the header parameter. This allows you to choose which encoding you want to use for the response:
All these resources can be used according what the resource allows.
To address the raw value of a primitive property, clients append a path segment containing the string $value to the property URL.
To use this query option you need to use the classic resource and add the element name you want to print followed by the query string name.
Be careful, the parameter query string is used in the URL and is not like other parameters.
The $select system query option allows clients to request a limited set of properties for each entity.
The value pass in the parameter can be:
If there is no value after the select query option, the parameter will be ignored. All the values that are not specified will not be printed in the response.
The $expand system query option specifies the related resources to be included in line with retrieved resources.
The value passed in the parameter can be:
The $expand system query option can be used with the $levels query option, to expand recursively.
If this parameter is not in the request, the Application/Json will be chosen by default.
There are multiple possible values (according the resource):
The first two are the most often used.
Cyclic navigation properties can be recursively expanded using the special $levels option. This query option is used in addition to the $expand query options.
The value of the $levels option is a positive integer to specify the number of levels to expand.
Object Name: AtriusProvider
| Property Name | Type | Description | Method |
|---|---|---|---|
| Connected | Boolean | True if the controller is connected to the provider; false otherwise. | GET |
| Id | String | The name of the provider. | GET |
| Name | String | The real name of the provider. | GET |
| Description | String | A little description about the provider. | GET |
| Enabled | Boolean | True to start the connection; false to stop the connection. | GET POST |
| ConnectionString | empty | The string is use for the connection. This property is a specific string recognise by the server to allow the controller access. | GET POST |
URL Example: https://0.0.0.0/api/rest/v1/system/cloud/providers/atrius
{
"id": "atrius",
"enabled": true,
"services": {
"href": "/api/rest/v1/system/cloud/providers/atrius/services",
"name": "services"
},
"connectionString": "HostName=HostnameValue;DeviceId=DeviceIDValue;SharedAccessKey=AccessKey",
"description": "",
"name": "Atrius",
"connected": true
}
URL Example: https://0.0.0.0/api/rest/v1/system/cloud/providers/atrius
<?xml version="1.0" encoding="utf-8"?>
<AtriusProvider>
<Connected>true</Connected>
<Id>atrius</Id>
<Name>Atrius</Name>
<Description />
<Enabled>true</Enabled>
<ConnectionString>HostName=HostnameValue;DeviceId=DeviceIDValue;SharedAccessKey=AccessKey</ConnectionString>
<Services>
<Href>/api/rest/v1/system/cloud/providers/atrius/services</Href>
<Name>services</Name>
</Services>
</AtriusProvider>