Versions Compared

Old Version 14

changes.mady.by.user Stonebranch

Saved on

compared with

New Version 15

changes.mady.by.user IT Stonebranch

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Macro name changed from html to html-bobswift during server to cloud migration processing.

...

Anchor
Launch a Task XML and JSON Examples
Launch a Task XML and JSON Examples
Launch a Task: XML and JSON Examples

...

Virtual Resources

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

Examples

XML

JSON

Example Request for Task

Expand
titleXML

Example Request for Task-Related Records

Variables
Expand
titleXML
Anchor
Variables for Task-Related RecordsVariables for Task-Related Records
Panel

name

/name

value

/value

Anchor
Virtual Resources for Task-Related RecordsVirtual Resources for Task-Related Records
Panel

name

/name

limit

/limit

Panel
Html bobswift
<pre>
&lt;task-launch&gt;
    &lt;

variables

Html bobswift
 /&gt; 
    &lt;

virtual-resourcesname

Html bobswift
 /
name

timeZone

/timeZone

virtualResourcePriority

/virtualResourcePriority

hold

/hold

holdReason

/holdReason

Expand
titleJSON
Panel

variables

virtual-resources

name

timeZone

virtualResourcePriority

hold

holdReason

&gt; 
    &lt;

name

Html bobswift
&gt;Timer 0&lt;

/name

Html bobswift
&gt;
    &lt;

timeZone

Html bobswift
&gt;America/Halifax&lt;

/timeZone

Html bobswift
&gt;
    &lt;

virtualResourcePriority

Html bobswift
&gt;10&lt;

/virtualResourcePriority

Html bobswift
&gt;
    &lt;

hold

Html bobswift
&gt;yes&lt;

/hold

Html bobswift
&gt;
    &lt;

holdReason

Html bobswift
&gt;Waiting for input&lt;

/holdReason

Html bobswift
&gt;
&lt;/task-launch&gt; 
</pre>
Expand
titleJSON
Panel

name

value

name

limit

name

virtualResourcePriority

hold

Example Response

Expand
titleXML
Panel Expand
titleJSON
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

...

...

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.

Html bobswift
<pre>
{
    "

variables

Html bobswift
": null, 
    "

virtual-resources

Html bobswift
": null, 
    "

name

Html bobswift
": "Timer 0",
    "

timeZone

Html bobswift
": "America/Halifax",
    "

virtualResourcePriority

Html bobswift
": 10,
    "

hold

Html bobswift
": "yes",
    "

holdReason

Html bobswift
": "Waiting for input"
}
</pre>

Example Request for Task-Related Records

Expand
titleXML

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

Panel
Html bobswift
<pre>
&lt;variables&gt;
   &lt;variable&gt;
         &lt;

name

Html bobswift
&gt;testVar&lt;

/name

Html bobswift
&gt;
         &lt;

value

Html bobswift
&gt;value&lt;

/value

Html bobswift
&gt;
   &lt;/variable&gt;
&lt;/variables&gt;
</pre>

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

Panel
Html bobswift
<pre>
&lt;virtual-resources&gt; 
    &lt;virtual-resource&gt;
        &lt;

name

Html bobswift
&gt;uc - Solo&lt;

/name

Html bobswift
&gt;
        &lt;

limit

Html bobswift
&gt;2&lt;

/limit

Html bobswift
&gt;
    &lt;/virtual-resource&gt;
&lt;/virtual-resources&gt; 
</pre>
Expand
titleJSON
Panel
Html bobswift
<pre>
{
    "variables": [{
      "

name

Html bobswift
": "testvar",
      "

value

Html bobswift
": "abc"
    }],
    "virtualResources": [ {
      "

name

Html bobswift
": "aaaaa",
      "

limit

Html bobswift
": 2
    } ], 
    "

name

Html bobswift
": "Timer 0",
    "

virtualResourcePriority

Html bobswift
": 10,
    "

hold

Html bobswift
": "yes"
}
</pre>

Example Response

Expand
titleXML
Panel
Html bobswift
<pre>
&lt;command-response&gt;
    &lt;type&gt;launch&lt;/type&gt;
    &lt;success&gt;true&lt;/success&gt;
    &lt;info&gt;Successfully launched the Timer task Timer 0.&lt;/info&gt;
    &lt;sysId&gt;1484021712811013671DQNWR5P2F9846&lt;/sysId&gt;
    &lt;errors /&gt;
&lt;/command-response&gt; 
</pre>
Expand
titleJSON
Panel
Html bobswift
<pre>
{
"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"
}
</pre>

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

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

Anchor
name - Var
name - Var
name

Name

Name of the variable.


Y

Anchor
value - Var
value - Var
value

Value

Value of the variable.


Y

Anchor
Task-Related Records Properties Virtual Resources
Task-Related Records Properties Virtual Resources
Task-Related Records Properties: Virtual Resources

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

Anchor
description - VR
description - VR
description

Resource Description

Description of the virtual resource.


N

Anchor
name - VR
name - VR
name

Resource Name

Name of the virtual resource.


Y

Anchor
limit - VR
limit - VR
limit

Resource Limit

Maximum number of units for this resource.


Y

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

Anchor
List All Workflows That a Task Belongs To URI Parameters
List All Workflows That a Task Belongs To URI Parameters
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

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

Examples

XML

JSON

Example Response

Expand
titleXML
Panel
Html bobswift
<pre>
&lt;?xml version="1.0" encoding="UTF-8" standalone="yes"?&gt;
&lt;workflows&gt;
    &lt;workflow&gt;
        &lt;

name

Html bobswift
&gt;WF_A&lt;

/name

Html bobswift
&gt;
        &lt;

sysId

Html bobswift
&gt;2be1385324ab410995fda3f0292c07ee&lt;

/sysId

