Skip to main content
Version: 8.0

Task Web Services

Universal Controller supports the following RESTful-based web services for Task operations.

Formatting specifications for each web service, including details about parameter requirements, are provided.

Common Web Services​

The following web services are common to all Task types:

Detailed information for each of these web services is provided on this page.

Task-Specific Web Services​

The following web services are specific for each Task type:

  • Create a Task
  • Modify a Task
  • Read a Task

For detailed information about these task-specific web services, see:

Delete a Task​

Description

URI

http://host_name/uc/resources/task

HTTP Method

DELETE

Description

Deletes the specified task.

URI Parameters

See Delete a Task: URI Parameters, below.

Example URI

Authentication

HTTP Basic

Example Response

  • Status 200 /OK
    Task deleted successfully.
  • Status 400 /Bad Request
    Mutual exclusion violation. Cannot specify taskname and taskid at the same time.
  • Status 404 /Not Found
    A task with id "f87848b00a0001037f43e7c81c8ec969" does not exist.

Delete a Task: URI Parameters​

Parameter

Description

Specifications

Required

Mutually Exclusive With

taskid

ID used within the Controller to identify this task.

String; URI parameter.

Y
(unless taskname
is specified)

taskname

taskname

Name used within the Controller to identify this task.

String; URI parameter.

Y
(unless taskid
is specified)

taskid

Launch a Task​

Description

URI

http://host_name/uc/resources/task/launch

HTTP Method

POST

Description

Launches the specified task.

Example URI

http://localhost:8080/uc/resources/task/launch

Authentication

HTTP Basic

Consumes Content-Type

application/xml, application/json

Produces Content-Type

application/xml, application/json

Example Request

See Launch a Task: XML and JSON Examples.

Example Request for Task-Related Records

See Launch a Task: XML and JSON Examples.

Request Properties

See Launch a Task: Request Properties.

Request Task-Related Records Properties

Example Response

See Launch a Task: XML and JSON Examples.

Launch a Task: XML and JSON Examples​

Example Request for Task​

JSON
JSON
{
    "variables": null, 
    "virtual-resources": null, 
    "name": "Timer 0",
    "timeZone": "America/Halifax",
    "virtualResourcePriority": 10,
    "hold": "yes",
    "holdReason": "Waiting for input",
    "launchReason": "test"
}
JSON
JSON
{
    "variables": [{
      "name": "testvar",
      "value": "abc"
    }],
    "virtualResources": [ {
      "name": "aaaaa",
      "limit": 2
    } ], 
    "name": "Timer 0",
    "virtualResourcePriority": 10,
    "hold": "yes"
}

Example Response​

JSON
JSON
{
  "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"
}

Launch a Task: Request Properties​

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

launchReason

Launch Reason

Reason for the task launch

N

(Y if Task Launch Reason Required system property is True.)

name

Task Name

Name of the task.

Y

simulate

Simulate

Specifies if the workflow should execute under simulation mode.

Boolean; Valid values: true/false. Default is false.

N

timeZone

Time Zone

Time Zone in the which the task is launched.

N

variables

n/a

XML
<variables>
  <variable>
    <name>testVariable</name>
    <value>Hello</value>
  </variable>
</variables>

See Task-Related Records Properties Variables.

vertices

Vertex Selection

Specifies Root Vertices and/or Specific Vertices to be included in the triggered workflow.

A vertex can be specified by taskName, vertexName, or vertexId.

If you specify a vertexId, then only a single vertex will match, whereas, if you leave vertexId unspecified, any vertex matching by taskName or vertexName, will be selected.

To indicate a vertex selection is a Root Vertex, set the vertex root attribute to true. If vertex root attribute is unspecified or false, it indicates a vertex selection is a Specific Vertex.

Duplicate vertex specifications are ignored and do not prevent the operation from completing.

XML
XML
<vertices>
  <vertex root="true">
    <taskName>JOB_A</taskName>
  </vertex>
  <vertex>
    <vertexName>JOB_B</vertexName>
  </vertex>
  <vertex root="false">
    <vertexId>10</vertexId>
  </vertex>
</vertices>
JSON
JSON
"vertices": [
  {
    "taskName": "JOB_A",
    "root": true
  },
  {
    "vertexName": "JOB_B"
  },
  {
    "vertexId": "10",
    "root": false
  }
]

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 100 (low). Default is 10.

N

Property

UI Field Name

Description

Specifications

Required

name

Name

