Page Comparison

Versions Compared

Old Version 12

changes.mady.by.user Stonebranch

Saved on Sept 20, 2022

compared with

New Version Current

changes.mady.by.user Stonebranch

Saved on Jan 27, 2023

Key

This line was added.
This line was removed.
Formatting was changed.

...

<virtual-resources> 
    <virtual-resource>
        <name>uc - Solo</name>
        <limit>2</limit>
    </virtual-resource>
</virtual-resources>

Examples

XML

JSON

Example Request for Task

virtualResourcePriority

/virtualResourcePriority

<task-launch>
    <variables/> 
    <virtual-resources /> 
    <name>Timer 0</name>
    <timeZone>America/Halifax</timeZone>
    <virtualResourcePriority>10</virtualResourcePriority>
    <hold>yes</hold>
    <holdReason>Waiting for input</holdReason>
</task-launch>

Expand

title	XML

Panel

virtualResourcePriority

hold

holdReason

{
    "variables": null, 
    "virtual-resources": null, 
    "name": "Timer 0",
    "timeZone": "America/Halifax",
    "virtualResourcePriority": 10,
    "hold": "yes",
    "holdReason": "Waiting for input"
}

Expand

title	JSON

Panel

Example Request for Task-Related Records

<variables>
   <variable>
         <name>testVar</name>
         <value>value</value>
   </variable>
</variables>

Expand

title	XML

Anchor

	Variables for Task-Related Records
	Variables for Task-Related Records

Variables

Panel

Anchor

	Virtual Resources for Task-Related Records
	Virtual Resources for Task-Related Records

Virtual Resources

Panel

virtualResourcePriority

hold

{
    "variables": [{
      "name": "testvar",
      "value": "abc"
    }],
    "virtualResources": [ {
      "name": "aaaaa",
      "limit": 2
    } ], 
    "name": "Timer 0",
    "virtualResourcePriority": 10,
    "hold": "yes"
}

Expand

title	JSON

Panel

Example Response

Expand

title	XML

Panel
<command-response> <type>launch</type> <success>true</success> <info>Successfully launched the Timer task Timer 0.</info> <sysId>1484021712811013671DQNWR5P2F9846</sysId> <errors /> </command-response>

Expand

title	JSON

Panel

...

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

...

Examples

XML

JSON

Example Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<workflows>
    <workflow>
        <name>WF_A</name>
        <sysId>2be1385324ab410995fda3f0292c07ee</sysId>
        <description />
        <version>2</version>
        <vertexName>SB_JOB</vertexName>
        <vertexId>2</vertexId>
    </workflow>
    <workflow>
        <name>WF_B</name>
        <sysId>c8d5ad7cee3f46288482872dbd63770c</sysId>
        <description />
        <version>43</version>
        <vertexName>SB_JOB</vertexName>
        <vertexId>2</vertexId>
    </workflow>
    <workflow>
        <name>WF_C</name>
        <sysId>830105616cc74d7d8d394bedc1c47a43</sysId>
        <description />
        <version>6</version>
        <vertexName>SB_JOB.1</vertexName>
        <vertexId>2</vertexId>
    </workflow>
    <workflow>
        <name>WF_C</name>
        <sysId>830105616cc74d7d8d394bedc1c47a43</sysId>
        <description />
        <version>6</version>
        <vertexName>SB_JOB.2</vertexName>
        <vertexId>3</vertexId>
    </workflow>
</workflows>

Expand

title	XML

Panel

Expand

title	JSON

Panel

[ {
  "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"
} ]

Anchor
List All Workflows That a Task Belongs To Response Properties
List All Workflows That a Task Belongs To Response Properties
List All Workflows That a Task Belongs To: Response Properties

Property

UI Field Name

Description

Anchor

	description - LAW
	description - LAW

description

Task Description

User-defined description of this workflow.

Anchor

	name - LAW
	name - LAW

name

Task Name

Name of this workflow.

Anchor

	sysId - LAW
	sysId - LAW

sysId

UUID

sys_id used within the Controller to identify this workflow.

Anchor

	version - LAW
	version - LAW

version

Version

Version number of this workflow.

Anchor

	vertexId - LAW
	vertexId - LAW

vertexId

n/a

Vertex ID of the task within this workflow.

Anchor

	vertexName - LAW
	vertexName - LAW

vertexName

n/a

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

Anchor
List Tasks
List Tasks
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.

Anchor
List Tasks XML and JSON Examples
List Tasks XML and JSON Examples
List Tasks: XML and JSON Examples

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

...