Html bobswift
&gt;
        &lt;

description

Html bobswift
 /&gt;
        &lt;

version

Html bobswift
&gt;2&lt;

/version

Html bobswift
&gt;
        &lt;

vertexName

Html bobswift
&gt;SB_JOB&lt;

/vertexName

Html bobswift
&gt;
        &lt;

vertexId

Html bobswift
&gt;2&lt;

/vertexId

Html bobswift
&gt;
    &lt;/workflow&gt;
    &lt;workflow&gt;
        &lt;name&gt;WF_B&lt;/name&gt;
        &lt;sysId&gt;c8d5ad7cee3f46288482872dbd63770c&lt;/sysId&gt;
        &lt;description /&gt;
        &lt;version&gt;43&lt;/version&gt;
        &lt;vertexName&gt;SB_JOB&lt;/vertexName&gt;
        &lt;vertexId&gt;2&lt;/vertexId&gt;
    &lt;/workflow&gt;
    &lt;workflow&gt;
        &lt;name&gt;WF_C&lt;/name&gt;
        &lt;sysId&gt;830105616cc74d7d8d394bedc1c47a43&lt;/sysId&gt;
        &lt;description /&gt;
        &lt;version&gt;6&lt;/version&gt;
        &lt;vertexName&gt;SB_JOB.1&lt;/vertexName&gt;
        &lt;vertexId&gt;2&lt;/vertexId&gt;
    &lt;/workflow&gt;
    &lt;workflow&gt;
        &lt;name&gt;WF_C&lt;/name&gt;
        &lt;sysId&gt;830105616cc74d7d8d394bedc1c47a43&lt;/sysId&gt;
        &lt;description /&gt;
        &lt;version&gt;6&lt;/version&gt;
        &lt;vertexName&gt;SB_JOB.2&lt;/vertexName&gt;
        &lt;vertexId&gt;3&lt;/vertexId&gt;
    &lt;/workflow&gt;
&lt;/workflows&gt;
</pre>
Expand
titleJSON
Panel
Html bobswift
<pre>
[ {
  "

name

Html bobswift
": "WF_A",
  "

sysId

Html bobswift
": "2be1385324ab410995fda3f0292c07ee",
  "

description

Html bobswift
": null,
  "

version

Html bobswift
": 2,
  "

vertexName

Html bobswift
": "SB_JOB",
  "

vertexId

Html bobswift
": "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"
} ]
</pre>

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:

...

Examples

...

XML

...

JSON

...

Example Response

...

Expand
titleXML
Panel

name

/name

sysId

/sysId

description

version

/version

vertexName

/vertexName

vertexId

/vertexId

...

Expand
titleJSON
Panel

name

sysId

description

version

vertexName

vertexId

...

Property

...

UI Field Name

...

Description

...

Task Description

...

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
name vertexName - LAWname
vertexName - LAW
name

Task Name

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.

...

Example Response

...

titleXML

...

titleJSON

...

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
titleXML
<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>
or
<generic-query-filter>
      <name>*</name>
      <workflowid>1463438057231012663TP5JP5EA8O1YS</workflowid>
</generic-query-filter>

...

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

 Or

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

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

Examples

XML

JSON

Example Request

Expand
titleXML
<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>
or
<generic-query-filter>
      <name>*</name>
      <workflowid>1463438057231012663TP5JP5EA8O1YS</workflowid>
</generic-query-filter>
Expand
titleJSON
All tasks in the last three minutes.
{
      "name": "*",
      "updatedTimeType": "offset",
      "updatedTime": "-3mn",
      "agentName": "SBUS30 - AGNT0005"
 }    

 Or

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

Example Response

Expand
titleXML
Panel
Html bobswift
<pre>
&lt;tasks&gt;
    &lt;task&gt;
        &lt;description&gt;description&lt;/description&gt;
        &lt;name&gt;test task 1&lt;/name&gt;
        &lt;sysID&gt;410d6c0bc0a801c901838d8ac43b3279&lt;/sysID&gt;
        &lt;type&gt;Windows&lt;/type&gt;
        &lt;version&gt;2&lt;/version&gt;
    &lt;/task&gt;
    &lt;task&gt;
        &lt;description&gt;description&lt;/description&gt;
        &lt;name&gt;test task 2&lt;/name&gt;
        &lt;sysID&gt;410d6880c0a801c90196685fcc1ecb47&lt;/sysID&gt;
        &lt;type&gt;Windows&lt;/type&gt;
        &lt;version&gt;9&lt;/version&gt;
    &lt;/task&gt;
&lt;/tasks&gt;
</pre>
Expand
titleJSON
Panel
Html bobswift
<pre>
[ {
  "description": "Description",
  "name": "test task 1",
  "sysId": "371be743130a4b18a9fc49961650593c",
  "type": "Timer",
  "version": 23
}, {
  "description": "Description",
  "name": "test task 2",
  "sysId": "10d58f96ab2b42e69d7e9bdde2ed21a7",
  "type": "Timer",
  "version": 2
} ]
</pre>

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

AgentAgent 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
name - LT
name - LT
name

Task Name

Name or partial name of one or more tasks.

Wildcards are supported.

N


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.

N


Anchor
updatedTime - LT
updatedTime - LT
updatedTime

n/a

If updatedTimeType = Offset; -offset period.

Valid values:

Html bobswift
<ul>
<li> mn (minutes)
<li> h (hours)
<li> d (days)
</ul>

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
titleNote

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

AgentAgent 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


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.

N


Anchor
updatedTime - LT
updatedTime - LT
updatedTime

n/a

If updatedTimeType = Offset; -offset period.

Valid values:

Html bobswift
<ul>
<li> mn (minutes)
<li> h (hours)
<li> d (days)
</ul>

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
titleNote

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

...