Related Topics
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 of 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.
CreateForm
This method will create a new form instance and pass in initial form values.
Input Parameters
PID: The Partition ID or Name.
PathName: The full path of the form definition (e.g. /Forms/My Form) or a FORMID.
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.
Returns
FormInstance: The new form instance or null if an error prevents execution of the operation.
CreateFormEx
This method will create a new form instance and pass in initial form values. Unlike CreateForm, CreateFormEx allows you to pass in the name of the new form instance manually.
Input Parameters
PID: The Partition ID or Name.
PathName: The full path of the form definition (e.g. /Forms/My Form) or a FORMID.
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.
FormInstanceName: Optionally used to set new form instance name.
Returns
FormInstance: The new form instance or null if an error prevents execution of the operation.
CreateFormEx2
This method will create a new form instance and pass in initial form values, and will include both the Value and Display Text for dropdown fields. CreateFormEx2 has the same options as CreateFormEx, but instead of taking a List<NameValue> parameter to set the form field values, it takes a List<NameTextValue> parameter. The NameValue type only allows you to set a name, value, and number (which is simply a numerical representation of the field's value). The NameTextValue also allows you to set a Text property, which can be distinct from the Value property. This is particularly useful when setting dropdowns, where the text of a dropdown selection and its value are often different.
Input Parameters
PID: The Partition ID or Name.
PathName: The full path of the form definition (e.g. /Forms/My Form) or a FORMID.
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.
FormInstanceName: Optionally used to set new form instance name.
Returns
FormInstance: The new form instance or null if an error prevents execution of the operation.
CreateSimpleForm
This method will create a new form instance. Initial form values can be passed on the query string, which enables you to create a form and populate form fields. Form fields are identified using a URL parameter with the prefix "EXT_". For instance, a Field called "FirstName" on the Form can be populated via URL Parameter as "EXT_FirstName=Bob". This would result in the following URL:
http://servername.com/services/wsform.asmx/CreateSimpleForm?PID=ID&
PathName=Path&SkipDefaultValues=false&EXT_FirstName=Bob
Input Parameters
PID: The Partition ID or Name.
PathName: The full path of the form definition (e.g. /Forms/My Form) or a FORMID.
SkipDefaultValues: Set to true to skip merging default form values the first time the form is viewed.
EXT_SomeFieldName: A form field you wish to populate with a value when the Form is created.
Returns
FormInstance: The new form instance or null if an error prevents execution of the operation.
Instantiate
This method will instantiate a new form instance.
Input Parameters
FORMID: The ID of the Form to create.
SkipDefaultValues: Set to true to skip merging default form values the first time the form is viewed.
Returns
FormInstance: The new form instance or null if an error prevents execution of the operation.
SearchForms
This method will search form instances for values.
Input Parameters
PID: The Partition ID or Name.
FORMID: Optional FORM ID to limit search.
ControlName: The name of the form control to search.
Value: The value to search for.
Returns
SearchResult: An array of search results that match the search criteria. The array contains the following values for each form that is returned in the array.
- PID
- FORMID
- FORMINSTID
- FCID
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: The indication of success.
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.
