List all sites
GET {{baseUrl}}/sites?nodeId=<string>&number=0&size=10&filter=<string>&sort=<string>
Lists all sites
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
nodeId | string | Specifies the ID of the relevant tree node | |
number | number | Index of page to be returned. Number of available pages is returned in response body property page.totalPages. | |
size | number | Specifies the number of elements in a page. Maximum number of resources to be returned per page. The service might return less resources. | |
filter | string | JSON string allowing to filter for the following optional fields and operations. |
JSON string can contain following fields:
- id E.g.: {"id":275}
- name E.g.: {"name":"CISCO"}
- parentId E.g.: {"parentId":263}
In the following, an unencoded example filter value is shown, to return the connector instances for given asset and parameters.
{
"name":"CISCO"
}
|
| sort | string | | Specifies the fields to sort the results by.
Ex: GET /resources?sort=-color,+name : Sorts the results based on descending color order and ascending name order. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
If-None-Match | string | Specifies the ETag of the resource | |
x-user-role | string | (Required) Specifies the user role with which the user intends to perform the operation | |
Accept | string |
RESPONSES
status: OK
{"sites":[{"id":"a1b2c3d4","name":"Berlin","nodeId":"a1b2c3d4","path":"/1/134/230","pathName":"/WORLD/Europe/Berlin","accessControl":{"accessLevel":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"contactEmail":"john_doe@server.org","timezone":"Europe/Berlin","country":{"alpha2Code":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"name":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"meta":{"version":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}},{"id":"a1b2c3d4","name":"Berlin","nodeId":"a1b2c3d4","path":"/1/134/230","pathName":"/WORLD/Europe/Berlin","accessControl":{"accessLevel":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"contactEmail":"john_doe@server.org","timezone":"Europe/Berlin","country":{"alpha2Code":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"name":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"meta":{"version":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}}],"meta":{"page":{"totalPages":92602278,"number":1200859,"size":-46324019,"elements":78336751,"totalElements":-59805914}}}