List valid sites for a given department
Permission Level: Read
GET /users/department/{departmentName}/sites
Operation id: DepartmentService_ListValidSites
Tags: DepartmentService
Parameters
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
departmentName | string | Yes | Name of the department. Required: true |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
nextPageToken | string | No | Next page token. Required: false |
pageSize | integer (int32) | No | Number of sites returned per page. Required: false, Default: 10 |
tenantId | string | No | Tenant of the department. Required: false |
Security
- Authorization (apiKey)
- Bearer token
Responses
200 — A successful response.
Content type: application/json
default — An unexpected error response.
Content type: application/json
Response models
200 — A successful response.
Content type: application/json
Schema
| Property | Type | Required | Description |
|---|---|---|---|
sites | array | No | |
nextPageToken | string | No |
{
"type": "object",
"properties": {
"sites": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"parent": {
"type": "string"
},
"tenantId": {
"type": "string"
},
"ancestors": {
"type": "array",
"items": {
"type": "string"
}
},
"descendants": {
"type": "array",
"items": {
"type": "string"
}
},
"displayName": {
"type": "string"
},
"attributes": {
"type": "array",
"items": {
"type": "object"
}
},
"users": {
"type": "array",
"items": {
"type": "object"
}
},
"enabledScopes": {
"type": "object"
},
"creationTime": {
"type": "string",
"format": "date-time"
},
"domain": {
"type": "string"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"description": {
"type": "string"
},
"expiration": {
"type": "object"
},
"siteType": {
"type": "string"
},
"siteTier": {
"type": "string"
},
"isHierarchyNode": {
"type": "boolean",
"description": "True if is a Retail Operating Model \"Hierarchy Node\", false if it is a Retail Operating Model \"Site\".\nDefaults to a Retail Operating Model \"Site\" if not included."
}
}
}
},
"nextPageToken": {
"type": "string"
}
}
}
default — An unexpected error response.
Content type: application/json
Schema
| Property | Type | Required | Description |
|---|---|---|---|
code | integer (int32) | No | |
message | string | No | |
details | array | No |
{
"type": "object",
"properties": {
"code": {
"type": "integer",
"format": "int32"
},
"message": {
"type": "string"
},
"details": {
"type": "array",
"items": {
"type": "object",
"properties": {
"@type": {
"type": "string"
}
}
}
}
}
}