...
Anchor | ||||
---|---|---|---|---|
|
...
Parameter | Description | Specifications | Required | Mutually Exclusive With | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ID used within the Controller to identify this task. | String; URI parameter. | Y |
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Name used within the Controller to identify this task. | String; URI parameter. | Y |
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Examples | XML | JSON | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Example Request for Task |
| Example Request for Task-Related Records |
Anchor | Virtual Resources for Task-Related Records | Virtual Resources for Task-Related Records | Virtual Resources
|
|
| Example Response | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Expand | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Panel | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Expand | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Panel |
...
Property
...
UI Field Name
...
Description
...
Specifications
...
Required
...
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
...
Hold Reason
...
Information about why the task will be put on hold when it starts.
...
N
...
Task Name
...
Name of the task.
...
Y
...
Time Zone
...
Time Zone in the which the task is launched.
...
N
...
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
...
Property
...
UI Field Name
...
Description
...
Specifications
...
Required
...
Name
...
Name of the variable.
...
Y
...
Value
...
Value of the variable.
...
Y
...
The virtual resource dependencies specified in virtual-resources
are merged with the default virtual resource dependencies:
- If a default virtual resource dependency already exists for a specified virtual resource amount, the virtual resource dependency is updated.
- Any virtual resource specified with an amount of 0 is dropped from the default virtual resource dependencies; if the virtual resource did not exist as a default dependency, the command will fail.
- If a default virtual resource dependency does not already exist for a specified virtual resource amount, the virtual resource dependency is added. |
...
Property
...
UI Field Name
...
Description
...
Specifications
...
Required
...
Resource Description
...
Description of the virtual resource.
...
N
...
Resource Name
...
Name of the virtual resource.
...
Y
...
Resource Limit
...
Maximum number of units for this resource.
...
Y
...
Description
...
URI
...
HTTP Method
...
GET
...
Description
...
Retrieves a list of parent workflows that a task belongs to.
...
URI Parameters
...
See List All Workflows That a Task Belongs To: URI Parameters, below.
...
Example URI
...
- http://localhost:8080/uc/resources/task/parent/list?taskname=SB_JOB
- http://localhost:8080/uc/resources/task/parent/list?taskid=fcd85a9c486845139bee49cbd5af3d98
...
Authentication
...
HTTP Basic
...
Consumes Content-Type
...
n/a
...
Produces Content-Type
...
application/xml, application/json
...
Example Response
...
See List All Workflows That a Task Belongs To: XML and JSON Examples.
...
Response Properties
...
See List All Workflows That a Task Belongs To: Response Properties.
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Example Request for Task-Related Records |
|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Example Response |
|
|
Anchor | ||||
---|---|---|---|---|
|
Property | UI Field Name | Description | Specifications | Required | ||||||
---|---|---|---|---|---|---|---|---|---|---|
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 | ||||||
holdReason | Hold Reason | Information about why the task will be put on hold when it starts. | N | |||||||
name | Task Name | Name of the task. | Y | |||||||
timeZone | Time Zone | Time Zone in the which the task is launched. | N | |||||||
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 | ||||
---|---|---|---|---|
|
Property | UI Field Name | Description | Specifications | Required | ||||||
---|---|---|---|---|---|---|---|---|---|---|
name | Name | Name of the variable. | Y | |||||||
value | Value | Value of the variable. | Y |
Anchor | ||||
---|---|---|---|---|
|
The virtual resource dependencies specified in virtual-resources
are merged with the default virtual resource dependencies:
- If a default virtual resource dependency already exists for a specified virtual resource amount, the virtual resource dependency is updated.
- Any virtual resource specified with an amount of 0 is dropped from the default virtual resource dependencies; if the virtual resource did not exist as a default dependency, the command will fail.
- If a default virtual resource dependency does not already exist for a specified virtual resource amount, the virtual resource dependency is added. |
Property | UI Field Name | Description | Specifications | Required | ||||||
---|---|---|---|---|---|---|---|---|---|---|
description | Resource Description | Description of the virtual resource. | N | |||||||
name | Resource Name | Name of the virtual resource. | Y | |||||||
limit | Resource Limit | Maximum number of units for this resource. | Y |
Anchor | ||||
---|---|---|---|---|
|
Description | |
---|---|
URI | http://host_name/uc/resources/task/parent/list |
HTTP Method | GET |
Description | Retrieves a list of parent workflows that a task belongs to. |
URI Parameters | See List All Workflows That a Task Belongs To: URI Parameters, below. |
Example URI | |
Authentication | HTTP Basic |
Consumes Content-Type | n/a |
Produces Content-Type | application/xml, application/json |
Example Response | See List All Workflows That a Task Belongs To: XML and JSON Examples. |
Response Properties | See List All Workflows That a Task Belongs To: Response Properties. |
Anchor | ||||
---|---|---|---|---|
|
Parameter | Description | Specifications | Required | Mutually Exclusive With |
---|---|---|---|---|
| ID used within the Controller to identify this task. | String; URI parameter. | Y |
|
| Name used within the Controller to identify this task. | String; URI parameter. | Y |
|
Anchor | ||||
---|---|---|---|---|
|
Examples | XML | JSON | ||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Example Response |
|
|
Anchor | ||
---|---|---|
|
...
|
...
|
...
Examples
...
XML
...
JSON
...
Example Response
...
Expand | ||
---|---|---|
| ||
|
...
Expand | ||
---|---|---|
| ||
|
...
Property
...
UI Field Name
...
Description
...
Task Description
...
Response Properties
Property | UI Field Name | Description | ||||||
---|---|---|---|---|---|---|---|---|
description | Task Description | User-defined description of this workflow. | ||||||
name | Task Name | Name of this workflow. | ||||||
sysId | UUID | sys_id used within the Controller to identify this workflow. | ||||||
version | Version | Version number of this workflow. | ||||||
vertexId | n/a | Vertex ID of the task within this workflow. | ||||||
name
| n/a | Name (or alias) of the task within this workflow. |
Anchor | ||||
---|---|---|---|---|
|
Description | |
---|---|
URI | http://host_name/uc/resources/task/list |
HTTP Method | POST |
Description | Retrieves information on tasks matching specific search criteria. |
Example URI | http://localhost:8080/uc/resources/task/list |
Authentication | HTTP Basic |
Consumes Content-Type | application/xml, application/json |
Produces Content-Type | application/xml, application/json |
Example Request | |
Request Properties | |
Example Response |
...
Example Response
...
title | XML |
---|
...
title | JSON |
---|
...
Anchor |
---|
...
UUID
...
sys_id used within the Controller to identify this workflow.
...
Version
...
Version number of this workflow.
...
n/a
...
Vertex ID of the task within this workflow.
...
n/a
...
Name (or alias) of the task within this workflow.
...
Description
...
URI
...
HTTP Method
...
POST
...
Description
...
Retrieves information on tasks matching specific search criteria.
...
Example URI
...
Authentication
...
HTTP Basic
...
Consumes Content-Type
...
application/xml, application/json
...
Produces Content-Type
...
application/xml, application/json
...
Example Request
...
See List Tasks: XML and JSON Examples.
...
Request Properties
...
See List Tasks: Request Properties.
...
Example Response
...
See List Tasks: XML and JSON Examples.
...
Examples
...
XML
...
JSON
...
Example Request
...
Expand | ||
---|---|---|
| ||
<generic-query-filter> <name>*</name> <type>Timer</type> <updatedTimeType>offset</updatedTimeType> <updatedTime>-10d</updatedTime>or <generic-query-filter> <name>*</name> <workflowid>1463438057231012663TP5JP5EA8O1YS</workflowid> </generic-query-filter> |
...
Expand | ||
---|---|---|
| ||
All tasks in the last three minutes. { "name": "*", "updatedTimeType": "offset", "updatedTime": "-3mn", |
|
Examples | XML | JSON | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Example Request |
|
| ||||||||||||||||||
Example Response |
|
|
Anchor | ||||
---|---|---|---|---|
|
Property | UI Field Name | Description | Specifications | Required | Mutually Exclusive With | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
agentName | Agent | Agent on which this task was run. | N | |||||||||||||||
businessServices | Member of Business Services | Business Services that this task belongs to. | Comma-separated list. | N | ||||||||||||||
name | Task Name | Name or partial name of one or more tasks. | Wildcards are supported. | N | ||||||||||||||
type | n/a | Task Type of tasks to list. | Valid values: One of the following (not case sensitive):
To list tasks for all task types, enter | N | ||||||||||||||
updatedTime | n/a | If | Valid values:
Default is d.
| Y | ||||||||||||||
updatedTimeType | n/a | Type of | Valid values:
| N | ||||||||||||||
workflowid | n/a | ID used within the Controller to identify a workflow. | If | N |
| |||||||||||||
workflowname | Task Name | Name of a workflow. | If | N |
|
...
Property | UI Field Name | Description | Specifications | Required | Mutually Exclusive With | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
agentname | Agent | Agent on which this task was run. | N | |||||||||||||||
businessServices | Member of Business Services | Business Services that this task belongs to. | Comma-separated list. | N | ||||||||||||||
taskname | Task Name | Name or partial name of one or more tasks. | /wiki/spaces/UC71x/pages/5215217 are supported. | N | ||||||||||||||
type | n/a | Task Type of tasks to list. | Valid values: One of the following (not case sensitive):
To list tasks for all task types, enter | N | ||||||||||||||
updatedTime | n/a | If | Valid values:
Default is d.
| Y | ||||||||||||||
updatedTimeType | n/a | Type of | Valid values:
| N | ||||||||||||||
workflowid | n/a | ID used within the Controller to identify a workflow. | If | N |
| |||||||||||||
workflowname | Task Name | Name of a workflow. | If | N |
|
...