Related Topics
The following methods are available in the wsAdmin service. This service is available to users of Process Director v4.02 or higher.
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: The indication of success.
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.
CreateCase
This method will create a new case instance and pass in initial case property values.
Input Parameters
PID: The type of object to be returned.
PathName: The full path of the case definition or a CASEID.
CaseValues: The list of name/value pairs representing the case properties and their values to be set, passed as a List<NameValue> object.
Returns
The Case instance of the newly instantiated case, or null if there is an error.
CreateSimpleCase
This method will create a new case instance. Initial case property values can be passed in through the query string.
Input Parameters
PID: The type of object to be returned.
PathName: The full path of the case definition or a CASEID.
Returns
The Case instance of the newly instantiated case, or null if there is an error.
SetCaseData
This method will set the value of all specified properties in a case instance.
Input Parameters
CASEINSTID: The ID of the case instance.
CaseData: A list of the name/value pairs containing the names of the properties and their respective values, passed as a List<NameValue> object.
Returns
Boolean: True if the operation succeeds.
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.
