[Index]
Controls appearance of web page
Model ref.: data/Theme
The full URL would include the host-proxy name: https://[host-proxy].
Variables are enclosed in square brackets.
{ "$schema": "http://json-schema.org/draft-03/schema", "type": "object", "properties": { "name": { "description": "The name that is given to the Theme. Valid characters allowed for the name are [a-zA-Z0-9_]", "title": "Theme Name", "pattern": "^[a-zA-Z0-9_]+$", "required": true, "type": "string" }, "title": { "required": false, "type": "string", "description": "Title displayed in the browser tab", "title": "Site Title" }, "import_file": { "format": "file", "type": "string", "title": "Import File" }, "import_file_id": { "required": false, "type": "string", "title": "Import File Id" }, "backup": { "default": false, "type": "boolean", "description": "Create backup if existing theme exists", "title": "Backup Enabled" }, "banner_title": { "required": false, "type": "string", "description": "Text that appears in the Navbar after login", "title": "Navbar Text" }, "description": { "required": false, "type": "string", "description": "A description for the Theme.", "title": "Description" }, "is_login_theme": { "default": false, "type": "boolean", "description": "Determines if this theme is used to style the login page", "title": "Use this Theme to style Login page" }, "hide_from_lower_hierarchies": { "default": false, "type": "boolean", "description": "Indicates if the theme can be viewed and dowloaded at lower hierarchies.", "title": "Hide from Lower Hierarchies" }, "interface": { "description": "The selected interface that is associated with the Theme. The interface can be an Administration or Self Service.", "title": "Interface", "default": "administration", "choices": [ { "value": "administration", "title": "Administration" }, { "value": "selfservice", "title": "Self Service" } ], "type": "string" }, "theme_customisation": { "type": "object", "description": "The colours and images that comprise a theme.", "title": "Theme Customisation", "properties": { "primary_colour": { "description": "This is the background colour for most menus and headers, as well as the text colour for links and buttons.", "format": "color", "pattern": "^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$", "required": false, "title": "Primary Colour", "type": "string" }, "primary_text_colour": { "description": "This is the text colour for anything with the primary colour background.", "format": "color", "pattern": "^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$", "required": false, "title": "Primary Text Colour", "type": "string" }, "accent_colour": { "description": "This colour is used when attention needs to be drawn for important notifications or active buttons and text.", "format": "color", "pattern": "^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$", "required": false, "title": "Accent Colour", "type": "string" }, "accent_text_colour": { "description": "This is the text colour for anything with the accent colour background.", "format": "color", "pattern": "^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$", "required": false, "title": "Accent Text Colour", "type": "string" }, "topbar_colour": { "description": "The colour used for the top bar of the site. Will use the primary colour if no value is given.", "format": "color", "pattern": "^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$", "required": false, "title": "Topbar Colour", "type": "string" }, "topbar_text_colour": { "description": "This is the text colour for the top bar. Will use the primary text colour if no value is given.", "format": "color", "pattern": "^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$", "required": false, "title": "Topbar Text Colour", "type": "string" }, "menu_colour": { "description": "The colour used for the menu on the left. Will use the primary colour if no value is given.", "format": "color", "pattern": "^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$", "required": false, "title": "Menu Colour", "type": "string" }, "menu_text_colour": { "description": "This is the text colour for the menu. Will use the primary text colour if no value is given.", "format": "color", "pattern": "^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$", "required": false, "title": "Menu Text Colour", "type": "string" }, "panel_colour": { "description": "The colour used for all the panels in the app.", "format": "color", "pattern": "^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$", "required": false, "title": "Panel Colour", "type": "string" }, "panel_text_colour": { "description": "This is the text colour for normal text in the app.", "format": "color", "pattern": "^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$", "required": false, "title": "Panel Text Colour", "type": "string" }, "input_colour": { "description": "The background colour for input fields. Will use the panel colour if no value is given.", "format": "color", "pattern": "^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$", "required": false, "title": "Input Colour", "type": "string" }, "input_text_colour": { "description": "The text colour for input fields. Will use the panel text colour if no value is given.", "format": "color", "pattern": "^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$", "required": false, "title": "Input Text Colour", "type": "string" }, "background_colour": { "description": "The colour of the background.", "format": "color", "pattern": "^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$", "required": false, "title": "Background Colour", "type": "string" }, "info_notification_colour": { "description": "The colour used for info notifications.", "format": "color", "pattern": "^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$", "required": false, "title": "Info Notification Colour", "type": "string" }, "info_notification_text_colour": { "description": "This is the text colour for info notifications.", "format": "color", "pattern": "^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$", "required": false, "title": "Info Notification Text Colour", "type": "string" }, "success_notification_colour": { "description": "The colour used for success notifications.", "format": "color", "pattern": "^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$", "required": false, "title": "Success Notification Colour", "type": "string" }, "success_notification_text_colour": { "description": "This is the text colour for success notifications.", "format": "color", "pattern": "^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$", "required": false, "title": "Success Notification Text Colour", "type": "string" }, "warn_notification_colour": { "description": "The colour used for warning notifications.", "format": "color", "pattern": "^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$", "required": false, "title": "Warning Notification Colour", "type": "string" }, "warn_notification_text_colour": { "description": "This is the text colour for warning notifications.", "format": "color", "pattern": "^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$", "required": false, "title": "Warning Notification Text Colour", "type": "string" }, "error_notification_colour": { "description": "The colour used for error notifications.", "format": "color", "pattern": "^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$", "required": false, "title": "Error Notification Colour", "type": "string" }, "error_notification_text_colour": { "description": "This is the text colour for error notifications.", "format": "color", "pattern": "^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$", "required": false, "title": "Error Notification Text Colour", "type": "string" }, "favicon": { "description": "The favicon for the site. Shown on the tab and when the site is bookmarked.", "format": "file", "required": false, "title": "Favicon", "type": "string" }, "favicon_id": { "required": false, "type": "string", "title": "Favicon Id" }, "logo": { "description": "This image is used for the logo in the top left of the menu bar. Must be a PNG image with a transparent background. Maximum file size is 0.5MiB and maximum dimensions are 600 pixels in width and 192 pixels in height.", "format": "file", "required": false, "title": "Logo", "type": "string" }, "logo_id": { "required": false, "type": "string", "title": "Logo Id" }, "login_logo": { "description": "This image is used for the logo on the login page. Must be a PNG image with a transparent background. Maximum file size is 0.5MiB and maximum dimensions are 600 pixels in width and 192 pixels in height.", "format": "file", "required": false, "title": "Login Logo", "type": "string" }, "login_logo_id": { "required": false, "type": "string", "title": "Login Logo Id" }, "login_bg": { "description": "This image is used for the login screen background. Must be a PNG or JPEG image. Maximum file size is 5MiB and maximum dimensions are 1920 pixels in width and 1080 pixels in height.", "format": "file", "required": false, "title": "Login Background", "type": "string" }, "login_bg_id": { "required": false, "type": "string", "title": "Login Background Id" }, "menu_bg": { "description": "This image is used for the side menu background. Must be a PNG or JPEG image. Maximum file size is 2MiB and maximum dimensions are 240 pixels in width and 1040 pixels in height.", "format": "file", "required": false, "title": "Menu Background", "type": "string" }, "menu_bg_id": { "required": false, "type": "string", "title": "Menu Background Id" }, "data_driven": { "default": false, "type": "boolean", "description": "Generate a new admin GUI theme, overwriting an existing theme of the same name", "title": "Generate Admin GUI Theme" } } }, "login_page": { "type": "object", "description": "How theme styles the login page", "title": "Login Page Details", "properties": { "title": { "type": "string", "description": "Title displayed at top of login page", "title": "Title" }, "banner": { "description": "Banner text displayed at bottom of login page. References to {{cookie_policy}} and {{privacy_policy}} will be replaced with relevant links when displaying the theme.", "title": "Banner Text", "displayable": true, "maxLength": 2048, "type": "string" }, "cookie_policy": { "type": "object", "description": "Reference to resultant hyperlink can be added as {{cookie_policy}} inside the Banner Text field", "title": "Cookie Policy", "properties": { "text": { "description": "Text that will be displayed for the hyperlink", "title": "Link Text", "required": false, "displayable": true, "type": "string" }, "url": { "required": false, "type": "string", "description": "URL that has Cookie Policy. Opens in a new tab", "title": "Link URL" } } }, "privacy_policy": { "type": "object", "description": "Reference to resultant hyperlink can be added as {{privacy_policy}} inside the Banner Text field", "title": "Privacy Policy", "properties": { "text": { "description": "Text that will be displayed for the hyperlink", "title": "Link Text", "required": false, "displayable": true, "type": "string" }, "url": { "required": false, "type": "string", "description": "URL that has Privacy Policy. Opens in a new tab", "title": "Link URL" } } } } } }, "schema_version": "0.5.2" }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the GUI Add form. | GET | /api/data/Theme/add/ |
|
The GUI Add form of data/Theme as JSON |
The API call to the /add/ URL can only be made from a hierarchy that allows the model type to be added. The actions in the response shows the url for the POST API call to create an instance.
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Create | POST | /api/data/Theme | hierarchy=[hierarchy] |
|
tool/Transaction/[trans pkid]to inspect the created resource and its instance pkid.
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Bulk delete [pkid1],[pkid2]... | DELETE | /api/data/Theme/ | hierarchy=[hierarchy] | {"hrefs":["/api/data/Theme/[pkid1]", "/api/data/Theme/[pkid2]", ...]} |
GET http://[host-proxy]/api/data/Theme/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Bulk Modify | GET | /api/data/Theme/bulk_update/?schema=&schema_rules=true |
|
|
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Bulk Modify | POST | /api/data/Theme/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/data/Theme/[pkid1]", "/api/v0/data/Theme/[pkid2]",...]}} |
GET http://[host-proxy]/api/data/Theme/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of data/Theme; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/data/Theme/export/ |
|
{ "hrefs":["/api/data/Theme/[pkid1]", "/api/data/Theme/[pkid2]",...]}} |
For export_format=json, the response is a time stamped zip file of data in JSON as in the system database. Item properties such as strings that are empty or Boolean values that are not set, are not included. The filename in the response is of the format as the example:
Content-Disposition: attachment; filename=export_2013-05-17_14:20:19.186444.json.zip Content-Language:en Content-Type:application/x-zip
For export_format=raw_xlsx, the response is a MS Excel spreadsheet with columns corresponding to the JSON format export and a response filename format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_CCYY-MM-DD_HH-MM-SS.xlsx Content-Language:en Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=xlsx, the response is a MS Excel spreadsheet, arranged by any Field Display Policies that apply. The columns correspond with those of a Bulk Load Template export sheet. The response filename format is:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_formatted_CCYY-MM-DD_HH-MM-SS.xlsx Content-Language:en Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
The XLSX format can be used to bulk load instances of data/Theme and the JSON format can be used to import instances of data/Theme.
GET http://[host-proxy]/api/data/Theme/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a compressed format of the Bulk Load spreadsheet template for data/Theme | POST | /api/data/Theme/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Tag | PATCH | /api/data/Theme/+tag/ |
|
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Tag Version | PATCH | /api/data/Theme/+tag_version/ |
|
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Configuration Template | GET | /api/data/Theme/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Field Display Policy | GET | /api/data/Theme/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Migration Template | GET | /api/data/Theme/migration/ |
|
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
List | GET | /api/data/Theme/ |
|
The data/Theme schema and all instances as JSON. |
(The list will return 0 to 3 data/Theme instances)
{ "pagination": { "skip": 0, "limit": 3, "maximum_limit": 2000, "total": 10, "total_limit": null, "order_by": "name", "direction": "asc", "current": "/api/data/Theme/?skip=0&limit=3&order_by=name&direction=asc&traversal=fulltree" }, "operations": [ "field_display_policy", "update", "help", "remove", "move", "add", "export", "list", "configuration_template", "get", "bulk_update_form", "migration", "transform", "export_bulkload_template" ], "meta": { "model_type": "data/Theme", "summary_attrs": [ { "name": "name", "title": "Theme Name" }, { "name": "description", "title": "Description" }, { "name": "hierarchy_friendly_name", "title": "Located At", "allow_filtering": true } ], "tagged_versions": [], "tags": [], "title": "", "business_key": { "hierarchy": false, "unique": [ "name" ] }, "api_version": "21.2", "cached": true, "references": { "children": [], "parent": [ { "href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101", "pkid": "6t0ggef2c0deab00hb595101" } ], "device": [ { "href": "", "pkid": "" } ], "foreign_key": [] }, "model_specific_actions": [ "add", "bulk_update_form", "clone", "configuration_template", "export", "export_bulkload_template", "field_display_policy", "get", "help", "list", "migration", "remove", "tag", "tag_version", "update" ], "schema_version": "0.5.2", "actions": [ { "add": { "method": "GET", "class": "add", "href": "/api/data/Theme/add/?hierarchy=[hierarchy]", "support_async": false, "title": "Add" } }, { "remove": { "method": "DELETE", "class": "delete", "href": "/api/data/Theme/?hierarchy=[hierarchy]", "support_async": true, "title": "Delete" } }, { "bulk_update_form": { "method": "GET", "class": "update", "href": "/api/data/Theme/bulk_update/?hierarchy=[hierarchy]&schema=&schema_rules=true", "support_async": false, "title": "Bulk Modify" } }, { "export": { "method": "POST", "class": "export", "href": "/api/data/Theme/export/?hierarchy=[hierarchy]", "support_async": false, "title": "Export", "view": "/api/view/ExportData/add/?auth_token=[authtoken], "submit": "payload" } }, { "export_bulkload_template": { "method": "POST", "class": "bulkload_template", "href": "/api/data/Theme/export_bulkload_template/?hierarchy=[hierarchy]", "support_async": false, "title": "Export Bulk Load Template" } }, { "tag": { "method": "PATCH", "class": "tag", "href": "/api/data/Theme/+tag/?hierarchy=[hierarchy]", "support_async": true, "title": "Tag", "view": "/api/view/TagNameForm/add/?auth_token=[authtoken] } }, { "tag_version": { "method": "PATCH", "class": "tag_version", "href": "/api/data/Theme/+tag_version/?hierarchy=[hierarchy]", "support_async": true, "title": "Tag Version", "view": "/api/view/TagVersionForm/add/?auth_token=[authtoken] } }, { "configuration_template": { "method": "GET", "class": "config", "href": "/api/data/Theme/configuration_template/?hierarchy=[hierarchy]", "support_async": false, "title": "Configuration Template" } }, { "field_display_policy": { "method": "GET", "class": "display_policy", "href": "/api/data/Theme/field_display_policy/?hierarchy=[hierarchy]", "support_async": false, "title": "Field Display Policy" } }, { "migration": { "method": "GET", "class": "migration", "href": "/api/data/Theme/migration/?hierarchy=[hierarchy]", "support_async": false, "title": "Migration Template" } }, { "list": { "method": "GET", "class": "list", "href": "/api/data/Theme/?hierarchy=[hierarchy]", "support_async": false, "title": "List" } }, { "help": { "method": "GET", "class": "help", "href": "/api/data/Theme/help?hierarchy=[hierarchy]", "support_async": false, "title": "Help" } } ] }, "resources": [ { "data": { "login_page": { "cookie_policy": { "url": "http://www.voss-soluctions.com/cookies", "text": "Cookie Policy" }, "privacy_policy": { "url": "http://www.voss-soluctions.com/privacy", "text": "Privacy Policy" }, "banner": "Automate v21.4 PB5 ProviderDecoupled\nAccess to this system is restricted. We value your privacy, you can read our {{privacy_policy}}. This site uses cookies as described in our {{cookie_policy}}", "title": "Unified Communications Administration Portal" }, "pkid": "5aeb744eaffa931cce444801", "banner_title": "Automate v21.4 PB5", "is_login_theme": true, "interface": "administration", "theme_customisation": { "logo": "login_logo.png", "login_bg": "login-background.png", "accent_colour": "#102A6D", "primary_colour": "#438eb9" }, "name": "Airbus", "hierarchy_friendly_name": "hcs (Hcs)", "hierarchy_path": "sys.hcs" }, "meta": { "model_type": "data/Theme", "summary_attrs": [ { "name": "name", "title": "Theme Name" }, { "name": "description", "title": "Description" }, { "name": "hierarchy_friendly_name", "title": "Located At", "allow_filtering": true } ], "tagged_versions": [], "tags": [], "title": "Airbus", "business_key": { "hierarchy": false, "unique": [ "name" ] }, "api_version": "21.2", "cached": true, "references": { "device": [ { "href": "", "pkid": "" } ], "owner": [ { "pkid": "" } ], "parent": [ { "pkid": "5ad5bacbaffa9343e4d93e01", "href": "/api/data/HierarchyNode/5ad5bacbaffa9343e4d93e01" } ], "foreign_key": [], "self": [ { "href": "/api/data/Theme/5aeb741baffa931cce444800/", "pkid": "5aeb741baffa931cce444800" } ] }, "path": [ "6t0ggef2c0deab00hb595101", "5ad5bacbaffa9343e4d93e01", "5aeb741baffa931cce444800" ], "system_resource": false, "schema_version": "0.5.2", "actions": [ { "update": { "method": "PUT", "class": "update", "href": "/api/data/Theme/5aeb741baffa931cce444800/", "support_async": true, "title": "Modify" } }, { "remove": { "method": "DELETE", "class": "delete", "href": "/api/data/Theme/5aeb741baffa931cce444800/", "support_async": true, "title": "Delete" } }, { "clone": { "method": "GET", "class": "clone", "href": "/api/data/Theme/5aeb741baffa931cce444800/clone/?schema=&schema_rules=true", "support_async": false, "title": "Clone" } }, { "export": { "method": "GET", "class": "export", "href": "/api/data/Theme/5aeb741baffa931cce444800/export/", "support_async": false, "title": "Export", "view": "/api/view/ExportData/add/", "submit": "payload" } }, { "tag": { "method": "PATCH", "class": "tag", "href": "/api/data/Theme/5aeb741baffa931cce444800/+tag/", "support_async": true, "title": "Tag", "view": "/api/view/TagNameForm/add/" } }, { "tag_version": { "method": "PATCH", "class": "tag_version", "href": "/api/data/Theme/5aeb741baffa931cce444800/+tag_version/", "support_async": true, "title": "Tag Version", "view": "/api/view/TagVersionForm/add/" } }, { "get": { "method": "GET", "class": "get", "href": "/api/data/Theme/5aeb741baffa931cce444800/", "support_async": false, "title": "Get" } }, { "help": { "method": "GET", "class": "help", "href": "/api/data/Theme/5aeb741baffa931cce444800/help", "support_async": false, "title": "Help" } } ], "summary": "false" }, "pkid": "5aeb741baffa931cce444800" }, { "data": { "interface": "selfservice", "pkid": "5aeb74e5affa931cce444939", "name": "Airbus_selfservice", "login_page": { "banner": "VOSS-4-UC v21.4 ProviderDecoupled", "title": "Unified Communications Self Service Portal" }, "hierarchy_friendly_name": "hcs (Hcs)", "hierarchy_path": "sys.hcs" }, "meta": { "model_type": "data/Theme", "summary_attrs": [ { "name": "name", "title": "Theme Name" }, { "name": "description", "title": "Description" }, { "name": "hierarchy_friendly_name", "title": "Located At", "allow_filtering": true } ], "tagged_versions": [], "tags": [], "title": "Airbus_selfservice", "business_key": { "hierarchy": false, "unique": [ "name" ] }, "api_version": "21.2", "cached": true, "references": { "device": [ { "href": "", "pkid": "" } ], "owner": [ { "pkid": "" } ], "parent": [ { "pkid": "5ad5bacbaffa9343e4d93e01", "href": "/api/data/HierarchyNode/5ad5bacbaffa9343e4d93e01" } ], "foreign_key": [], "self": [ { "href": "/api/data/Theme/5aeb74d6affa931cce444938/", "pkid": "5aeb74d6affa931cce444938" } ] }, "path": [ "6t0ggef2c0deab00hb595101", "5ad5bacbaffa9343e4d93e01", "5aeb74d6affa931cce444938" ], "system_resource": false, "schema_version": "0.5.2", "actions": [ { "update": { "method": "PUT", "class": "update", "href": "/api/data/Theme/5aeb74d6affa931cce444938/", "support_async": true, "title": "Modify" } }, { "remove": { "method": "DELETE", "class": "delete", "href": "/api/data/Theme/5aeb74d6affa931cce444938/", "support_async": true, "title": "Delete" } }, { "clone": { "method": "GET", "class": "clone", "href": "/api/data/Theme/5aeb74d6affa931cce444938/clone/?schema=&schema_rules=true", "support_async": false, "title": "Clone" } }, { "export": { "method": "GET", "class": "export", "href": "/api/data/Theme/5aeb74d6affa931cce444938/export/", "support_async": false, "title": "Export", "view": "/api/view/ExportData/add/", "submit": "payload" } }, { "tag": { "method": "PATCH", "class": "tag", "href": "/api/data/Theme/5aeb74d6affa931cce444938/+tag/", "support_async": true, "title": "Tag", "view": "/api/view/TagNameForm/add/" } }, { "tag_version": { "method": "PATCH", "class": "tag_version", "href": "/api/data/Theme/5aeb74d6affa931cce444938/+tag_version/", "support_async": true, "title": "Tag Version", "view": "/api/view/TagVersionForm/add/" } }, { "get": { "method": "GET", "class": "get", "href": "/api/data/Theme/5aeb74d6affa931cce444938/", "support_async": false, "title": "Get" } }, { "help": { "method": "GET", "class": "help", "href": "/api/data/Theme/5aeb74d6affa931cce444938/help", "support_async": false, "title": "Help" } } ], "summary": "false" }, "pkid": "5aeb74d6affa931cce444938" }, { "data": { "name": "BCX_Selfservice", "pkid": "618e78d6ce894e0011ea631d", "import_file": "BCX_Selfservice.zip", "is_login_theme": true, "import_file_id": "618e786a29c38400161a1179", "interface": "selfservice", "hierarchy_friendly_name": "sys (System)", "hierarchy_path": "sys" }, "meta": { "model_type": "data/Theme", "summary_attrs": [ { "name": "name", "title": "Theme Name" }, { "name": "description", "title": "Description" }, { "name": "hierarchy_friendly_name", "title": "Located At", "allow_filtering": true } ], "tagged_versions": [], "tags": [], "title": "BCX_Selfservice", "business_key": { "hierarchy": false, "unique": [ "name" ] }, "api_version": "21.2", "cached": true, "references": { "device": [ { "href": "", "pkid": "" } ], "owner": [ { "pkid": "" } ], "parent": [ { "pkid": "6t0ggef2c0deab00hb595101", "href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101" } ], "foreign_key": [], "self": [ { "href": "/api/data/Theme/618e786fce894e0011ea631c/", "pkid": "618e786fce894e0011ea631c" } ] }, "path": [ "6t0ggef2c0deab00hb595101", "618e786fce894e0011ea631c" ], "schema_version": "0.5.2", "actions": [ { "update": { "method": "PUT", "class": "update", "href": "/api/data/Theme/618e786fce894e0011ea631c/", "support_async": true, "title": "Modify" } }, { "remove": { "method": "DELETE", "class": "delete", "href": "/api/data/Theme/618e786fce894e0011ea631c/", "support_async": true, "title": "Delete" } }, { "clone": { "method": "GET", "class": "clone", "href": "/api/data/Theme/618e786fce894e0011ea631c/clone/?schema=&schema_rules=true", "support_async": false, "title": "Clone" } }, { "export": { "method": "GET", "class": "export", "href": "/api/data/Theme/618e786fce894e0011ea631c/export/", "support_async": false, "title": "Export", "view": "/api/view/ExportData/add/", "submit": "payload" } }, { "tag": { "method": "PATCH", "class": "tag", "href": "/api/data/Theme/618e786fce894e0011ea631c/+tag/", "support_async": true, "title": "Tag", "view": "/api/view/TagNameForm/add/" } }, { "tag_version": { "method": "PATCH", "class": "tag_version", "href": "/api/data/Theme/618e786fce894e0011ea631c/+tag_version/", "support_async": true, "title": "Tag Version", "view": "/api/view/TagVersionForm/add/" } }, { "get": { "method": "GET", "class": "get", "href": "/api/data/Theme/618e786fce894e0011ea631c/", "support_async": false, "title": "Get" } }, { "help": { "method": "GET", "class": "help", "href": "/api/data/Theme/618e786fce894e0011ea631c/help", "support_async": false, "title": "Help" } } ], "summary": "false" }, "pkid": "618e786fce894e0011ea631c" } ] }
(Show the first instance)
{ "data": { "name": "Airbus", "banner_title": "Automate v21.4 PB5", "interface": "administration", "is_login_theme": true, "theme_customisation": { "logo": "login_logo.png", "login_bg": "login-background.png", "accent_colour": "#102A6D", "primary_colour": "#438eb9" }, "login_page": { "cookie_policy": { "url": "http://www.voss-soluctions.com/cookies", "text": "Cookie Policy" }, "privacy_policy": { "url": "http://www.voss-soluctions.com/privacy", "text": "Privacy Policy" }, "banner": "Automate v21.4 PB5 ProviderDecoupled\nAccess to this system is restricted. We value your privacy, you can read our {{privacy_policy}}. This site uses cookies as described in our {{cookie_policy}}", "title": "Unified Communications Administration Portal" }, "pkid": "5aeb744eaffa931cce444801" }, "meta": { "model_type": "data/Theme", "summary_attrs": [ { "name": "name", "title": "Theme Name" }, { "name": "description", "title": "Description" }, { "name": "hierarchy_friendly_name", "title": "Located At", "allow_filtering": true } ], "tagged_versions": [], "tags": [], "title": "Airbus", "business_key": { "hierarchy": false, "unique": [ "name" ] }, "api_version": "21.2", "cached": false, "references": { "device": [ { "href": "", "pkid": "" } ], "owner": [ { "pkid": "" } ], "parent": [ { "href": "/api/data/HierarchyNode/5ad5bacbaffa9343e4d93e01", "pkid": "5ad5bacbaffa9343e4d93e01" } ], "foreign_key": [], "children": [], "self": [ { "href": "/api/data/Theme/5aeb741baffa931cce444800/", "pkid": "5aeb741baffa931cce444800" } ] }, "path": [ "6t0ggef2c0deab00hb595101", "5ad5bacbaffa9343e4d93e01", "5aeb741baffa931cce444800" ], "system_resource": false, "schema_version": "0.5.2", "actions": [ { "update": { "method": "PUT", "class": "update", "href": "/api/data/Theme/5aeb741baffa931cce444800/?hierarchy=[hierarchy]", "support_async": true, "title": "Modify" } }, { "remove": { "method": "DELETE", "class": "delete", "href": "/api/data/Theme/5aeb741baffa931cce444800/?hierarchy=[hierarchy]", "support_async": true, "title": "Delete" } }, { "clone": { "method": "GET", "class": "clone", "href": "/api/data/Theme/5aeb741baffa931cce444800/clone/?hierarchy=[hierarchy]&schema=&schema_rules=true", "support_async": false, "title": "Clone" } }, { "export": { "method": "GET", "class": "export", "href": "/api/data/Theme/5aeb741baffa931cce444800/export/?hierarchy=[hierarchy]", "support_async": false, "title": "Export", "view": "/api/view/ExportData/add/?auth_token=[authtoken], "submit": "payload" } }, { "tag": { "method": "PATCH", "class": "tag", "href": "/api/data/Theme/5aeb741baffa931cce444800/+tag/?hierarchy=[hierarchy]", "support_async": true, "title": "Tag", "view": "/api/view/TagNameForm/add/?auth_token=[authtoken] } }, { "tag_version": { "method": "PATCH", "class": "tag_version", "href": "/api/data/Theme/5aeb741baffa931cce444800/+tag_version/?hierarchy=[hierarchy]", "support_async": true, "title": "Tag Version", "view": "/api/view/TagVersionForm/add/?auth_token=[authtoken] } }, { "get": { "method": "GET", "class": "get", "href": "/api/data/Theme/5aeb741baffa931cce444800/?hierarchy=[hierarchy]", "support_async": false, "title": "Get" } }, { "help": { "method": "GET", "class": "help", "href": "/api/data/Theme/5aeb741baffa931cce444800/help?hierarchy=[hierarchy]", "support_async": false, "title": "Help" } } ] }, "pkid": "5aeb741baffa931cce444800" }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the on-line Help for data/Theme. | GET | /api/data/Theme/help | hierarchy=[hierarchy] | On-line help of Model ref.: data/Theme as HTML |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Modify | PUT | /api/data/Theme/[pkid] | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Delete | DELETE | /api/data/Theme/[pkid] | hierarchy=[hierarchy] |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Clone instance with [pkid]. The schema rules are applied. | GET | /api/data/Theme/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/data/Theme/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a selected [export_format] of the schema and a single instance with [pkid] of data/Theme; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/data/Theme/[pkid]/export |
|
The response is an attachment. Refer to the list below. |
For export_format=raw_xlsx, the response is a "raw" MS Excel spreadsheet with columns corresponding to the JSON format export and a response format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_CCYY-MM-DD_HH-MM-SS.xlsx Content-Language:en Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=xlsx, the response is a MS Excel spreadsheet, formatted to show all columns and a response format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_formatted_CCYY-MM-DD_HH-MM-SS.xlsx Content-Language:en Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=json, the response is a time stamped zip file of data in JSON and a response format:
Content-Disposition: attachment; filename=export_2013-05-17_14:20:19.186444.json.zip Content-Language:en Content-Type:application/x-zip
The XLSX format can be used to bulk load instances of data/Theme and the JSON format can be used to import instances of data/Theme.
For Bulk Export, refer to the Bulk Export section.
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Tag | PATCH | /api/data/Theme/[pkid]/+tag | hierarchy=[hierarchy] | If payload required: |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get | GET | /api/data/Theme/[pkid] | hierarchy=[hierarchy] | The data/Theme instance with [pkid]. |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Help | GET | /api/data/Theme/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for data/Theme. |