<generic-query-filter> <name>*</name>

Examples

XML

JSON

Example Request

Expand

title	XML

XML

JSON

Example Request

Expand

title	XML

<generic-query-filter>
      <name>*</name>
      <type>Timer</type>
      <updatedTimeType>offset</updatedTimeType>
      <updatedTime>-10d</updatedTime>
      <agentName>SBUS30 - AGNT0005</agentName>
      <businessServices>bService1,bService2</businessServices>
</generic-query-filter>

<generic-query-filter>
      <name>*</name>
      <workflowid>1463438057231012663TP5JP5EA8O1YS</workflowid>
</generic-query-filter>

Expand

title	JSON

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

 Or

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

Example Response

Expand

title	XML

<tasks>
    <task>
        <description>description</description>
        <name>test task 1</name>
        <type>Timer</type><sysID>410d6c0bc0a801c901838d8ac43b3279</sysID>
        <updatedTimeType>offset</updatedTimeType><type>Windows</type>
        <version>2</version>
    <updatedTime>-10d</updatedTime>
/task>
    <task>
      <agentName>SBUS30 - AGNT0005</agentName><description>description</description>
        <name>test task <businessServices>bService1,bService2</businessServices>
</generic-query-filter>

<generic-query-filter>
      <name>*</name>
 2</name>
        <sysID>410d6880c0a801c90196685fcc1ecb47</sysID>
        <type>Windows</type>
        <version>9</version>
    <workflowid>1463438057231012663TP5JP5EA8O1YS</workflowid>task>
</generic-query-filter>
tasks>

Expand

title	JSON

All tasks in the last three minutes.[ {
  "description": "Description",
  "name": "*test task 1",
      "updatedTimeTypesysId": "offset371be743130a4b18a9fc49961650593c",

     "updatedTimetype": "-3mnTimer",
  
   "agentNameversion": "SBUS30 - AGNT0005"
 } 23
}, {
  "description": "Description",
 Or 
{
 "name": "test task 2",
    "namesysId": "*10d58f96ab2b42e69d7e9bdde2ed21a7",
  "type": "Timer",
  "workflowidversion": "a21c68bba02c43919d5a6d6042a3f082"2
}

Example Response

Expand

title	XML

Panel

Expand

title	JSON

Panel

Anchor
List Tasks Request Properties
List Tasks Request Properties
List Tasks: Request Properties

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

Anchor

	agentName - LT
	agentName - LT

agentName

Agent

Agent on which this task was run.

Anchor

	businessServices - LT
	businessServices - LT

businessServices

Member of Business Services

Business Services that this task belongs to.

Comma-separated list.

Anchor

	name - LT
	name - LT

name

Task Name

Name or partial name of one or more tasks.

Wildcards are supported.

Anchor

	type - LT
	type - LT

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 = Universal, As Value = 99

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

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

title	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

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.

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.

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.

Anchor

	businessServices - LT
	businessServices - LT

businessServices

Member of Business Services

Business Services that this task belongs to.

Comma-separated list.

Anchor

	taskname - LT
	taskname - LT

taskname

Task Name

Name or partial name of one or more tasks.

/wiki/spaces/UC71x/pages/5215217 are supported.

Anchor

	type - LT
	type - LT

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 = Universal, As Value = 99

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

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

title	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

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.

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.

workflowid

...

Page Comparison

Versions Compared

Old Version 12

New Version Current

Key

AnchorLaunch a Task Request PropertiesLaunch a Task Request PropertiesLaunch a Task: Request Properties

AnchorList All Workflows That a Task Belongs To Response PropertiesList All Workflows That a Task Belongs To Response PropertiesList All Workflows That a Task Belongs To: Response Properties

AnchorList TasksList TasksList Tasks

AnchorList Tasks XML and JSON ExamplesList Tasks XML and JSON ExamplesList Tasks: XML and JSON Examples

AnchorList Tasks Request PropertiesList Tasks Request PropertiesList Tasks: Request Properties

Anchor
Launch a Task Request Properties
Launch a Task Request Properties
Launch a Task: Request Properties

Anchor
List All Workflows That a Task Belongs To Response Properties
List All Workflows That a Task Belongs To Response Properties
List All Workflows That a Task Belongs To: Response Properties

Anchor
List Tasks
List Tasks
List Tasks

Anchor
List Tasks XML and JSON Examples
List Tasks XML and JSON Examples
List Tasks: XML and JSON Examples

Anchor
List Tasks Request Properties
List Tasks Request Properties
List Tasks: Request Properties