DataPage Operations

GET DataPages List

/v1/datapages

Method: GET
Description: Returns a list of DataPages
Parameters: None
Result: List of DataPages properties:

Name – DataPage name
AppKey – DataPage ID (AppKey)
AppName – Application name
Path – Path to DataPage
Type – DataPage type
DateCreated – Date created, UTC
DateModified – Date modified, UTC
CreatedBy – User who created this DataPage
ModifiedBy – User who modified this DataPage

GET DataPage Details

/v1/datapages/<appkey>

Method: GET
Description: Returns DataPage properties
Parameters: None
Result: DataPage properties:

Name – DataPage name
AppKey – DataPage ID (AppKey)
AppName – Application name
Path – Path
Type – DataPage type
DateCreated – Date created, UTC
DateModified – Date modified, UTC
CreatedBy – User who created this DataPage
ModifiedBy – User who modified this DataPage

GET DataPage Deploy Code

/v1/datapages/<appkey>/deploy

Method: GET
Description: Returns DataPage deploy code
Parameters: URL, required – method (defines DataPage deployment method), optional – https (true/false)
Result: 200 OK if successful

Available deployment methods:

“IFrame”, “Frame”, “URL”, “Link”, “Embedded”, “Net”, “PHP”, “ASP”, “ASPX”. Values are case-insensitive and can be replaced by a single character of each string (I, F, U, L, E, N, P, A, X) respectively.

Example

Method: GET

URL:     /v1/datapages/<appkey>/deploy?method=Embedded&https=true

POST Deploy DataPage

/v1/datapages/<appkey>/deploy

Method: POST
Description: Enables external access to the DataPage
Parameters: URL, optional – httpsOnly (true/false)
Result: 200 OK if successful

DELETE Un-Deploy DataPage

/v1/datapages/<appkey>/deploy

Method: DELETE
Description: Un-deploys the DataPage
Parameters: None
Result: 200 OK if successful