Versions Compared

Old Version 2

changes.mady.by.user IT Stonebranch

Saved on

compared with

New Version Current

changes.mady.by.user Stonebranch

Saved on

Key

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

...

Examples

XML

JSON

Example Request


Expand
titleXML
<task-insert>
    <name>Sleep 30</name>
    <alias>Test</alias>
    <workflowInstanceId>ac2cfdd14c8c4238a4a6ecd03db41e87</workflowInstanceId>
    <predecessors> 
        <predecessor>Sleep 30</predecessor>
    </predecessors>
    <successors> 
        <successor>Sleep 60</successor>
    </successors>
    <vertexX>25</vertexX>
    <inheritTriggerTime>true</inheritTriggerTime>
    <vertexY>25</vertexY>
</task-insert>



Expand
titleJSON
{
"name": "Sleep 10",
"alias": "Test",
"workflowInstanceId": "1513717759915306953T5FNZB71S6OUF",
"predecessors": [ "Task 1" ],
"successors": [ "Sleep 60" ],
"vertexX": "25",
"inheritTriggerTime": "true",
"vertexY": "25"
}


Example Response


Expand
titleXML


Panel


Html bobswift
<pre>
&lt;command-response&gt;
    &lt;type&gt;create_task&lt;/type&gt;
    &lt;success&gt;true&lt;/success&gt;
    &lt;info&gt;Command Insert Task executed successfully against task instance "test workflow".&lt;/info&gt;
    &lt;errors /&gt;
&lt;/command-response&gt;
</pre>





Expand
titleJSON


Panel


Html bobswift
<pre>
{
  "type": "create_task",
  "success": true,
  "info": "Command Insert Task executed successfully against task instance \"Test Workflow\".",
  "errors": ""
}
</pre>




...

<ul> <li>
  • Yes,Y,true
<li>
  • No,
  • N,
  • false
</ul>

Default is Yes, Y, true.

<ul> <li>
  • As
  • String
  • =
  • oldest
  • active
  • instance,
  • As
  • Value
  • =
  • 1
<li>
  • As
  • String
  • =
  • newest
  • active
  • instance,
  • As
  • Value
  • =
  • 2
<li>
  • As
  • String
  • =
  • oldest
  • instance,
  • As
  • Value
  • =
  • 3
<li>
  • As
  • String
  • =
  • newest
  • instance,
  • As
  • Value
  • =
  • 4
</ul>

Default is oldest active instance (1).
 

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

Anchor
alias - IT
alias - IT
alias

n/a

Alias used for the task within the Workflow; specifically, the value of ops_exec_workflow_vertex.name.


N


Anchor
id - IT
id - IT
id

n/a

sys_id of the task to be inserted.


Y
(unless name
is specified)

name

Anchor
name - IT
name - IT
name

Task Name

Name of the task to be inserted.


Y
(unless id
is specified)

id

Anchor
predecessors - IT
predecessors - IT
predecessors

Predecessors

Comma-separated list of predecessor task instances within the workflow for the task to be inserted.


N


Anchor
successors - IT
successors - IT
successors

Successors

Comma-separated list of successor task instances within the workflow for the task to be inserted.


N


Anchor
vertexX - IT
vertexX - IT
vertexX

n/a

x-coordinate of the task to be inserted within the workflow.

Default is 0.

N


Anchor
vertexY- IT
vertexY- IT
vertexY

n/a

y-coordinate of the task to be inserted within the workflow.

Default is 0.

N


Anchor
inheritTriggerTime - IT
inheritTriggerTime - IT
inheritTriggerTime

n/a

Specification for whether or not the inserted task will inherit the Trigger Time of the Workflow task instance.

Boolean; Valid values (not case-sensitive):

Html bobswift

N


Anchor
workflowInstanceCriteria- IT
workflowInstanceCriteria- IT
workflowInstanceCriteria

n/a

If search is by workflowInstanceName; Specific Workflow task instance with this task instance name which you want to insert the task into.

Valid values:

Html bobswift
Note
titleNote

Values with an underscore characters ( _ )
instead of spaces also are supported
(for example, oldest_active_instance).


N


Anchor
workflowInstanceId - IT
workflowInstanceId - IT
workflowInstanceId

n/a

sys_id of the Workflow to insert the task into.


Y
(unless workflowInstanceName
is specified)

workflowInstanceName

Anchor
workflowInstanceName - IT
workflowInstanceName - IT
workflowInstanceName

Instance Name

Name of the Workflow to insert the task into.


Y
(unless workflowInstanceId
is specified)

workflowInstanceId

...

XML

JSON


Expand
titleXML
<task-dependencies>
       <task-dependency>
              <condition>Success</condition>
              <name>Sleep 30</name>
              <satisfied>false</satisfied>
              <taskInstanceId>1471465078487058257PY97G57T09HKB</taskInstanceId>
              <type>predecessors</type>
              <vertexId>20</vertexId>
              <vertexName>Sleep 30</vertexName>
       </task-dependency>
       <task-dependency>
              <condition>Success</condition>
              <name>uc - Sleep 60</name>
              <satisfied>false</satisfied>
              <taskInstanceId>151371775991531795355TV2GX49AWD6</taskInstanceId>
              <type>successors</type>
              <vertexId>2</vertexId>
              <vertexName>Sleep 60</vertexName>
       </task-dependency>



Expand
titleJSON
[ {
  "condition": {
    "value": "Success"
  },
  "name": "Sleep 30",
  "satisfied": false,
  "taskInstanceId": "1471465078487058257PY97G57T09HKB",
  "type": "Predecessor",
  "vertexId": "20",
  "vertexName": "Sleep 30"
}, {
  "condition": {
    "value": "Success"
  },
  "name": "Sleep 60",
  "satisfied": false,
  "taskInstanceId": "151371775991531795355TV2GX49AWD6",
  "type": "Successor",
  "vertexId": "2",
  "vertexName": "Sleep 60"
} ]


...

<ul> <li>
  • As
  • String
  • =
  • oldest
  • active
  • instance,
  • As
  • Value
  • =
  • 1
<li>
  • As
  • String
  • =
  • newest
  • active
  • instance,
  • As
  • Value
  • =
  • 2
<li>
  • As
  • String
  • =
  • oldest
  • instance,
  • As
  • Value
  • =
  • 3
<li>
  • As
  • String
  • =
  • newest
  • instance,
  • As
  • Value
  • =
  • 4
</ul>

Default is oldest active instance (1).
 

Parameter

Description

Specifications

Required

Mutually Exclusive With

criteria

If taskinstancename is specified; Specific task instance with this task instance name for which you want to list predecessors and successors.

Valid values:

Html bobswift
Note
titleNote

Values with an underscore characters ( _ )
instead of spaces also are supported
(for example, oldest_active_instance).


N


dependencytype

Type of dependency to list for the task instance.

Valid values: predecessors, successors, * (all predecessors and successors).

N


taskinstanceid

sys_id of the task instance for which you want to list predecessors and successors.


Y
(unless taskinstancename
is specified)

taskinstancename

taskinstancename

Name of the task instance for which you want to list predecessors and successors.


Y
(unless taskinstanceid
is specified)

taskinstanceid

workflowinstancename

If taskinstancename is specified; Name of the Workflow task instance containing the task instance for which you want to list predecessors and successors.


N


...