Page Comparison

...

Examples

XML

JSON

Example Request

Expand

title	XML

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

Expand

title	JSON

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

Example Response

Expand

title	XML

<command-response>
    <type>create_task</type>
    <success>true</success>
    <info>Command Insert Task executed successfully against task instance "test workflow".</info>
    <errors />
</command-response>

Expand

title	JSON

{
  "type": "create_task",
  "success": true,
  "info": "Command Insert Task executed successfully against task instance \"Test Workflow\".",
  "errors": ""
}

...

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):

Yes,Y,true
No, N, false

Default is Yes, Y, true.

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:

As String = oldest active instance, As Value = 1
As String = newest active instance, As Value = 2
As String = oldest instance, As Value = 3
As String = newest instance, As Value = 4

Default is oldest active instance (1).

Note

title	Note

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

...

Versions Compared

Old Version 7

New Version 8

Key