Related Topics
AddToTimeline
This method will add an object to a timeline instance.
Input Parameters
TLINSTID: The ID of the Timeline 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
TimelineInstance: The timeline instance in which the call ran (or null if an error occurred).
Authenticate
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.
AuthenticateJSON
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.
GetActivityByACTID
This method will return a Timeline Activity for a specific Timeline instance.
Input Parameters
TLINSTID: The Timeline Instance ID.
ACTID: The Timeline Activity ID to retrieve.
Returns
TimelineActivity: The parent Timeline Activity for the timeline instance passed to the service (or null if an error occurred).
GetActivityByName
This method will return a Timeline Activity for a specific Timeline instance.
Input Parameters
TLINSTID: The Timeline Instance ID.
ActName: The Timeline Activity name to retrieve.
Returns
TimelineActivity: The parent Timeline Activity for the timeline instance passed to the service (or null if an error occurred).
Restart
This method will restart an existing Timeline instance TLINSTID at an optional activity ACTID.
Input Parameters
TLINSTID: The ID of the Timeline Instance to restart.
ACTID: The ACTIVITY ID of the ACTIVITY in the Timeline definition to restart (optional).
Returns
TimelineInstance: The Timeline instance which the call restarted (or null if an error occurred).
RunTimeline
This method will create and run a new Timeline instance and optionally add a Timeline object.
Input Parameters
PID: The Partition ID or Name.
PathName: The full path of the Timeline definition (e.g. /Process/My Timeline).
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.
InitiatorUID: The optional UID of the Timeline initiator.
Returns
TimelineInstance: The Timeline instance which was created (or null if an error occurred).
RunTimelineWithForm
This method will create a new form instance, a new Timeline instance and attach the form.
Input Parameters
PID: The Partition ID or Name.
TimelinePathName: The full path of the Timeline definition (e.g. /Process/My Timeline).
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 Timeline initiator.
Returns
TimelineInstance: The Timeline instance which was created (or null if an error occurred).
SetContextUID
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.
Documentation Feedback and Questions
If you notice some way that this document can be improved, we're happy to hear your suggestions. Similarly, if you can't find an answer you're looking for, ask it via feedback. Simply click on the button below to provide us with your feedback or ask a question. Please remember, though, that not every issue can be addressed through documentation. So, if you have a specific technical issue with Process Director, please open a support ticket.
