...
Description | |
---|---|
URI | http://host_name/uc/resources/taskinstance/showvariables |
HTTP Method | GET |
Description | Retrieve the variables for a specific task instance. (Comparable to the Show Variables functionality in the user interface.) |
Authentication | HTTP Basic |
Example URI | |
Consumes Content-Type | n/a |
Produces Content-Type | application/xml, application/json |
Example URI Properties | See List Task Instance Variables (Show Variables): Example URI Properties. |
Example Response | See List Task Instance Variables (Show Variables): XML and JSON Response Examples. |
Anchor | ||
---|---|---|
|
...
|
...
|
...
UI Field Name
...
Description
...
Specifications
...
Required
...
Mutually Exclusive With
...
n/a
...
Used if taskinstancename
is specified; Specific task instance with this taskinstancename
.
String; URI parameter. Valid values:
Default is Oldest Active Instance (1).
...
N
...
UUID
...
UUID of the task instance for which you want to list variables.
...
String; URI parameter.
...
Y
(unless taskinstancename
is specified.)
...
taskinstancename
...
Instance Name
...
Name of the task instance for which you want to list variables.
...
String; URI parameter.
...
Y
(unless taskinstanceid
is specified.)
...
taskinstanceid
...
Workflow
...
Name of the parent Workflow of the task instance.
...
You can select to display the Workflow field on the Activity Monitor and/or Task Instances List; it is not displayed in the Task Instance Details.
...
N
...
XML
...
JSON
...
title | XML |
---|
...
XML and JSON Response Examples
XML | JSON | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
|
|
Anchor | ||||
---|---|---|---|---|
|
UI Field Name | Description | Specifications | Required | Mutually Exclusive With | |||||||
---|---|---|---|---|---|---|---|---|---|---|---|
criteria | n/a | Used if | String; URI parameter. Valid values: Default is Oldest Active Instance (1). | N | |||||||
taskinstanceid | UUID | UUID of the task instance for which you want to list variables. | String; URI parameter. | Y |
| ||||||
taskinstancename | Instance Name | Name of the task instance for which you want to list variables. | String; URI parameter. | Y |
| ||||||
workflowinstancename | Workflow | Name of the parent Workflow of the task instance. | You can select to display the Workflow field on the Activity Monitor and/or Task Instances List; it is not displayed in the Task Instance Details. | N |
Anchor | ||||
---|---|---|---|---|
|
...