SOAP API - getWorkListViewDetails

The table summarizes the SOAP API - getWorkListViewDetails.

Request Uses the getWorkListViewDetails element (from the WorkListService schema)
Parameter notes
  • workListViewID: the unique ID of the work view.
  • lockView (Optional): whether or not the work list view should be locked for editing. Set lockView as follows:
    • 0: the work view is not locked
    • 1: a lock record is placed against the view for the calling resource ID. The lock is removed when the view is updated or an explicit unlock is called.
  • apiVersion: the version of the work list view definition to be returned. Either:
    • 2, to return a work list view that includes the getAllocatedItems attribute and resourcesRequired parameter, or
    • 1, to return a work list view that omits the getAllocatedItems attribute and resourcesRequired parameter. (You should use this value to maintain compatibility with work list views created in pre-2.2 versions of BPM.) This is the default behavior if apiVersion is not specified.
Response Returns a getWorkListViewDetailsResponse element (from the WorkListService schema)
Example Request:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api="http://api.brm.n2.tibco.com">
   <soapenv:Header/>
   <soapenv:Body>
      <api:getWorkListViewDetails workListViewID="13" lockView="0"/>
   </soapenv:Body>
</soapenv:Envelope>
Response:
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
   <SOAP-ENV:Header/>
   <SOAP-ENV:Body>
      <getWorkListViewDetailsResponse creationDate="2012-08-15T09:29:03.470Z" description="" locker="" modificationDate="2012-08-15T09:29:03.470Z" name="test" owner="tibco-admin" public="false" workViewID="13" xmlns="http://api.brm.n2.tibco.com"/>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>