UI builder - Studio API

Pages

To execute Page APIs, take a look at the examples below:

Api.page.save("1001","My Page Name");
Api.page.setFieldValue('MyFieldID', "MyFieldValue")

Sets the value of a specific field on the page

Api.page.setFieldValue(field: string, value: any): void;

Parameter	Type	Description
field	string	The Field value to be set
value	any	The value to be set inside the field

Sets multiple value of a field using key-value mapping

Api.page.setFieldValue(field: string, value: any): void;

Retrieves the Field value from the page

Api.page.getFieldValue(field: string): void;

Parameter	Type	Description
field	string	The Field value to get

Returns all the Payload

Api.page.payload: void;

Saves the current page with an optional Page number and name

Api.page.save(pageNum?: string, name?: string): void;

Parameter	Type	Description
page	string/number	The Page ID of the Page to be saved as
name	string/number	The name of the Page to be saved as

Saves the current page as a new page with an optional page number and name

Api.page.saveAs(pageNum?: string, name?: string): void;

Parameter	Type	Description
page	string/number	The Page ID of the new Page to be saved as
name	string/number	The name of the new Page to be saved as

Get the Page ID of the Page

Api.page.num: void;

Get the Name of the Page

Api.page.name: void;

Get the Description of the Page

Api.page.description: void;