This operation retrieves a list of the regions that are defined in the CommCell environment, with each region's properties.
Request
Syntax
Send the request using either XML or JSON.
GET <webservice>/Regions?propertyLevel=BasicProperties
Host: <host name>
Accept: application/xml
Authtoken: <authentication token>
where <webservice> is the root path used to route the API requests to the Web Server.
For more information, see Available Web Services for REST API.
Request Parameters
Name | Description | Required |
---|---|---|
propertyLevel | The response type of the browse request. Valid value is BasicProperties. | Yes |
Request Headers
Name | Description |
---|---|
Host | The host name of the Web Server or Web Console used in the API request. |
Accept | The format of the response. Valid values are: application/xml or application/json. |
Authtoken | The authentication token that is received after a successful log on. For information about receiving an authentication token, see Authentication. |
Response
Response Parameters
Parameter | Description | Element |
---|---|---|
regionType | The type of region. Valid value is 0. | regions |
regionId | The ID assigned to a region. | regionEntity |
displayName | The display name assigned to a region. | regionEntity |
regionName | The actual name of the region. | regionEntity |
Examples
Sample Request
GET <webservice>/Regions?propertyLevel=BasicProperties
Host: client.mydomain.com
Accept: application/json
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc60f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef768fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f3233d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8
Sample Response
{
"regions": [
{
"regionType": 0,
"regionEntity": {
"regionId": 1,
"displayName": "Africa",
"regionName": "Africa"
}
},
{
"regionType": 0,
"regionEntity": {
"regionId": 2,
"displayName": "Asia",
"regionName": "Asia"
}
},
]
}