...
Examples | XML | JSON |
---|
Example Request for Task | |
Expand |
---|
|
Code Block |
---|
| {
"variables": null,
"virtual-resources": null,
"name": "Timer 0",
"timeZone": "America/Halifax",
"virtualResourcePriority": 10,
"hold": "yes",
"holdReason": "Waiting for input",
"launchReason": "test"
} |
|
|
Example Request for Task-Related Records |
Expand |
---|
| Anchor |
---|
| Variables for Task-Related Records |
---|
| Variables for Task-Related Records |
---|
| Variables<variables>
<variable>
<name>testVar</name>
<value>value</value>
</variable>
</variables> Anchor |
---|
| Virtual Resources for Task-Related Records |
---|
| Virtual Resources for Task-Related Records |
---|
| Virtual Resources<virtual-resources>
<virtual-resource>
<name>uc - Solo</name>
<limit>2</limit>
</virtual-resource>
</virtual-resources> |
|
Expand |
---|
| {
"variables": [{
"name": "testvar",
"value": "abc"
}],
"virtualResources": [ {
"name": "aaaaa",
"limit": 2
} ],
"name": "Timer 0",
"virtualResourcePriority": 10,
"hold": "yes"
} |
|
Example Response |
Expand |
---|
| <command-response>
<type>launch</type>
<success>true</success>
<info>Successfully launched the Timer task Timer 0.</info>
<sysId>1484021712811013671DQNWR5P2F9846</sysId>
<errors />
</command-response> |
|
Expand |
---|
| {
"type": "launch",
"success": true,
"info": "Successfully launched the Timer task "Timer 0" with task instance sys_id 15136440261151733518FCQUD1BNHITA with hold on start.",
"errors": "",
"sysId": "15136440261151733518FCQUD1BNHITA"
} |
|
Anchor |
---|
| Launch a Task Request Properties |
---|
| Launch a Task Request Properties |
---|
|
Launch a Task: Request Properties
Property | UI Field Name | Description | Specifications | Required |
---|
Anchor |
---|
| hold - Launch |
---|
| hold - Launch |
---|
| hold | Hold on Start | Indicates that when the task is launched, it appears in the Activity Monitor with a status of Held. The task runs when the user releases it. | Valid values = Yes,Y,true | N |
Anchor |
---|
| holdReason - Launch |
---|
| holdReason - Launch |
---|
| holdReason | Hold Reason | Information about why the task will be put on hold when it starts. |
| N |
launchReason | Launch Reason | Reason for the task launch |
| N (Y if Task Launch Reason Required system property is True.) |
Anchor |
---|
| name - Launch |
---|
| name - Launch |
---|
| name | Task Name | Name of the task. |
| Y |
Anchor |
---|
| timeZone - Launch |
---|
| timeZone - Launch |
---|
|
timeZone | Time Zone | Time Zone in the which the task is launched. |
| N |
Anchor |
---|
| virtualResourcePriority - Launch |
---|
| virtualResourcePriority - Launch |
---|
| virtualResourcePriority | Virtual Resource Priority | Priority for acquiring a resource when two or more tasks are waiting for the resource; applies to all resources required by the task. | Integer; Valid values: 1 (high) to 20 (low). Default is 10. | N |
Anchor |
---|
| Task-Related Records Properties Variables |
---|
| Task-Related Records Properties Variables |
---|
|
Task-Related Records Properties: Variables
...
Property | UI Field Name | Description | Specifications | Required | Mutually Exclusive With |
---|
Anchor |
---|
| agentName - LT |
---|
| agentName - LT |
---|
|
agentName | Agent | Agent on which this task was run. |
| N |
|
Anchor |
---|
| businessServices - LT |
---|
| businessServices - LT |
---|
|
businessServices | Member of Business Services | Business Services that this task belongs to. | Comma-separated list. | N |
|
| Task Name | Name or partial name of one or more tasks. | Wildcards are supported. | N |
|
Anchor |
---|
| templateId - LT |
---|
| templateId - LT |
---|
|
templateId | n/a | ID used within the controller to identify a template. | If a templateId or templateName is specified, List task returns a list of tasks associated with the Universal template. | N | templateName |
Anchor |
---|
| templateName - LT |
---|
| templateName - LT |
---|
|
templateName | Template Name | Name of a template. | If a templateId or templateName is specified, List task returns a list of tasks associated with the Universal template. | N | templateId |
| n/a | Task Type of tasks to list. | Valid values: One of the following (not case sensitive): - As String = Workflow, As Value = 1
- As String = Timer, As Value = 2
- As String = Windows, As Value = 3
- As String = Linux/Unix, As Value = 4
- As String = z/OS, As Value = 5
- As String = Agent File Monitor, As Value = 6
- As String = Manual, As Value = 7
- As String = Email, As Value = 8
- As String = File Transfer, As Value = 9
- As String = SQL, As Value = 10
- As String = Remote File Monitor, As Value = 11
- As String = Task Monitor, As Value = 12
- As String = Stored Procedure, As Value = 13
- As String = Universal Command, As Value = 14
- As String = System Monitor, As Value = 15
- As String = Application Control, As Value = 16
- As String = SAP, As Value = 17
- As String = Variable Monitor, As Value = 18
- As String = Web Service, As Value = 19
- As String = Email Monitor, As Value = 20
- As String = PeopleSoft, As Value = 21
- As String = Recurring, As Value = 22
- As String = Universal Monitor, As Value = 23
- As String = Universal, As Value = 99
To list tasks for all task types, enter <type></type> in the request. | N |
|
Anchor |
---|
| updatedTime - LT |
---|
| updatedTime - LT |
---|
|
updatedTime | n/a | If updatedTimeType = Offset; -offset period. | Valid values: - mn (minutes)
- h (hours)
- d (days)
Default is d. Examples: -5d (last 5 days), -30mn (last 30 minutes), -6h (last 6 hours), -7 (last 7 days). If updatedTimeType is Since; date/time value (yyyy-MM-dd [HH:mm:ss]) If updatedTimeType is Today; updatedTime is ignored. Note |
---|
| The time is relative to the Time Zone specified for the User. |
| Y (if updatedTimeType is Offset , Since , or Older Than .) |
|
Anchor |
---|
| updatedTimeType - LT |
---|
| updatedTimeType - LT |
---|
|
updatedTimeType | n/a | Type of updateTime . | Valid values: - As String = Today, As Value = 1
- As String = Offset, As Value = 2
- As String = Since, As Value = 3
- As String = Older Than, As Value = 4
| N |
|
Anchor |
---|
| workflowid - LT |
---|
| workflowid - LT |
---|
|
workflowid | n/a | ID used within the Controller to identify a workflow. | If workflowid or workflowname is specified, List Tasks returns a list of tasks within that workflow. | N | workflowname
|
Anchor |
---|
| workflowname - LT |
---|
| workflowname - LT |
---|
|
workflowname | Task Name | Name of a workflow. | If workflowid or workflowname is specified, List Tasks returns a list of tasks within that workflow. | N | workflowid
|
...
Property | UI Field Name | Description | Specifications | Required | Mutually Exclusive With |
---|
Anchor |
---|
| agentname - LT |
---|
| agentname - LT |
---|
|
agentname | Agent | Agent on which this task was run. |
| N |
|
Anchor |
---|
| businessServices - LT |
---|
| businessServices - LT |
---|
|
businessServices | Member of Business Services | Business Services that this task belongs to. | Comma-separated list. | N |
|
Anchor |
---|
| taskname - LT |
---|
| taskname - LT |
---|
|
taskname | Task Name | Name or partial name of one or more tasks. | /wiki/spaces/UC71x/pages/5215217 are supported. | N |
|
| n/a | ID used within the controller to identify a template. | If a templateId or templateName is specified, List task returns a list of tasks associated with the Universal template. | N | templateName |
| Template Name | Name of a template. | If a templateId or templateName is specified, List task returns a list of tasks associated with the Universal template. | N | templateId |
| n/a | Task Type of tasks to list. | Valid values: One of the following (not case sensitive): - As String = Workflow, As Value = 1
- As String = Timer, As Value = 2
- As String = Windows, As Value = 3
- As String = Linux/Unix, As Value = 4
- As String = z/OS, As Value = 5
- As String = Agent File Monitor, As Value = 6
- As String = Manual, As Value = 7
- As String = Email, As Value = 8
- As String = File Transfer, As Value = 9
- As String = SQL, As Value = 10
- As String = Remote File Monitor, As Value = 11
- As String = Task Monitor, As Value = 12
- As String = Stored Procedure, As Value = 13
- As String = Universal Command, As Value = 14
- As String = System Monitor, As Value = 15
- As String = Application Control, As Value = 16
- As String = SAP, As Value = 17
- As String = Variable Monitor, As Value = 18
- As String = Web Service, As Value = 19
- As String = Email Monitor, As Value = 20
- As String = PeopleSoft, As Value = 21
- As String = Recurring, As Value = 22
- As String = Universal Monitor, As Value = 23
- As String = Universal, As Value = 99
To list tasks for all task types, enter <type></type> in the request. | N |
|
Anchor |
---|
| updatedTime - LT |
---|
| updatedTime - LT |
---|
|
updatedTime | n/a | If updatedTimeType = Offset; -offset period. | Valid values: - mn (minutes)
- h (hours)
- d (days)
Default is d. Examples: -5d (last 5 days), -30mn (last 30 minutes), -6h (last 6 hours), -7 (last 7 days - If
updatedTimeType is Since; date/time value (yyyy-MM-dd [HH:mm:ss]) - If
updatedTimeType is Today; updatedTime is ignored.
Note |
---|
| The time is relative to the Time Zone specified for the User. |
| Y (if updatedTimeType is Offset , Since , or Older Than .) |
|
Anchor |
---|
| updatedTimeType - LT |
---|
| updatedTimeType - LT |
---|
|
updatedTimeType | n/a | Type of updateTime . | Valid values: - As String = Today, As Value = 1
- As String = Offset, As Value = 2
- As String = Since, As Value = 3
- As String = Older Than, As Value = 4
| N |
|
Anchor |
---|
| workflowiId - LT |
---|
| workflowiId - LT |
---|
|
workflowid | n/a | ID used within the Controller to identify a workflow. | If workflowid or workflowname is specified, List Tasks returns a list of tasks within that workflow. | N | workflowname
|
Anchor |
---|
| workflowname - LT |
---|
| workflowname - LT |
---|
|
workflowname | Task Name | Name of a workflow. | If workflowid or workflowname is specified, List Tasks returns a list of tasks within that workflow. | N | workflowid
|
...