element getWorkListViewDetails
diagram wp_diagrams/wp_p367.png
namespace http://api.brm.n2.tibco.com
properties
content complex
attributes
Name  Type  Use  Default  Fixed  Annotation
workListViewID  xs:long  required      
documentation
The unique ID of the work list view to delete.
lockView  xs:boolean        
documentation
Should this work list view be locked for editing?  A lock record will be placed against this view for the calling resource ID.   This lock is only removed when the view is updated or an explicit unlock is called.
apiVersion  xs:int        
documentation
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 behaviour if apiVersion is not specified.
annotation
documentation
Request element for the getWorkViewListDetails operation.
source <xs:element name="getWorkListViewDetails">
 
<xs:annotation>
   
<xs:documentation>Request element for the getWorkViewListDetails operation.</xs:documentation>
 
</xs:annotation>
 
<xs:complexType>
   
<xs:attribute name="workListViewID" type="xs:long" use="required">
     
<xs:annotation>
       
<xs:documentation>The unique ID of the work list view to delete.</xs:documentation>
     
</xs:annotation>
   
</xs:attribute>
   
<xs:attribute name="lockView" type="xs:boolean">
     
<xs:annotation>
       
<xs:documentation>Should this work list view be locked for editing?  A lock record will be placed against this view for the calling resource ID.   This lock is only removed when the view is updated or an explicit unlock is called.</xs:documentation>
     
</xs:annotation>
   
</xs:attribute>
   
<xs:attribute name="apiVersion" type="xs:int">
     
<xs:annotation>
       
<xs:documentation>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 behaviour if apiVersion is not specified.
</xs:documentation>
     
</xs:annotation>
   
</xs:attribute>
 
</xs:complexType>
</xs:element>

attribute getWorkListViewDetails/@workListViewID
type xs:long
properties
use required
annotation
documentation
The unique ID of the work list view to delete.
source <xs:attribute name="workListViewID" type="xs:long" use="required">
 
<xs:annotation>
   
<xs:documentation>The unique ID of the work list view to delete.</xs:documentation>
 
</xs:annotation>
</xs:attribute>

attribute getWorkListViewDetails/@lockView
type xs:boolean
annotation
documentation
Should this work list view be locked for editing?  A lock record will be placed against this view for the calling resource ID.   This lock is only removed when the view is updated or an explicit unlock is called.
source <xs:attribute name="lockView" type="xs:boolean">
 
<xs:annotation>
   
<xs:documentation>Should this work list view be locked for editing?  A lock record will be placed against this view for the calling resource ID.   This lock is only removed when the view is updated or an explicit unlock is called.</xs:documentation>
 
</xs:annotation>
</xs:attribute>

attribute getWorkListViewDetails/@apiVersion
type xs:int
annotation
documentation
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 behaviour if apiVersion is not specified.
source <xs:attribute name="apiVersion" type="xs:int">
 
<xs:annotation>
   
<xs:documentation>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 behaviour if apiVersion is not specified.
</xs:documentation>
 
</xs:annotation>
</xs:attribute>


XML Schema documentation generated by XMLSpy Schema Editor http://www.altova.com/xmlspy