Path: / API / queryRuntimeAPI / getVariable / {activityUUID}

Obtains a variable for the given activity and variable name. This variable could be local to the activity or global to the process. The activity should either be executed or currently pointed by the a process execution.

For XML Type:

Path parameters:
activityUUID - the activity UUID.

Method Summary
ResourceDescription
POST /API/queryRuntimeAPI/getVariable/{activityUUID}Obtains a variable for the given activity and variable name.

Method Detail
HTTP Example:
POST /API/queryRuntimeAPI/getVariable/{activityUUID}

variableId=&options=
API Example:

AbstractRemoteQueryRuntimeAPI.getVariable({'activityUUID': /* activityUUID the activity UUID. */,
  'variableId': /* variableId the variable name. */,
  'options': /* options the options map (domain, queyList, user) */});

Obtains a variable for the given activity and variable name. This variable could be local to the activity or global to the process. The activity should either be executed or currently pointed by the a process execution.

For XML Type:

  • getVariable(activityUUID, "myXmlData") returns a {@link Document}
  • getVariable(activityUUID, "myXmlData" + {@link BonitaConstants#XPATH_VAR_SEPARATOR} + "/root/node") returns a {@link Node}
  • getVariable(activityUUID, "myXmlData" + {@link BonitaConstants#XPATH_VAR_SEPARATOR} + "/root/@attribute") returns a {@link String}
  • getVariable(activityUUID, "myXmlData" + {@link BonitaConstants#XPATH_VAR_SEPARATOR} + "/root/text()") returns a {@link String}
  • getVariable(activityUUID, "myXmlData" + {@link BonitaConstants#XPATH_VAR_SEPARATOR} + anyOtherKindOfXPathExpression) returns a {@link Node}

Output:
java.lang.Object - the variable object (can be: a plain {@link String}, a {@link Boolean}, a {@link Date}, a {@link Long} or a {@link Double}).
Form parameters:
variableId - the variable name.
options - the options map (domain, queyList, user)
Produces:
text/*
application/xml
Consumes:
application/x-www-form-urlencoded
text/*
application/xml