Name of the variable.

Y

value

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

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

List All Workflows That a Task Belongs To​

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.

List All Workflows That a Task Belongs To: URI Parameters​

Parameter

Description

Specifications

Required

Mutually Exclusive With

taskid

ID used within the Controller to identify this task.

String; URI parameter.

Y
(unless taskname
is specified)

taskname

taskname

Name used within the Controller to identify this task.

String; URI parameter.

Y
(unless taskid
is specified)

taskid

List All Workflows That a Task Belongs To: XML and JSON Examples​

JSON
JSON
[ {
  "name": "WF_A",
  "sysId": "2be1385324ab410995fda3f0292c07ee",
  "description": null,
  "version": 2,
  "vertexName": "SB_JOB",
  "vertexId": "2"
}, {
  "name": "WF_B",
  "sysId": "c8d5ad7cee3f46288482872dbd63770c",
  "description": null,
  "version": 43,
  "vertexName": "SB_JOB",
  "vertexId": "2"
}, {
  "name": "WF_C",
  "sysId": "830105616cc74d7d8d394bedc1c47a43",
  "description": null,
  "version": 6,
  "vertexName": "SB_JOB.1",
  "vertexId": "2"
}, {
  "name": "WF_C",
  "sysId": "830105616cc74d7d8d394bedc1c47a43",
  "description": null,
  "version": 6,
  "vertexName": "SB_JOB.2",
  "vertexId": "3"
} ]

List All Workflows That a Task Belongs To: 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.

vertexName

n/a

Name (or alias) of the task within this workflow.

List Tasks​

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

See List Tasks: XML and JSON Examples.

Request Properties

See List Tasks: Request Properties.

Example Response

See List Tasks: XML and JSON Examples.

List Tasks: XML and JSON Examples​

Example Request​

JSON
JSON
All tasks in the last three minutes.
{
      "name": "*",
      "updatedTimeType": "offset",
      "updatedTime": "-3mn",  
      "agentName": "SBUS30 - AGNT0005"
 }    

 Or

{
      "name": "*",  
      "templateId": "b21c68bba02c43919d5a6d6042a3f082"
      "workflowid": "a21c68bba02c43919d5a6d6042a3f082"
}

Example Response​

JSON
JSON
[ {
  "description": "Description",
  "name": "test task 1",
  "sysId": "371be743130a4b18a9fc49961650593c",
  "type": "Timer",
  "version": 23
}, {
  "description": "Description",
  "name": "test task 2",
  "sysId": "10d58f96ab2b42e69d7e9bdde2ed21a7",
  "type": "Timer",
  "version": 2
} ]

List Tasks: Request Properties​

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

responseFields

n/a

Specifies which additional fields are included in the response, beyond the default fields.

Comma-separated, case-insensitive list.

Options
  • * (all available fields)
  • avgRunTime
  • avgRunTimeDisplay
  • businessServices
  • firstRun
  • lastRun
  • lastRunTime
  • lastRunTimeDisplay
  • maxRunTime
  • maxRunTimeDisplay
  • minRunTime
  • minRunTimeDisplay
  • runCount
  • templateId
  • templateName

N

templateId

n/a

ID used within the controller to identify a template.

If a templateIdor templateName is specified, List task returns a list of tasks associated with the Universal template.

N

templateName

templateName

Template Name

Name of a template.

If a templateIdor templateName is specified, List task returns a list of tasks associated with the Universal template.

N

templateId

type

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 = IBM i, As Value = 24
  • As String = z/OS Monitor, As Value = 25
  • As String = Approval, As Value = 26
  • As String = Universal, As Value = 99

To list tasks for all task types, enter <type></type> in the request.

N

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.

info

The time is relative to the Time Zone specified for the User.

Y
(if updatedTimeType
is Offset, Since,
or Older Than.)

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

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

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

List Tasks - Advanced​

Description

URI

http://host_name/uc/resources/task/listadv

HTTP Method

GET

Description

Retrieve task details using specific query parameter(s).

Example URI

Authentication

HTTP Basic

Consumes Content-Type

n/a

Produces Content-Type

application/xml, application/json

URI Properties

See List Tasks - Advanced: URI Properties.

Example Response

See List Tasks - Advanced: XML and JSON Examples.

List Tasks - Advanced: XML and JSON Examples​

The retainSysIds and version properties are specified as attributes in XML.

The exportReleaseLevel and exportTable properties are specified as attributes in XML.

