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

 200 (OK)
Content-Type: application/json
[
   {
      "var_name": "SYS_SYS",
      "var_label": "System Variables",
      "var_type": "system",
      "var_source": ""
   },
   {
      "var_name": "USER",
      "var_label": "User",
      "var_type": "dropdown",
      "var_source": "47014765053e4fd0e42e029057786697"
   },
   {
      "var_name": "USERNEW",
      "var_label": "UserNew",
      "var_type": "string",
      "var_source": "5053e4fd0e42e0290577866974701476"
   },
   {
      "var_name": "GRD1",
      "var_label": "[ Grid ]",
      "var_type": "grid",
      "var_source": ""
   }
]

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

 200 (OK)
Content-Type: application/json
[
   {
      "var_name": "GRD1",
      "var_label": "[ Grid ]",
      "var_type": "grid",
      "grid_uid": "14695166352fcef372d24e6059035575"
   },
   {
      "var_name": "GRD2",
      "var_label": "[ Grid ]",
      "var_type": "grid",
      "grid_uid": "97706235952b4a16cd27a24084424857"
   }
]

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

200 (OK)
Content-Type: application/json
[
   {
      "var_name": "FIELD1",
      "var_label": "Field1...",
      "var_type": "text"
   },
   {
      "var_name": "USER",
      "var_label": "User",
      "var_type": "dropdown"
   },
   {
      "var_name": "DESCRIPTION",
      "var_label": "Description...",
      "var_type": "textarea"
   }
]