TileDefinition
TileDefinition Service
Web service endpoints for managing tile definitions.
Destroy Definition
DELETE /tileDefs/{tileID}Delete an existing custom tile definition that was created by the requesting user
Path Parameters:
| Name | Type | Required | Description |
|---|
| tileID | String | true | ID of the custom tile definition to be deleted |
Return Status:
| HTTP Status Code | Description |
|---|
| 400 (Bad Request) | An input field is malformed |
| 403 (Forbidden) | if the specified tile does not belong to the authenticated user |
| 404 (Not Found) | if the specified tile does not exist |
Get Definition
GET /tileDefs/{tileID}Return the specified tile definition with the specified fields.
Path Parameters:
| Name | Type | Required | Description |
|---|
| tileID | String | true | ID of the tile to be returned |
Query Parameters:
| Name | Type | Required | Description |
|---|
| fields | String | false | Fields to be returned |
Retrieves:
TileDefinition containing the specified tileReturn Status:
| HTTP Status Code | Description |
|---|
| 200 (OK) | Request was successful |
| 400 (Bad Request) | An input field is malformed |
| 404 (Not Found) | The specified tile does not exist |
Get I18n Resource
GET /tileDefs/{tileID}/i18nRetrieves the current i18n resource bundle for the default locale.
Path Parameters:
| Name | Type | Required | Description |
|---|
| tileID | String | true | ID of the tile to obtain the i18n resource |
Retrieves:
A Java properties file format, encoded ISO-8859-1Return Status:
| HTTP Status Code | Description |
|---|
| 200 (OK) | Request was successful |
| 404 (Not Found) | The request resource does not exist |
| 400 (Bad Request) | An input field is malformed |
Get I18n Resource
GET /tileDefs/{tileID}/i18n/{lang}Retrieves the current i18n resource bundle for a language.
Ensure that the language code specified is two characters, lower case and complies with
ISO-639-1.
Path Parameters:
| Name | Type | Required | Description |
|---|
| tileID | String | true | ID of the tile to obtain the i18n resource |
| lang | String | true | The ISO-639-1 language code |
Retrieves:
A Java properties file format, encoded ISO-8859-1Return Status:
| HTTP Status Code | Description |
|---|
| 200 (OK) | Request was successful |
| 404 (Not Found) | The request resource does not exist |
| 400 (Bad Request) | An input field is malformed |
Get I18n Resource
GET /tileDefs/{tileID}/i18n/{lang}/{country}Retrieves the current i18n resource bundle for a language and country.
Ensure that the language code specified is two characters, lower case and complies with
ISO-639-1.
Ensure that the country code specified is two characters, upper case and complies with
ISO-3166-1 alpha-2.
Path Parameters:
| Name | Type | Required | Description |
|---|
| tileID | String | true | ID of the tile to obtain the i18n resource |
| lang | String | true | The ISO-639-1 language code |
| country | String | true | The ISO-3166-1 alpha-2 country code |
Retrieves:
A Java properties file format, encoded ISO-8859-1Return Status:
| HTTP Status Code | Description |
|---|
| 200 (OK) | Request was successful |
| 404 (Not Found) | The request resource does not exist |
| 400 (Bad Request) | An input field is malformed |
Get Instances
GET /tileDefsReturn a paginated list of existing tiles in the system.
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 |
| name |
name of the tile definition
|
?filter=name(current-issues-tile) |
| addonUUID |
UUID of the add-on from which the tile definitions are supplied
|
?filter=addonUUID(b382192e-d292-4f21-b793-5664625b0212) |
| state |
one of the following states
| State |
Description |
| PUBLISHED |
The tile definition is available to be used for adding tile instances to template instances |
| ARCHIVED |
This tile definition is no longer available for adding tile instances to template instances |
| DISABLED |
This tile definition is disabled because features it rely on are not available in this system |
| LOCKED |
This is a custom tile used by one user and locked. This tile is also PUBLISHED |
| UNLOCKED |
This is a custom tile created by one user and unlocked. This tile is also PUBLISHED |
| GLOBAL_LOCKED |
This is a custom tile and can be used by one user and is locked. This tile is also PUBLISHED |
| GLOBAL_UNLOCKED |
This is a custom tile and can be used by any user. This tile is also PUBLISHED |
|
?filter=state(PUBLISHED) |
Query Parameters:
| Name | Type | Required | Description |
|---|
| startIndex | Integer | false | The zero-relative index of the first matching content to be returned |
| count | Integer | false | The maximum number of contents to be returned |
| fields | String | false | The fields to be returned on each content |
Retrieves:
TileDefinition[] of the matched tilesReturn Status:
| HTTP Status Code | Description |
|---|
| 200 (OK) | Request was successful |
| 400 (Bad Request) | An input field is malformed |
Get Prototype
GET /tileDefs/{tileID}/prototypeReturn a new tile instance, that is not persistent, based on the specified tile definition.
Path Parameters:
| Name | Type | Required | Description |
|---|
| tileID | String | true | ID of the tile to be returned |
Query Parameters:
| Name | Type | Required | Description |
|---|
| fields | String | false | Fields to be returned |
Retrieves:
TileDefinition containing the specified tileReturn Status:
| HTTP Status Code | Description |
|---|
| 200 (OK) | Request was successful |
| 400 (Bad Request) | An input field is malformed |
| 404 (Not Found) | The specified tile definition does not exist |
Get Tile Categories
GET /tileDefs/categoriesReturn a paginated list of content objects that match the specified filter criteria.
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
|
?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 /tileDefs/category/{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 |
| 403 (Forbidden) | You are not allowed to access the specified tile category |
| 404 (Not Found) | The specified tile category does not exist |
