Get BP List
Description
This method gets all the records for a specific Business Process in Unifier based on Integration design that has been defined in uDesigner. For more information, see uDesigner Overview.
Support
This process supports all type of BPs.
Installation
ASP and Self host
| Level | Yes or No |
|---|---|
| Company Level | Yes |
| Project/Shell Level | Yes |
Prototype
public XMLObject getBPList (String shortname, String authcode, string projectNumber, String BPName, String[] fieldnames, String filterCondition, String[] filterValues);
Parameters
| Parameter | Description |
|---|---|
| shortname | identifier of the company, company's short name |
| authcode | authentication key for the company, in text string |
| projectNumber | identifier of the project/shell |
| BPName | identifier of the business process, for example: Invoice |
| fieldnames | names of the elements in the BP that you want to retrieve; this is an optional parameter. If not specified, all elements will be returned. Currently this parameter is not supported through Web services. |
| filterCondition | a list of supported condition, this is an optional parameter. If not specified, no conditions will be applied. Field names that you enter as filterCondition should match with the elements that you have selected while designing Integration Interface in uDesigner. |
| filterValues | a list of values depending on the filter conditions. Currently this parameter is not supported through Web services. |
fieldnames
Values that you are going to send through fieldnames parameter are dependent on your BP design. Only those filed can send through fieldnames that are part of your BP design. You can send a name from line item list.
Return Value
Sample Method
getBPList("acme", "acme_authcode", "proj-01", "Invoice",null,null,null) will return the XML List of all the Records of the BP Invoice.
<gen:getBPList>
<!--Optional:-->
<gen:shortname>4C</gen:shortname>
<!--Optional:-->
<gen:authcode>123</gen:authcode>
<!--Optional:-->
<gen:projectNumber></gen:projectNumber>
<!--Optional:-->
<gen:BPName>Vendors</gen:BPName>
<!--Zero or more repetitions:-->
<gen:fieldnames></gen:fieldnames>
<!--Optional:-->
<gen:filterCondition></gen:filterCondition>
<!--Zero or more repetitions:-->
<gen:filtervalues>showlineitems=yes</gen:filtervalues>
Or:
<gen:filtervalues>showlineitems=no
</gen:filtervalues> for only Upper form details.
</gen:getBPList>