TileCategory
TileCategory Service
Web service endpoints for retrieving categories of tiles definitions.
Get Tile Categories
GET /tiles/categoriesReturn a paginated list of tile categories that match the specified filter criteria. Tile categories
that are hidden will not be returned.
This service supports the following filters. Parameters, when used, should be wrapped
in parentheses, and multiple values separated by commas. See the examples for clarification.
| Filter |
Params |
Example |
| tileState |
one or more tile states, separated by commas. By default all tile definitions
will be included.
|
?filter=tileState(published,archived) |
Query Parameters:
| Name | Type | Required | Description |
|---|
| startIndex | Integer | false | Starting index (offset) for categories in this request |
| count | Integer | false | Maximum number of categories to return in this request |
| filter | Object[] | false | The filter criteria used to select category objects |
| fields | String | false | Fields to be returned |
Retrieves:
TileCategory[]Return Status:
| HTTP Status Code | Description |
|---|
| 200 (OK) | Request was successful |
| 400 (Bad Request) | An input field is malformed |
Get Tile Category
GET /tiles/categories/{tileCategoryID}Return the specified tile category with the specified fields.
Path Parameters:
| Name | Type | Required | Description |
|---|
| tileCategoryID | String | true | ID of the tile category to be returned |
Query Parameters:
| Name | Type | Required | Description |
|---|
| fields | String | false | Fields to be returned |
Retrieves:
TileCategory containing the specified tile categoryReturn Status:
| HTTP Status Code | Description |
|---|
| 400 (Bad Request) | An input field is malformed |
| 404 (Not Found) | The specified tile category does not exist |