JSON
JSON
[
    {
        "type": "taskSleep",
        "actions": {
            "abortActions": [],
            "emailNotifications": [],
            "setVariableActions": [],
            "snmpNotifications": [],
            "systemOperations": []
        },
        "cpDuration": null,
        "cpDurationUnit": "Minutes",
        "customField1": {
            "label": null,
            "value": null
        },
        "customField2": {
            "label": null,
            "value": null
        },
        "efDayConstraint": "None",
        "efDuration": "00:00:00:00",
        "efEnabled": false,
        "efNthAmount": 5,
        "efOffsetDuration": null,
        "efOffsetDurationUnit": "Minutes",
        "efOffsetPercentage": 0,
        "efOffsetType": "Percentage",
        "efTime": "00:00",
        "efType": "Time",
        "exclusiveTasks": [],
        "executionRestriction": "None",  
        "exportReleaseLevel": "7.2.0.0",  
        "exportTable": "ops_task_sleep",
        "firstRun": "",
        "holdResources": false,
        "lastRun": "",
        "lfDayConstraint": "None",
        "lfDuration": "00:00:00:00",
        "lfEnabled": false,
        "lfNthAmount": 5,
        "lfOffsetDuration": null,
        "lfOffsetDurationUnit": "Minutes",
        "lfOffsetPercentage": 0,
        "lfOffsetType": "Percentage",
        "lfTime": "00:00",
        "lfType": "Time",
        "logLevel": "Inherited",
        "lsDayConstraint": "None",
        "lsDuration": "00:00:00:00",
        "lsEnabled": false,
        "lsNthAmount": 5,
        "lsTime": "00:00",
        "lsType": "Time",
        "name": "Sleep 0",
        "notes": [],
        "opswiseGroups": [],
        "resPriority": 10,
        "resolveNameImmediately": false,
        "restrictionPeriod": "None",
        "restrictionPeriodAfterDate": null,
        "restrictionPeriodAfterTime": null,
        "restrictionPeriodBeforeDate": null,
        "restrictionPeriodBeforeTime": null,
        "restrictionPeriodDateList": [],
        "retainSysIds": true,
        "runCount": 0,
        "runTime": 0,
        "sleepAmount": "0",
        "sleepDayConstraint": "None",
        "sleepDuration": "00:00:00:00",
        "sleepTime": "00:00",
        "sleepType": "Seconds",
        "startHeld": false,
        "startHeldReason": null,
        "summary": "Sleep for 0 seconds.",
        "sysId": "410d6c0bc0a801c901838d8ac43b3279",
        "timeZonePref": "-- System Default --",
        "userEstimatedDuration": null,
        "variables": [],
        "version": 1,
        "virtualResources": []
    },

    {
        "type": "taskWindows",
        "actions": {
            "abortActions": [],
            "emailNotifications": [],
            "setVariableActions": [],
            "snmpNotifications": [],
            "systemOperations": []
        },
        "agent": "SBUS30 - AGNT0005",
        "agentCluster": null,
        "agentClusterVar": null,
        "agentVar": null,
        "avgRunTime": 0,
        "avgRunTimeDisplay": "0 Seconds",
        "broadcastCluster": null,
        "broadcastClusterVar": null,
        "command": "echo",
        "commandOrScript": "Command",
        "cpDuration": null,
        "cpDurationUnit": "Minutes",
        "createConsole": false,
        "credentials": null,
        "credentialsVar": null,
        "customField1": {
            "label": null,
            "value": null
        },
        "customField2": {
            "label": null,
            "value": null
        },
        "desktopInteract": false,  
        "efDayConstraint": "None",
        "efDuration": "00:00:00:00",
        "efEnabled": false,
        "efNthAmount": 5,
        "efOffsetDuration": null,
        "efOffsetDurationUnit": "Minutes",
        "efOffsetPercentage": 0,
        "efOffsetType": "Percentage",
        "efTime": "00:00",
        "efType": "Time",
        "elevateUser": false,
        "environment": [],
        "exclusiveTasks": [],
        "executionRestriction": "None",
        "exitCodeOutput": null,
        "exitCodeProcessing": "Success Exitcode Range",
        "exitCodeText": null,
        "exitCodes": "0",  
        "exportReleaseLevel": "7.2.0.0",  
        "exportTable": "ops_task_windows",
        "firstRun": "2021-04-19 13:22:20 -0400",
        "holdResources": false,
        "lastRun": "2021-04-28 14:39:56 -0400",
        "lastRunTime": 0,
        "lastRunTimeDisplay": "0 Seconds",
        "lfDayConstraint": "None",
        "lfDuration": "00:00:00:00",
        "lfEnabled": false,
        "lfNthAmount": 5,
        "lfOffsetDuration": null,
        "lfOffsetDurationUnit": "Minutes",
        "lfOffsetPercentage": 0,
        "lfOffsetType": "Percentage",
        "lfTime": "00:00",
        "lfType": "Time",
        "logLevel": "Inherited",
        "lsDayConstraint": "None",
        "lsDuration": "00:00:00:00",
        "lsEnabled": false,
        "lsNthAmount": 5,
        "lsTime": "00:00",
        "lsType": "Time",
        "maxRunTime": 0,
        "maxRunTimeDisplay": "0 Seconds",
        "minRunTime": 0,
        "minRunTimeDisplay": "0 Seconds",
        "name": "task-1",
        "notes": [],
        "opswiseGroups": [
            "A",
            "C"
        ],
        "outputFailureOnly": false,
        "outputReturnFile": null,
        "outputReturnNline": "100",
        "outputReturnSline": "1",
        "outputReturnText": null,
        "outputReturnType": "NONE",
        "outputType": "STDOUT",
        "parameters": null,
        "resPriority": 10,
        "resolveNameImmediately": false,
        "restrictionPeriod": "None",
        "restrictionPeriodAfterDate": null,
        "restrictionPeriodAfterTime": null,
        "restrictionPeriodBeforeDate": null,
        "restrictionPeriodBeforeTime": null,
        "restrictionPeriodDateList": [],
        "retainSysIds": true,
        "retryExitCodes": null,
        "retryIndefinitely": false,
        "retryInterval": 60,
        "retryMaximum": 0,
        "retrySuppressFailure": false,
        "runCount": 6,
        "runTime": 0,
        "runtimeDir": null,
        "script": null,
        "startHeld": true,
        "startHeldReason": null,
        "summary": null,
        "sysId": "3bf2471eea8f4ec0b765d5ada2c8f02c",
        "timeZonePref": "-- System Default --",
        "twDelayAmount": null,
        "twDelayDuration": "00:00:00:00",
        "twDelayType": "None",
        "twWaitAmount": null,
        "twWaitDayConstraint": "None",
        "twWaitDuration": "00:00:00:00",
        "twWaitTime": "00:00",
        "twWaitType": "None",
        "twWorkflowOnly": "-- System Default --",
        "userEstimatedDuration": null,
        "variables": [
            {
                "description": "task test 1",
                "name": "task_var_1",
                "sysId": "f7482cdb83264483ae45c372b6f4c284",
                "value": "task 1"
            },
            {
                "description": "test 2",
                "name": "task_var_2",
                "sysId": "bc2e3edd9125433c8dcc00ffc3560fd0",
                "value": "var 2"
            }
        ],
        "version": 10,
        "virtualResources": [
            {
                "amount": 2,
                "resource": "VR-3",
                "resourceVar": null,
                "sysId": "9cc6002db09445cb956454a72523add2"
            },
            {
                "amount": 2,
                "resource": "VR-1",
                "resourceVar": null,
                "sysId": "b3b5d664b7b54202a0439361a154b53d"
            }
        ],
        "waitForOutput": false
    },
    {
        "type": "taskWindows",
        "actions": {
            "abortActions": [],
            "emailNotifications": [],
            "setVariableActions": [],
            "snmpNotifications": [],
            "systemOperations": []
        },
        "agent": "SBUS30 - AGNT0005",
        "agentCluster": null,
        "agentClusterVar": null,
        "agentVar": null,
        "avgRunTime": 0,
        "avgRunTimeDisplay": "0 Seconds",
        "broadcastCluster": null,
        "broadcastClusterVar": null,
        "command": "echo",
        "commandOrScript": "Command",
        "cpDuration": null,
        "cpDurationUnit": "Minutes",
        "createConsole": false,
        "credentials": null,
        "credentialsVar": null,
        "customField1": {
            "label": null,
            "value": null
        },
        "customField2": {
            "label": null,
            "value": null
        },
        "desktopInteract": false,  
        "efDayConstraint": "None",
        "efDuration": "00:00:00:00",
        "efEnabled": false,
        "efNthAmount": 5,
        "efOffsetDuration": null,
        "efOffsetDurationUnit": "Minutes",
        "efOffsetPercentage": 0,
        "efOffsetType": "Percentage",
        "efTime": "00:00",
        "efType": "Time",
        "elevateUser": false,
        "environment": [],
        "exclusiveTasks": [],
        "executionRestriction": "None",
        "exitCodeOutput": null,
        "exitCodeProcessing": "Success Exitcode Range",
        "exitCodeText": null,
        "exitCodes": "0",  
        "exportReleaseLevel": "7.2.0.0",  
        "exportTable": "ops_task_windows",
        "firstRun": "2021-04-28 13:26:01 -0400",
        "holdResources": false,
        "lastRun": "2021-04-28 14:39:56 -0400",
        "lastRunTime": 0,
        "lastRunTimeDisplay": "0 Seconds",
        "lfDayConstraint": "None",
        "lfDuration": "00:00:00:00",
        "lfEnabled": false,
        "lfNthAmount": 5,
        "lfOffsetDuration": null,
        "lfOffsetDurationUnit": "Minutes",
        "lfOffsetPercentage": 0,
        "lfOffsetType": "Percentage",
        "lfTime": "00:00",
        "lfType": "Time",
        "logLevel": "Inherited",
        "lsDayConstraint": "None",
        "lsDuration": "00:00:00:00",
        "lsEnabled": false,
        "lsNthAmount": 5,
        "lsTime": "00:00",
        "lsType": "Time",
        "maxRunTime": 0,
        "maxRunTimeDisplay": "0 Seconds",
        "minRunTime": 0,
        "minRunTimeDisplay": "0 Seconds",
        "name": "task-2",
        "notes": [],
        "opswiseGroups": [
            "A"
        ],
        "outputFailureOnly": false,
        "outputReturnFile": null,
        "outputReturnNline": "100",
        "outputReturnSline": "1",
        "outputReturnText": null,
        "outputReturnType": "NONE",
        "outputType": "STDOUT",
        "parameters": null,
        "resPriority": 10,
        "resolveNameImmediately": false,
        "restrictionPeriod": "None",
        "restrictionPeriodAfterDate": null,
        "restrictionPeriodAfterTime": null,
        "restrictionPeriodBeforeDate": null,
        "restrictionPeriodBeforeTime": null,
        "restrictionPeriodDateList": [],
        "retainSysIds": true,
        "retryExitCodes": null,
        "retryIndefinitely": false,
        "retryInterval": 60,
        "retryMaximum": 0,
        "retrySuppressFailure": false,
        "runCount": 3,
        "runTime": 0,
        "runtimeDir": null,
        "script": null,
        "startHeld": false,
        "startHeldReason": null,
        "summary": null,
        "sysId": "6d982646fd8348f8af22edcad25c8051",
        "timeZonePref": "-- System Default --",
        "twDelayAmount": null,
        "twDelayDuration": "00:00:00:00",
        "twDelayType": "None",
        "twWaitAmount": null,
        "twWaitDayConstraint": "None",
        "twWaitDuration": "00:00:00:00",
        "twWaitTime": "00:00",
        "twWaitType": "None",
        "twWorkflowOnly": "-- System Default --",
        "userEstimatedDuration": null,
        "variables": [
            {
                "description": "task test 1",
                "name": "task_var_1",
                "sysId": "cfebdc6608cc4df9b2753d42f0e71864",
                "value": "task 1"
            },
            {
                "description": "test 2",
                "name": "task_var_2",
                "sysId": "19493279e1114b06b79bb8e0c00664b5",
                "value": "var 2"
            }
        ],
        "version": 8,
        "virtualResources": [
            {
                "amount": 2,
                "resource": "VR-1",
                "resourceVar": null,
                "sysId": "09e4b42858fb4930b8a13f5b036bac42"
            },
            {
                "amount": 2,
                "resource": "VR-2",
                "resourceVar": null,
                "sysId": "86ca6beb4d20490dbea6901515501087"
            },
            {
                "amount": 2,
                "resource": "VR-3",
                "resourceVar": null,
                "sysId": "aeaf3ce2b1ad4e9aae92c7d5eb475ab0"
            }
        ],
        "waitForOutput": false
    },
    {
        "type": "taskUniversal",
        "actions": {
            "abortActions": [],
            "emailNotifications": [],
            "setVariableActions": [],
            "snmpNotifications": [],
            "systemOperations": []
        },
        "agent": "SBUS30 - AGNT0005",
        "agentCluster": null,
        "agentClusterVar": null,
        "agentVar": null,
        "autoCleanup": false,
        "broadcastCluster": null,
        "broadcastClusterVar": null,
        "cpDuration": null,
        "cpDurationUnit": "Minutes",
        "createConsole": false,
        "credentials": null,
        "credentialsVar": null,
        "customField1": {
            "label": null,
            "value": null
        },
        "customField2": {
            "label": null,
            "value": null
        },
        "desktopInteract": false,  
        "efDayConstraint": "None",
        "efDuration": "00:00:00:00",
        "efEnabled": false,
        "efNthAmount": 5,
        "efOffsetDuration": null,
        "efOffsetDurationUnit": "Minutes",
        "efOffsetPercentage": 0,
        "efOffsetType": "Percentage",
        "efTime": "00:00",
        "efType": "Time",
        "elevateUser": false,
        "environment": [],
        "exclusiveTasks": [],
        "executionRestriction": "None",
        "exitCodeOutput": null,
        "exitCodeProcessing": "Success Exitcode Range",
        "exitCodeText": null,
        "exitCodes": "0",  
        "exportReleaseLevel": "7.2.0.0",  
        "exportTable": "ops_task_universal",
        "firstRun": "",
        "holdResources": false,
        "lastRun": "",
        "lfDayConstraint": "None",
        "lfDuration": "00:00:00:00",
        "lfEnabled": false,
        "lfNthAmount": 5,
        "lfOffsetDuration": null,
        "lfOffsetDurationUnit": "Minutes",
        "lfOffsetPercentage": 0,
        "lfOffsetType": "Percentage",
        "lfTime": "00:00",
        "lfType": "Time",
        "logLevel": "Inherited",
        "lsDayConstraint": "None",
        "lsDuration": "00:00:00:00",
        "lsEnabled": false,
        "lsNthAmount": 5,
        "lsTime": "00:00",
        "lsType": "Time",
        "name": "uni1-task-1",
        "notes": [],
        "opswiseGroups": [],
        "outputConditionOperator": "=",
        "outputConditionStrategy": "Match Any",
        "outputConditionValue": null,
        "outputContentType": null,
        "outputFailureOnly": false,
        "outputPathExpression": null,
        "outputReturnFile": null,
        "outputReturnNline": "100",
        "outputReturnSline": "1",
        "outputReturnText": null,
        "outputReturnType": "NONE",
        "outputType": "STDOUT",
        "resPriority": 10,
        "resolveNameImmediately": false,
        "restrictionPeriod": "None",
        "restrictionPeriodAfterDate": null,
        "restrictionPeriodAfterTime": null,
        "restrictionPeriodBeforeDate": null,
        "restrictionPeriodBeforeTime": null,
        "restrictionPeriodDateList": [],
        "retainSysIds": true,
        "retryExitCodes": null,
        "retryIndefinitely": false,
        "retryInterval": 60,
        "retryMaximum": 0,
        "retrySuppressFailure": false,
        "runCount": 0,
        "runTime": 0,
        "runtimeDir": null,
        "startHeld": false,
        "startHeldReason": null,
        "summary": null,
        "sysId": "3ec6a8aa962042e599011536d48d4335",
        "template": "uni-1",
        "textField1": {
            "label": "txt1",
            "name": "txt1",
            "value": null
        },
        "timeZonePref": "-- System Default --",
        "twDelayAmount": null,
        "twDelayDuration": "00:00:00:00",
        "twDelayType": "None",
        "twWaitAmount": null,
        "twWaitDayConstraint": "None",
        "twWaitDuration": "00:00:00:00",
        "twWaitTime": "00:00",
        "twWaitType": "None",
        "twWorkflowOnly": "-- System Default --",
        "userEstimatedDuration": null,
        "variables": [],
        "version": 1,
        "virtualResources": [],
        "waitForOutput": false
    },
    {
        "type": "taskUnix",
        "actions": {
            "abortActions": [],
            "emailNotifications": [],
            "setVariableActions": [],
            "snmpNotifications": [],
            "systemOperations": []
        },
        "agent": null,
        "agentCluster": null,
        "agentClusterVar": null,
        "agentVar": "${agent_var}",
        "broadcastCluster": null,
        "broadcastClusterVar": null,
        "command": "echo",
        "commandOrScript": "Command",
        "cpDuration": null,
        "cpDurationUnit": "Minutes",
        "credentials": null,
        "credentialsVar": null,
        "customField1": {
            "label": null,
            "value": null
        },
        "customField2": {
            "label": null,
            "value": null
        },  
        "efDayConstraint": "None",
        "efDuration": "00:00:00:00",
        "efEnabled": false,
        "efNthAmount": 5,
        "efOffsetDuration": null,
        "efOffsetDurationUnit": "Minutes",
        "efOffsetPercentage": 0,
        "efOffsetType": "Percentage",
        "efTime": "00:00",
        "efType": "Time",
        "environment": [],
        "exclusiveTasks": [],
        "executionRestriction": "None",
        "exitCodeOutput": null,
        "exitCodeProcessing": "Success Exitcode Range",
        "exitCodeText": null,
        "exitCodes": "0",  
        "exportReleaseLevel": "7.2.0.0",  
        "exportTable": "ops_task_unix",
        "firstRun": "",
        "holdResources": false,
        "lastRun": "",
        "lfDayConstraint": "None",
        "lfDuration": "00:00:00:00",
        "lfEnabled": false,
        "lfNthAmount": 5,
        "lfOffsetDuration": null,
        "lfOffsetDurationUnit": "Minutes",
        "lfOffsetPercentage": 0,
        "lfOffsetType": "Percentage",
        "lfTime": "00:00",
        "lfType": "Time",
        "logLevel": "Inherited",
        "lsDayConstraint": "None",
        "lsDuration": "00:00:00:00",
        "lsEnabled": false,
        "lsNthAmount": 5,
        "lsTime": "00:00",
        "lsType": "Time",
        "name": "unix-task-1",
        "notes": [],
        "opswiseGroups": [
            "A"
        ],
        "outputFailureOnly": false,
        "outputReturnFile": null,
        "outputReturnNline": "100",
        "outputReturnSline": "1",
        "outputReturnText": null,
        "outputReturnType": "NONE",
        "outputType": "STDOUT",
        "parameters": null,
        "resPriority": 10,
        "resolveNameImmediately": false,
        "restrictionPeriod": "None",
        "restrictionPeriodAfterDate": null,
        "restrictionPeriodAfterTime": null,
        "restrictionPeriodBeforeDate": null,
        "restrictionPeriodBeforeTime": null,
        "restrictionPeriodDateList": [],
        "retainSysIds": true,
        "retryExitCodes": null,
        "retryIndefinitely": false,
        "retryInterval": 60,
        "retryMaximum": 0,
        "retrySuppressFailure": false,
        "runAsSudo": false,
        "runCount": 0,
        "runTime": 0,
        "runtimeDir": null,
        "script": null,
        "startHeld": false,
        "startHeldReason": null,
        "summary": null,
        "sysId": "4b1fb4c2a8e5427290022411aea206f5",
        "timeZonePref": "-- System Default --",
        "twDelayAmount": null,
        "twDelayDuration": "00:00:00:00",
        "twDelayType": "None",
        "twWaitAmount": null,
        "twWaitDayConstraint": "None",
        "twWaitDuration": "00:00:00:00",
        "twWaitTime": "00:00",
        "twWaitType": "None",
        "twWorkflowOnly": "-- System Default --",
        "userEstimatedDuration": null,
        "variables": [],
        "version": 1,
        "virtualResources": [],
        "waitForOutput": false
    },
    {
        "type": "taskWorkflow",
        "actions": {
            "abortActions": [],
            "emailNotifications": [],
            "setVariableActions": [],
            "snmpNotifications": [],
            "systemOperations": []
        },
        "calculateCp": false,
        "calendar": null,
        "cpDuration": null,
        "cpDurationUnit": "Minutes",
        "customField1": {
            "label": null,
            "value": null
        },
        "customField2": {
            "label": null,
            "value": null
        },
        "efDayConstraint": "None",
        "efDuration": "00:00:00:00",
        "efEnabled": false,
        "efNthAmount": 5,
        "efOffsetDuration": null,
        "efOffsetDurationUnit": "Minutes",
        "efOffsetPercentage": 0,
        "efOffsetType": "Percentage",
        "efTime": "00:00",
        "efType": "Time",
        "exclusiveTasks": [],
        "executionRestriction": "None",  
        "exportReleaseLevel": "7.2.0.0",  
        "exportTable": "ops_task_workflow",
        "firstRun": "",
        "holdResources": false,
        "lastRun": "",
        "layoutOption": "-- None --",
        "lfDayConstraint": "None",
        "lfDuration": "00:00:00:00",
        "lfEnabled": false,
        "lfNthAmount": 5,
        "lfOffsetDuration": null,
        "lfOffsetDurationUnit": "Minutes",
        "lfOffsetPercentage": 0,
        "lfOffsetType": "Percentage",
        "lfTime": "00:00",
        "lfType": "Time",
        "logLevel": "Inherited",
        "lsDayConstraint": "None",
        "lsDuration": "00:00:00:00",
        "lsEnabled": false,
        "lsNthAmount": 5,
        "lsTime": "00:00",
        "lsType": "Time",
        "name": "work-task-1",
        "notes": [],
        "numberOfTasks": 4,
        "opswiseGroups": [
            "A",
            "B"
        ],
        "overrideCalendar": false,
        "resPriority": 5,
        "resolveNameImmediately": true,
        "restrictionPeriod": "None",
        "restrictionPeriodAfterDate": null,
        "restrictionPeriodAfterTime": null,
        "restrictionPeriodBeforeDate": null,
        "restrictionPeriodBeforeTime": null,
        "restrictionPeriodDateList": [],
        "retainSysIds": true,
        "runCount": 0,
        "runCriteria": [],
        "runTime": 0,
        "skippedOption": "Show Skipped",
        "startHeld": false,
        "startHeldReason": null,
        "stepActions": [],
        "stepConditions": [],
        "summary": "Workflow 1",
        "sysId": "846157d645fe4f989a03483685c91a08",
        "timeZonePref": "-- System Default --",
        "twDelayAmount": null,
        "twDelayDuration": "00:00:00:00",
        "twDelayType": "None",
        "twWaitAmount": null,
        "twWaitDayConstraint": "None",
        "twWaitDuration": "00:00:00:00",
        "twWaitTime": "00:00",
        "twWaitType": "None",
        "twWorkflowOnly": "-- System Default --",
        "userEstimatedDuration": null,
        "variables": [],
        "version": 2,
        "virtualResources": [],
        "workflowEdges": [
            {
                "condition": {
                    "value": "Success"
                },
                "sourceId": {
                    "taskName": "task-1",
                    "value": "2"
                },
                "straightEdge": true,
                "targetId": {
                    "taskName": "Sleep 30",
                    "value": "3"
                }
            },
            {
                "condition": {
                    "value": "Success"
                },
                "sourceId": {
                    "taskName": "Sleep 30",
                    "value": "3"
                },
                "straightEdge": true,
                "targetId": {
                    "taskName": "task-2",
                    "value": "7"
                }
            },
            {
                "condition": {
                    "value": "Success"
                },
                "sourceId": {
                    "taskName": "task-2",
                    "value": "7"
                },
                "straightEdge": true,
                "targetId": {
                    "taskName": "Sleep 60",
                    "value": "9"
                }
            }
        ],
        "workflowVertices": [
            {
                "alias": null,
                "task": {
                    "value": "task-1"
                },
                "vertexId": "2",
                "vertexX": "110",
                "vertexY": "80"
            },
            {
                "alias": null,
                "task": {
                    "value": "Sleep 30"
                },
                "vertexId": "3",
                "vertexX": "270",
                "vertexY": "70"
            },
            {
                "alias": null,
                "task": {
                    "value": "task-2"
                },
                "vertexId": "7",
                "vertexX": "290",
                "vertexY": "220"
            },
            {
                "alias": null,
                "task": {
                    "value": "Sleep 60"
                },
                "vertexId": "9",
                "vertexX": "140",
                "vertexY": "260"
            }
        ]
    }
]

List Tasks - Advanced: URI Properties​

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.

Wildcards are supported.

N

templateId

n/a

ID used within the controller to identify a template.

If a templateIdor templateName is specified, List task returns a list of tasks associated with the Universal template.

N

templateName

templateName

Template Name

Name of a template.

If a templateIdor templateName is specified, List task returns a list of tasks associated with the Universal template.

N

templateId

type

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 = IBM i, As Value = 24
  • As String = z/OS Monitor, As Value = 25
  • As String = Approval, As Value = 26
  • As String = Universal, As Value = 99

To list tasks for all task types, enter <type></type> in the request.

N

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.
info

The time is relative to the Time Zone specified for the User.

Y
(if updatedTimeType
is Offset, Since,
or Older Than.)

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

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

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