String Optional. Complete model ID used for the process instances you want retrieved. You can retrieve model IDs by invoking the pub.monitor.process.instance:getProcessList service and using the value returned in the processNames/PROCESSKEY output parameter. When you specify modelID, do not use the modelNameInput parameter.

String List Optional. A set of complete model IDs used for the process instances you want retrieved. You can retrieve model IDs by invoking the pub.monitor.process.instance:getProcessList service and using the value returned in the processNames/PROCESSKEY output parameter. When you specify modelID, do not use the modelNameInput parameter.

String Optional. Complete or partial model name used for the process instances you want retrieved. You can retrieve model names by invoking the pub.monitor.process.instance:getProcessList service and using the value returned in the processNames/PROCESSKEYDECODE output parameter. When you specify modelNameInput, do not use the modelID parameter.

String Optional. Complete or partial instance ID for the process instances you want retrieved.

String Optional. The status of the process instances you want retrieved. The status you specify is matched against the most recently logged status. Use status if you want the list to contain all process instances of a single specified status. Specify the numerical value that represents the status. For a list of values you can specify, see Status Reference.

String List Optional. A set of statuses for the process instances you want retrieved. Use statusSet when you want the list to contain process instances of more than one specified status. For each status that you specify in statusSet, specify the numerical value that represents the status, as described above for the status parameter.

String Optional. Complete or partial instance ID for the parent process of the process instances that you want retrieved.

String Optional. The full, user-defined ID for the process instances that you want retrieved. User-defined IDs are assigned by executing the pub.prt.log:logCustomID service.

String Optional. A date range for the process instances you want retrieved. The date range identifies the date of the most recent log entry for the process instances. If you use this parameter, do not use the fromDate or toDate parameter.

String Optional. The start date of when data was logged for the process instances you want retrieved. The service retrieves process instances with entries logged on or after this date. Use the format YYYY-MM-DD HH:MM:SS. If you use this parameter, use toDate to specify the end date; do not use the dateCreated parameter when you use the fromDate and toDate parameters.

String Optional. The end date of when data was logged for the process instances you want retrieved. The service retrieves process instances with entries logged on or before this date. Use the format YYYY-MM-DD HH:MM:SS.

String Optional. The full ID of a step that was executed in the process instances you want retrieved. You can retrieve step IDs using the service. When you use this stepID parameter, you must also specify:

String Optional. To retrieve information about tasks, user on which to match (that is, user that performed a task). When you use this user parameter, you must also specify the modelID parameter.

String Optional. To retrieve information about tasks, role on which to match (that is, role that performed a task). When you use this role parameter, you must also specify the modelID parameter.

String Optional. Maximum number of process instances to return, starting with those most recently logged. By default, the service gets all process instances.

String Optional. Whether to use an AND or an OR condition for the criteria specified in the input parameters.

String Optional. How to sort the returned list of process instances. By default, the service sorts the returned data using AUDITTIMESTAMP. This parameter works with the sortAscending parameter.

String Optional. Whether to sort the returned list of process instances in ascending or descending order. The entries are sorted by the field identified by the sortColumn parameter.

String Optional. A filter that limits the returned instances based on pipeline values that are logged at run time. Define the pipeline variables to log when creating the process model and defining the step properties in Software AG Designer. For more information, see the Software AG Designer Online Help.

Use the following format to specify the filter: variable1=value1, value2, ... , valueN

For example, if a pipeline variable named city is logged and you want to return only those instances for which the value of the pipeline variable city is Paris, use the following filter: city=Paris

If you want to return instances for which city is Paris or Madrid, use the following filter: city=Paris, Madrid

To use multiple logged pipeline variables, specify and between the variables/values. For example, to return instances for which city is Paris and manager is Mercier, use the following filter: city=Paris and manager=Mercier

String Optional. A filter that limits the returned instances based on filter fields and values that are associated with the process model on which the instance is based. Assign filter fields and values to process models using the service.

Use the following format to specify the filter: field1=value1, value2, ... , valueN

For example, if you have set a filter field named countryCode and want to return only those instances that use models for which countryCode is es, use the following filter: countryCode=es

If you want to return instances that use models for which the countryCode is es or fr, use the following filter: countryCode=es, fr

To use multiple filter fields, specify and between the fields/values. For example, to return instances of models for which the countryCode is es or fr and the department is AP, use the following filter: countryCode=es, fr and department=AP

Boolean Optional. If is CustomIDExact is set to true, it matches the exact customID in the query; otherwise it uses the LIKE condition.

String Optional. Whether the service is to use the UPPER and LIKE conditions for the instanceID, parentInstanceID, and customID input parameters.

Document List List of process instances that match the specified criteria. For each process instance, the following fields are returned:

String Optional. Error that occurred during the execution of this service if this service encountered an error.