General Notes
- This service offers the default themes CRUD Operations for the admin UI.
- Important: This service is for exclusive use by the module admin-ui. Its API might change anytime without prior notice. Any dependencies other than the admin UI will be strictly ignored. DO NOT use this for integration of third-party applications.
Table of Contents
- GET /{themeId}.json
- GET /themes.json
- GET /{themeId}/usage.json
- POST /
- DELETE /{themeId}
- PUT /{themeId}
Read methods
| Method / Path: | GET /{themeId}.json |
|---|---|
| Description: | Returns the theme by the given id as JSON |
| Path params: | themeId(Default value=0): The theme id |
| Optional (query) params: | NONE |
| Response formats: | application/json |
| Status codes: |
200: OK, Returns the theme as JSON 404: Not Found, No theme with this identifier was found. |
| Notes: |
|
| Testing: |
Sample:
/{themeId}.json
Testing form (click to reveal)
|
| Method / Path: | GET /themes.json |
|---|---|
| Description: | Return all of the known themes on the system |
| Path params: | NONE |
| Optional (query) params: |
filter:
The filter used for the query. They should be formated like that: 'filter1:value1,filter2:value2' limit(Default value=0): The maximum number of items to return per page. offset(Default value=0): The page number. sort: The sort order. May include any of the following: NAME, CREATOR. Add '_DESC' to reverse the sort order (e.g. CREATOR_DESC). |
| Response formats: | application/json |
| Status codes: | 200: OK, A JSON representation of the themes |
| Testing: |
Sample:
/themes.json?filter={filter}&limit=0&offset=0&sort={sort}
Testing form (click to reveal)
|
| Method / Path: | GET /{themeId}/usage.json |
|---|---|
| Description: | Returns the theme usage by the given id as JSON |
| Path params: | themeId(Default value=0): The theme id |
| Optional (query) params: | NONE |
| Response formats: | application/json |
| Status codes: |
200: OK, Returns the theme usage as JSON 404: Not Found, Theme with the given id does not exist |
| Notes: |
|
| Testing: |
Sample:
/{themeId}/usage.json
Testing form (click to reveal)
|
Write methods
| Method / Path: | POST / |
|---|---|
| Description: | Add a theme |
| Path params: | NONE |
| Required (form) params: |
default: Whether the theme is default
name: The theme name |
| Optional (form) params: |
description:
The theme description bumperActive: Whether the theme bumper is active trailerActive: Whether the theme trailer is active titleSlideActive: Whether the theme title slide is active licenseSlideActive: Whether the theme license slide is active watermarkActive: Whether the theme watermark is active bumperFile: The theme bumper file trailerFile: The theme trailer file watermarkFile: The theme watermark file titleSlideBackground: The theme title slide background file licenseSlideBackground: The theme license slide background file titleSlideMetadata: The theme title slide metadata licenseSlideDescription: The theme license slide description watermarkPosition: The theme watermark position |
| Status codes: |
200: OK, Theme created 400: Bad Request, The theme references a non-existing file |
| Notes: |
|
| Testing: |
Sample:
/
Testing form (click to reveal)
|
| Method / Path: | DELETE /{themeId} |
|---|---|
| Description: | Deletes a theme |
| Path params: | themeId(Default value=0): The theme identifier |
| Optional (query) params: | NONE |
| Status codes: |
404: Not Found, If the theme has not been found. 204: No Content, The method does not return any content 401: Unauthorized, If the current user is not authorized to perform this action |
| Notes: |
|
| Testing: |
Sample:
/{themeId}
Testing form (click to reveal)
|
| Method / Path: | PUT /{themeId} |
|---|---|
| Description: | Updates a theme |
| Path params: | themeId(Default value=0): The theme identifier |
| Optional (form) params: |
default:
Whether the theme is default name: The theme name description: The theme description bumperActive: Whether the theme bumper is active trailerActive: Whether the theme trailer is active titleSlideActive: Whether the theme title slide is active licenseSlideActive: Whether the theme license slide is active watermarkActive: Whether the theme watermark is active bumperFile: The theme bumper file trailerFile: The theme trailer file watermarkFile: The theme watermark file titleSlideBackground: The theme title slide background file licenseSlideBackground: The theme license slide background file titleSlideMetadata: The theme title slide metadata licenseSlideDescription: The theme license slide description watermarkPosition: The theme watermark position |
| Status codes: |
200: OK, Theme updated 404: Not Found, If the theme has not been found. |
| Notes: |
|
| Testing: |
Sample:
/{themeId}
Testing form (click to reveal)
|