Operation: bpm::captureGetList

General Description

Invoke this operation to get a list of Progressive Captures for a given application. This operation should not be invoked for non-administrative user of the system, instead use captureUserGetList.

Operation Notes

System Privileges Mail Privileges Calendar Privileges Database Privileges
sys.c.manageProgressiveCapture -- -- db.[default_db].h_bpm_procapture.browse

Request Message

Input Parameters

The captureGetList method takes the following input parameters. It is important to note that the parameters must be passed to the operation in the same order as they appear here in order to satisfy the requirement of the input validation checks.

Name Type Attributes Description
application appNameType optional Specify the name of the application this capture relates to. If not specified then "system" is assumed.
filter xs:string optional Filter List on the name of the capture.
includeDefinition boolean optional
If true the definition of each progressive captures is returned.
includeDraft boolean optional
If set to false then progressive captures with status Draft will be excluded from the results of this operation
orderBy orderByColumnType optional Specify a column to order by. If not specified then h_id column and ascending order is assumed.
pageInfo pageInfoType optional Controls the paging. If element is not specified, paging is disabled

Input Data

Response Message

Output Parameters

Name Type Attributes Description
captureItem captureItemListType required
The capture list for the specified application.
maxPages numberType optional A number indicating the maximum number of pages that could be returned.

Output Data

Code Generation & Samples

The links below will generate sample code in the respective languages. You can use these links as a convenient way of generating the correct code needed to invoke this method

JavaScript   PHP   C#   Java   C++   [ hide code ]  

Powered by Hornbill, for more information click here. (page served by , .)