Creates new theme and assigns unique ID to it. The new theme is saved as draft and requires publishing.
| Request property | Spec |
|---|---|
| Action | POST /themes |
SID header |
Must be a SID that is authorized for the specific owner. |
| Body model | Theme |
| Scala | class CreateTheme |
| Status | Response body spec |
|---|---|
| 201 | Theme |
| 404 | {"error": 404, "message": "VFO Org '$ownerId' not found"} If ownerId value does not identify an org. |
| 403 | {"error": 403, "message": "Insufficient permissions"} If the SID is not authorized for the specific owner. |
| 401 | Invalid credentials, if SID is not for a user. |
| 400 | Bad request |
Retrieves the theme by ID.
| Request property | Spec |
|---|---|
| Action | GET /themes/themeId?mode=mode |
SID header |
Must be authenticated SID. |
mode param |
Optional. Can be either draft or published. Defaults to published |
| Body model | no body |
| Scala | class GetTheme |
| Status | Response body spec |
|---|---|
| 200 | Theme |
| 404 | {"error": 404, "message": "Theme '$themeId' not found"} If themeId does not identify a theme. |
| 404 | {"error": 404, "message": "Published theme '$themeId' not found"} If published theme is requested and yet themeId is unpublished. |
| 403 | {"error": 403, "message": "Insufficient permissions"} If the SID is not authenticated. |
| 401 | Invalid credentials |
| 400 | Bad request |
Updates the theme by ID.
| Request property | Spec |
|---|---|
| Action | PUT /themes/themeId |
SID header |
Must be a SID that is authorized for the specific owner. |
| Body model | Theme |
| Scala | class UpdateThemeDraft |
| Status | Response body spec |
|---|---|
| 200 | Theme |
| 404 | {"error": 404, "message": "Theme '$themeId' not found"} If themeId does not identify a theme. |
| 404 | {"error": 404, "message": "VFO Org '$ownerId' not found"} If ownerId value does not identify an org. |
| 403 | {"error": 403, "message": "Insufficient permissions"} If the SID is not authorized for the specific owner. |
| 401 | Invalid credentials, if SID is not for a user. |
| 400 | Bad request |
Marks current draft version as published.
| Request property | Spec |
|---|---|
| Action | POST /themes/themeId/publish |
SID header |
Must be a SID that is authorized for the specific owner. |
| Body model | no body |
| Scala | class PublishTheme |
| Status | Response body spec |
|---|---|
| 200 | no body |
| 404 | {"error": 404, "message": "Theme '$themeId' not found"} If themeId does not identify a theme. |
| 403 | {"error": 403, "message": "Insufficient permissions"} If the SID is not authorized for the specific owner. |
| 401 | Invalid credentials, if SID is not for a user. |
| 400 | Bad request |