3.2 - 3.8 - REST API Designer - Variables

Variables

These endpoints work with all types of variables, including both system and process variables, as well as variables from the old style Dynaforms and the new responsive Dynaforms.

Process variables:

Name	Description	Type	Value
prj_uid	Project UID	String	"9541049475298f190420f51086854718" (String of 32 characters)
var_name	Variable name	String	"SYS_SYS"
var_label	Label of the variable	String	"System Variables"
var_type	Variable type	String	"system"
var_source	Dynaform UID (when the variable is defined in a Dynaform from version 2.x) or variable UID (when the variable is defined for Dynaforms from version 3). This field will be left blank if these are system or grid variables.	String	"75298f190420f5108685471895410494" (string of 32 characters)
grid_uid	Grid UID (Dydnaform UID)	String	"9541049475298f190420f51086854718" (string of 32 characters)

Get Variables List: GET project/{prj_uid}/variables

Gets a list of the variables in a project, including both system and process variables.

GET /api/1.0/{workspace}/project/{prj_uid}/variables

Parameters:

Name	Type	Description
workspace	String	Workspace name
prj_uid	String	Project UID

Result:

Type	Description
array	Returns an array containing data about each variable in the process.

Example:

Response

2. Get Grid Variables from a Process

GET /api/1.0/{workspace}/project/{prj_uid}/grid/variables

Parameters:

Name	Type	Description
workspace	String	Workspace name
prj_uid	String	Project UID

Result:

Type	Description
array	Returns an array containing data about each variable.

Example:

Response

Get Variables in Grid: GET project/{prj_uid}/grid/{grid_uid}/variables

Gets a list of the variables in a grid.

GET /api/1.0/{workspace}/project/{prj_uid}/grid/{grid_uid}/variables

Parameters:

Name	Type	Description
workspace	String	Workspace name
prj_uid	String	Project UID
grid_uid	String	Grid UID

Result:

Type	Description
array	Returns an array containing data about each variable.

Example:

Response