element previewWorkItemFromList
diagram brm_all_diagrams/brm_all_p183.png
namespace http://api.brm.n2.tibco.com
properties
content complex
children entityID workItemID requiredField requireWorkType
annotation
documentation
Request element for previewWorkItemFromList operation.
source <xs:element name="previewWorkItemFromList">
 
<xs:annotation>
   
<xs:documentation>Request element for previewWorkItemFromList operation.</xs:documentation>
 
</xs:annotation>
 
<xs:complexType>
   
<xs:sequence>
     
<xs:element name="entityID" type="orgdto:XmlModelEntityId">
       
<xs:annotation>
         
<xs:documentation>ID of the organization model entity for whom work items are to be previewed.</xs:documentation>
       
</xs:annotation>
     
</xs:element>
     
<xs:element name="workItemID" type="ObjectID" maxOccurs="unbounded">
       
<xs:annotation>
         
<xs:documentation>ID of a work item to be previewed.</xs:documentation>
       
</xs:annotation>
     
</xs:element>
     
<xs:element name="requiredField" type="xs:string" minOccurs="0" maxOccurs="unbounded">
       
<xs:annotation>
         
<xs:documentation>Fieldname to be included in the returned data. This defines the set of fields for which preview data is to be to be returned:

- If any fieldnames are specified, only those fields will be returned for each work item.

- If no fieldnames are specified, all fields will be returned for each work item.
</xs:documentation>
       
</xs:annotation>
     
</xs:element>
     
<xs:element name="requireWorkType" type="xs:boolean" minOccurs="0">
       
<xs:annotation>
         
<xs:documentation>Optiional element if set to true, then the response should include Work Type information.</xs:documentation>
       
</xs:annotation>
     
</xs:element>
   
</xs:sequence>
 
</xs:complexType>
</xs:element>

element previewWorkItemFromList/entityID
diagram brm_all_diagrams/brm_all_p184.png
type XmlModelEntityId
properties
content complex
children dynamic-id-attr qualifierSet
attributes
Name  Type  Use  Default  Fixed  Annotation
model-version  xs:int  optional  -1    
documentation
Major version number of the organization model in which an organization model entity resides.

If not specified, the default value will be the latest version of the organization model.

(Version numbers must be compatible with, and conform to, the OSGi version number schema. For Directory Engine, only the major part of the version number is significant.)
entity-type  OrganisationalEntityType  required      
documentation
Enumerated value defining the type of the organization model entity.
guid  xs:string  required      
documentation
Globally unique ID of the organization model entity.

(Although this value is unique across all entities, if the entity exists within more than one major version, it will share the same GUID.)
qualifier  xs:string  optional      
documentation
Only applicable in certain circumstances, and only to organization model entities whose entity-type is PRIVILEGE or CAPABILITY. These entities can have an association with other entities - for example, a resource may hold many capabilities, or a position may have many privileges.

These associations can have a qualifying value, according to their nature, to differentiate them. For example, the PRIVILEGE to sign off a purchase order may be qualified with the maximum amount that can be signed off.
annotation
documentation
ID of the organization model entity for whom work items are to be previewed.
source <xs:element name="entityID" type="orgdto:XmlModelEntityId">
 
<xs:annotation>
   
<xs:documentation>ID of the organization model entity for whom work items are to be previewed.</xs:documentation>
 
</xs:annotation>
</xs:element>

element previewWorkItemFromList/workItemID
diagram brm_all_diagrams/brm_all_p185.png
type ObjectID
properties
minOcc 1
maxOcc unbounded
content complex
attributes
Name  Type  Use  Default  Fixed  Annotation
id  xs:long  required      
documentation
Unique ID of the work item.
annotation
documentation
ID of a work item to be previewed.
source <xs:element name="workItemID" type="ObjectID" maxOccurs="unbounded">
 
<xs:annotation>
   
<xs:documentation>ID of a work item to be previewed.</xs:documentation>
 
</xs:annotation>
</xs:element>

element previewWorkItemFromList/requiredField
diagram brm_all_diagrams/brm_all_p186.png
type xs:string
properties
minOcc 0
maxOcc unbounded
content simple
annotation
documentation
Fieldname to be included in the returned data. This defines the set of fields for which preview data is to be to be returned:

- If any fieldnames are specified, only those fields will be returned for each work item.

- If no fieldnames are specified, all fields will be returned for each work item.
source <xs:element name="requiredField" type="xs:string" minOccurs="0" maxOccurs="unbounded">
 
<xs:annotation>
   
<xs:documentation>Fieldname to be included in the returned data. This defines the set of fields for which preview data is to be to be returned:

- If any fieldnames are specified, only those fields will be returned for each work item.

- If no fieldnames are specified, all fields will be returned for each work item.
</xs:documentation>
 
</xs:annotation>
</xs:element>

element previewWorkItemFromList/requireWorkType
diagram brm_all_diagrams/brm_all_p187.png
type xs:boolean
properties
minOcc 0
maxOcc 1
content simple
annotation
documentation
Optiional element if set to true, then the response should include Work Type information.
source <xs:element name="requireWorkType" type="xs:boolean" minOccurs="0">
 
<xs:annotation>
   
<xs:documentation>Optiional element if set to true, then the response should include Work Type information.</xs:documentation>
 
</xs:annotation>
</xs:element>


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