element queryProcessInstancesInput
diagram pm_xsd_diagrams/pm_xsd_p76.png
namespace http://www.tibco.com/bx/2009/management/processManagerType
properties
content complex
children pm:query pm:statusMode pm:pageSize pm:attributeMap
annotation
documentation
Request element for queryProcessInstances, queryProcessInstancesAlt, queryHaltedProcessInstances operations.

See also: listProcessInstanceAttributes operation.
source <xsd:element name="queryProcessInstancesInput">
 
<xsd:annotation>
   
<xsd:documentation>Request element for queryProcessInstances, queryProcessInstancesAlt, queryHaltedProcessInstances operations.

See also: listProcessInstanceAttributes operation.
</xsd:documentation>
 
</xsd:annotation>
 
<xsd:complexType>
   
<xsd:sequence>
     
<xsd:element name="query" type="xsd:string">
       
<xsd:annotation>
         
<xsd:documentation>Full (SQL syntax) query string. The "FROM process" clause should be included in the query.</xsd:documentation>
       
</xsd:annotation>
     
</xsd:element>
     
<xsd:element name="statusMode" type="pm:StateModeType" minOccurs="0">
       
<xsd:annotation>
         
<xsd:documentation>status Mode - ACTIVE only, COMPLETED only, or ACTIVE and COMPLETED</xsd:documentation>
       
</xsd:annotation>
     
</xsd:element>
     
<xsd:element name="pageSize" type="xsd:int">
       
<xsd:annotation>
         
<xsd:documentation>Page size to be used to return the list of process instances. One of the following values:

0:  Return the entire result set in a single, non-paged list.

-1:  Return the result set in a paged list, using the default page size.

positive integer: return the result set in a paged list, with the specified number of items on each page.
</xsd:documentation>
       
</xsd:annotation>
     
</xsd:element>
     
<xsd:element name="attributeMap" type="pm:TemplateAttributes">
       
<xsd:annotation>
         
<xsd:documentation>(Optional) Specification of the types of user-defined attributes to be included in the query.

Specifying this parameter will make the query more efficient.
</xsd:documentation>
       
</xsd:annotation>
     
</xsd:element>
   
</xsd:sequence>
 
</xsd:complexType>
</xsd:element>

element queryProcessInstancesInput/query
diagram pm_xsd_diagrams/pm_xsd_p77.png
namespace http://www.tibco.com/bx/2009/management/processManagerType
type xsd:string
properties
content simple
annotation
documentation
Full (SQL syntax) query string. The "FROM process" clause should be included in the query.
source <xsd:element name="query" type="xsd:string">
 
<xsd:annotation>
   
<xsd:documentation>Full (SQL syntax) query string. The "FROM process" clause should be included in the query.</xsd:documentation>
 
</xsd:annotation>
</xsd:element>

element queryProcessInstancesInput/statusMode
diagram pm_xsd_diagrams/pm_xsd_p78.png
namespace http://www.tibco.com/bx/2009/management/processManagerType
type pm:StateModeType
properties
minOcc 0
maxOcc 1
content simple
facets
Kind Value Annotation
enumeration TERMINATED
documentation
TERMINATED states
enumeration ACTIVE
documentation
ACTIVE states
enumeration ACTIVE_AND_TERMINATED
documentation
ACTIVE AND TERMINATED states
annotation
documentation
status Mode - ACTIVE only, COMPLETED only, or ACTIVE and COMPLETED
source <xsd:element name="statusMode" type="pm:StateModeType" minOccurs="0">
 
<xsd:annotation>
   
<xsd:documentation>status Mode - ACTIVE only, COMPLETED only, or ACTIVE and COMPLETED</xsd:documentation>
 
</xsd:annotation>
</xsd:element>

element queryProcessInstancesInput/pageSize
diagram pm_xsd_diagrams/pm_xsd_p79.png
namespace http://www.tibco.com/bx/2009/management/processManagerType
type xsd:int
properties
content simple
annotation
documentation
Page size to be used to return the list of process instances. One of the following values:

0:  Return the entire result set in a single, non-paged list.

-1:  Return the result set in a paged list, using the default page size.

positive integer: return the result set in a paged list, with the specified number of items on each page.
source <xsd:element name="pageSize" type="xsd:int">
 
<xsd:annotation>
   
<xsd:documentation>Page size to be used to return the list of process instances. One of the following values:

0:  Return the entire result set in a single, non-paged list.

-1:  Return the result set in a paged list, using the default page size.

positive integer: return the result set in a paged list, with the specified number of items on each page.
</xsd:documentation>
 
</xsd:annotation>
</xsd:element>

element queryProcessInstancesInput/attributeMap
diagram pm_xsd_diagrams/pm_xsd_p80.png
namespace http://www.tibco.com/bx/2009/management/processManagerType
type pm:TemplateAttributes
properties
content complex
children pm:templateAttribute
annotation
documentation
(Optional) Specification of the types of user-defined attributes to be included in the query.

Specifying this parameter will make the query more efficient.
source <xsd:element name="attributeMap" type="pm:TemplateAttributes">
 
<xsd:annotation>
   
<xsd:documentation>(Optional) Specification of the types of user-defined attributes to be included in the query.

Specifying this parameter will make the query more efficient.
</xsd:documentation>
 
</xsd:annotation>
</xsd:element>


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