Frames

The platform6.frames service allows creating and visualizing frames.

Read the user guide of the Frames service to discover its operating mode.

List the frames

This resource returns the list of the frames.

Parameters

Headers of the request

Header’s key	Description	Value
platform6.request.action	The action to perform (required)	list
platform6.request.user	The email address of the user sending the message

Headers of the response

Header’s key	Description
platform6.response.value	The list of frames

Example

def cm = [ headers: [ 'platform6.request.action': 'list' ] ]

print p6.service.request('platform6.frames', cm).headers['platform6.response.value']

The response will be:

[
   {
      "name": "Chevron Like Test",
      "appKey": "",
      "description": { "EN": "Chevron Like Test" },
      "enabled": false,
      "contentMode": "NONE",
      "lastModifiedBy": "admin@amalto.com",
      "lastModifiedDate": 1530267164272,
      "revisionId": "288ee9e6905c89f664cad5a3967868b9",
      "url": "https://dev.portal.amalto.com/static/applications/master/pages/template.html"
   },
   {
      "name": "Home page",
      "appKey": "",
      "description": {
         "EN": "Home page",
         "FR": "Page d'accueil"
      },
      "enabled": false,
      "contentMode": "NONE",
      "lastModifiedBy": "admin@amalto.com",
      "lastModifiedDate": 1530267164141,
      "revisionId": "d7a8391f163edbc5e9f4e44723bbcf35",
      "url": "https://dev.portal.amalto.com/static/applications/master/pages/template.html"
   }
]

Get a frame

Return the frame by its identifier if it exists, otherwise, it returns null.

Parameters

Headers of the request

Header’s key	Description	Value
platform6.request.action	The action to perform (required)	get
id	The identifier of the frame (required)
platform6.request.user	The email address of the user sending the message

Headers of the response

Header’s key	Description
platform6.response.value	The frame

Example

def cm = [
    headers: [
        'platform6.request.action': 'get',
        'id': 'Chevron Like Test'
    ]
]

print p6.service.request('platform6.frames', cm).headers['platform6.response.value']

If it exists it returns the item (see below), otherwise, it returns null.

{
   "name": "Chevron Like Test",
   "appKey": "",
   "description": { "EN": "Chevron Like Test" },
   "enabled": false,
   "contentMode": "NONE",
   "lastModifiedBy": "admin@amalto.com",
   "lastModifiedDate": 1530267164272,
   "revisionId": "288ee9e6905c89f664cad5a3967868b9",
   "url": "https://dev.portal.amalto.com/static/applications/master/pages/template.html"
}