This method will add an object to a Workflow instance.

Input Parameters

WFINSTID: The ID of the Workflow Instance.

ID: The ID of the object to add.

Type: ObjectType - The type of object to add.

Group: The optional group name to add the object into.

Returns

WorkflowInstance: The Workflow instance which the call ran (or null if an error occurred).

This method will add user(s) to a specific step instance.

Input Parameters

STINSTID: The Workflow Step Instance ID.

UID: Comma separated list of UIDs to add.

Returns

Boolean: True if the operation succeeds.

This method will authenticate web service requests. Call this method prior to other web service calls. It will automatically populate the SOAP header with a validation token that enables subsequent web service calls.

Input Parameters

User: The built-in or Windows UserID to use for the context of all calls.

Password: The password for this UserID.

Returns

Boolean: True if the operation succeeds.

This method will authenticate web service requests. Call this method prior to other web service calls. The return is a JSON string with the session ID.

Input parameters

User: The built-in or Windows UserID to use for the context of all calls.

Password: The password for this UserID.

Returns

JSON: The Session ID.

This method will cancel a running Workflow instance.

Input Parameters

WFINSTID: The ID of the Workflow Instance

Returns

WorkflowInstance: The actual Workflow instance that was canceled, or Null if not found.

This method will get a Workflow definition from its WFID.

Input Parameters

WFID: The ID of the Workflow Definition

Returns

WorkflowDefinition: The actual Workflow definition, or null if not found.

This method will get a Workflow instance from its WFINSTID.

Input Parameters

WFINSTID: The ID of the Workflow Instance.

Returns

WorkflowInstance: The actual Workflow instance, or null if not found.

This method will return a Workflow Step for a specific Workflow instance.

Input Parameters

WFINSTID: The Workflow Instance ID.

StepName: The Workflow Step name to retrieve.

Returns

WorkflowStep:  The Workflow Step, or null if an error occurred.

This method will return a Workflow Step for a specific Workflow instance.

Input Parameters

WFINSTID: The Workflow Instance ID.

STID: The Workflow Step ID to retrieve.

Returns

WorkflowStep: The Workflow Step, or null if not found.

This method will instantiate a Workflow Instance from a WFID.

Input Parameters

WFID: The ID of the Workflow Definition to instantiate.

InitiatorUID: The optional UID of the Workflow initiator.

Returns

WorkflowInstance: The Workflow instance which the call instantiated, or null if an error occurred.

This method will post an event to a Workflow that is waiting on a Wait step.

Input Parameters

WFINSTID: The optional ID of the Workflow Instance to POST.

EventName: The optional Event Name to post.

Returns

Boolean: True if the operation succeeds.

This method will remove user(s) from a specific step instance.

Input Parameters

STINSTID: The Workflow Step Instance ID.

UID: Comma separated list of UIDs to add.

Returns

Boolean: True if the operation succeeds.

This method will restart an existing Workflow instance WFINSTID at an optional step STID.

Input Parameters

WFINSTID: The ID of the Workflow Instance to restart.

STID: The STEP ID of the STEP in the Workflow definition to restart (optional).

Returns

WorkflowInstance: The Workflow instance which the call restarted, or null if an error prevents execution of the operation.

This method will instantiate and run a Workflow Instance from a WFID.

Input Parameters

WFID: The ID of the Workflow Definition to run.

Returns

WorkflowInstance: The Workflow instance which the call ran , or null if an error prevents execution of the operation.

This method will create and run a new Workflow instance and optionally add a Workflow object.

Input Parameters

PID: The Partition ID or Name.

PathName: The full path of the Workflow definition (e.g. /Workflows/My Workflow).

ID: The ID of the object to add.

Type: ObjectType - Place "NotSet" in this field.

Group: The optional group name to add the object into.

InitiatorUID: The optional UID of the Workflow initiator.

Returns

WorkflowInstance: The Workflow instance which was created , or null if an error prevents execution of the operation.

This method will create a new form instance, a new Workflow instance and attach the form.

Input Parameters

PID: The Partition ID or Name.

WorkflowPathName: The full path of the Workflow definition (e.g. /Workflows/My Workflow).

FormPathName: The full path of the form definition (e.g. /Forms/My Form).

FormValues: The list of name/value pairs to set in the new form instance.

SkipDefaultValues: Set to true to skip merging default form values the first time the form is viewed.

Group: The optional group name to add the object into.

InitiatorUID: The optional UID of the Workflow initiator.

Returns

WorkflowInstance: The Workflow instance which was created , or null if an error prevents execution of the operation.

This method will set the context UID for all future web service calls. For instance, this UID will be used as the current user for running Knowledge Views, permission checking, etc.

Input Parameters

UID: The ID of the user to use for the context of all calls.

Returns

Boolean: True if the operation succeeds.

This method will set a Due Date for a specific step instance.

Input Parameters

STINSTID: The Workflow Step Instance ID.

dateDue: The Date/Time value to represent the Step's due Date.

Returns

Boolean: True if the operation succeeds.

This method will start an instantiated Workflow Instance.

Input Parameters

WFINSTID: The ID of the Workflow Instance to start.

Returns

WorkflowInstance: The actual Workflow Instance.