Previous Topic: getWorkflowTemplatesNext Topic: deleteWorkFlowTask


createWorkFlowTask

The following parameters apply to the createWorkFlowTask method:

Parameter

Type

Description

SID

Integer

Identifies the SID of the current login session.

attrVals

String[]

Identifies an array of name-value pairs that are used to set the initial attribute values for this workflow task. These optional attributes include:

  • Asset
  • Assignee
  • Estimated duration
  • Estimated cost
  • Estimated completion date

objectHandle

String

Identifies the object handle of a change order or issue for which this workflow task is created or attached.

creatorHandle

String

Identifies the object handle of the contact that created this workflow task.

selectedWorkFlow

String

Identifies the object handle of an existing workflow task after which the new workflow task is to be inserted.

taskType

String

Identifies the object handle of a workflow task template or the code of a task type.

attributes

String[]

Identifies the sequence of attribute names from the new object for which to return values. Dot-notation is permitted. If this field is empty, all attribute values are returned.

createWorkFlowTaskResult

String Holder

Identifies the String Holder object for capturing returned data.

newHandle

String Holder

Identifies the String Holder object for capturing returned data.

Description

Verifies the input value of selectedWorkFlow. If it is empty, the new workflow task is inserted at the bottom. Otherwise, the new workflow task is created after the selectedWorkFlow. The input value of taskType is also verified to determine whether to create a workflow based on a workflow template or on a task type code.

Returns

The new workflow task handle, with all of its attribute values. List and LREL types are also returned, but as empty elements.

XML Element

Type

Description

<createWorkFlowTaskResult>

N/A

Identifies the standard UDSObject element containing the handle and requested attribute values.

<newHandle>

String

Identifies the new workflow task handle.