complexType GetCaseClassInfoRequestType

diagram |
namespace | http://api.bds.tibco.com
children | appDetails caseModelID caseClass
used by |
element | GetCaseClassInfoRequest
attributes |
Name | Type | Use | Default | Fixed | Annotation
includeLabels | xs:boolean |  | false |  |
documentation
Set true to include labels as well as names in the response (default: false)
includeAttributes | xs:boolean |  | true |  |
documentation
Set true to include attribute details (rather than just classes) in the response (default: true)
includeGlobalObjectAttributes | xs:boolean |  | true |  |
documentation
Set true to include attributes of contained global objects, as well as the case object itself (default: true). Ignored unless includeAttributes=true.
includeAppDetails | xs:boolean |  | false |  |
documentation
Set true to include app details with each CaseClassInfo in the response. Generally set only when retrieving info for multiple apps. (default: false)
annotation |
documentation
Details required to retrieve information about Case Classes
source | <xs:complexType name="GetCaseClassInfoRequestType"> <xs:annotation> <xs:documentation>Details required to retrieve information about Case Classes</xs:documentation> </xs:annotation> <xs:sequence> <xs:choice minOccurs="0"> <xs:annotation> <xs:documentation>Identify application either by name/version combo or case model ID. If omitted, information for all apps is returned.</xs:documentation> </xs:annotation> <xs:element name="appDetails" type="AppDetails"/> <xs:element name="caseModelID" type="xs:long"/> </xs:choice> <xs:element name="caseClass" type="xs:string" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>If app details are provided, then caseClass can be set to one or more case class names to get info for specific class(es) rather than all for the app. Note: This is ignored if no app details are provided.</xs:documentation> </xs:annotation> </xs:element> </xs:sequence> <xs:attribute name="includeLabels" type="xs:boolean" default="false"> <xs:annotation> <xs:documentation>Set true to include labels as well as names in the response (default: false)</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="includeAttributes" type="xs:boolean" default="true"> <xs:annotation> <xs:documentation>Set true to include attribute details (rather than just classes) in the response (default: true)</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="includeGlobalObjectAttributes" type="xs:boolean" default="true"> <xs:annotation> <xs:documentation>Set true to include attributes of contained global objects, as well as the case object itself (default: true). Ignored unless includeAttributes=true.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="includeAppDetails" type="xs:boolean" default="false"> <xs:annotation> <xs:documentation>Set true to include app details with each CaseClassInfo in the response. Generally set only when retrieving info for multiple apps. (default: false)</xs:documentation> </xs:annotation> </xs:attribute> </xs:complexType>

attribute GetCaseClassInfoRequestType/@includeLabels

type | xs:boolean
properties |
default | false
annotation |
documentation
Set true to include labels as well as names in the response (default: false)
source | <xs:attribute name="includeLabels" type="xs:boolean" default="false"> <xs:annotation> <xs:documentation>Set true to include labels as well as names in the response (default: false)</xs:documentation> </xs:annotation> </xs:attribute>

attribute GetCaseClassInfoRequestType/@includeAttributes

type | xs:boolean
properties |
default | true
annotation |
documentation
Set true to include attribute details (rather than just classes) in the response (default: true)
source | <xs:attribute name="includeAttributes" type="xs:boolean" default="true"> <xs:annotation> <xs:documentation>Set true to include attribute details (rather than just classes) in the response (default: true)</xs:documentation> </xs:annotation> </xs:attribute>

attribute GetCaseClassInfoRequestType/@includeGlobalObjectAttributes

type | xs:boolean
properties |
default | true
annotation |
documentation
Set true to include attributes of contained global objects, as well as the case object itself (default: true). Ignored unless includeAttributes=true.
source | <xs:attribute name="includeGlobalObjectAttributes" type="xs:boolean" default="true"> <xs:annotation> <xs:documentation>Set true to include attributes of contained global objects, as well as the case object itself (default: true). Ignored unless includeAttributes=true.</xs:documentation> </xs:annotation> </xs:attribute>

attribute GetCaseClassInfoRequestType/@includeAppDetails

type | xs:boolean
properties |
default | false
annotation |
documentation
Set true to include app details with each CaseClassInfo in the response. Generally set only when retrieving info for multiple apps. (default: false)
source | <xs:attribute name="includeAppDetails" type="xs:boolean" default="false"> <xs:annotation> <xs:documentation>Set true to include app details with each CaseClassInfo in the response. Generally set only when retrieving info for multiple apps. (default: false)</xs:documentation> </xs:annotation> </xs:attribute>

element GetCaseClassInfoRequestType/appDetails

diagram |
type | AppDetails
properties |
content | complex
children | name majorVersion
source | <xs:element name="appDetails" type="AppDetails"/>

element GetCaseClassInfoRequestType/caseModelID

diagram |
type | xs:long
properties |
content | simple
source | <xs:element name="caseModelID" type="xs:long"/>

element GetCaseClassInfoRequestType/caseClass

diagram |
type | xs:string
properties |
minOcc | 0
maxOcc | unbounded
content | simple
annotation |
documentation
If app details are provided, then caseClass can be set to one or more case class names to get info for specific class(es) rather than all for the app. Note: This is ignored if no app details are provided.
source | <xs:element name="caseClass" type="xs:string" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>If app details are provided, then caseClass can be set to one or more case class names to get info for specific class(es) rather than all for the app. Note: This is ignored if no app details are provided.</xs:documentation> </xs:annotation> </xs:element>

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