SOAP API - getCaseClassInfo

The table summarizes the SOAP API - getCaseClassInfo.

Request Uses the GetCaseClassInfoRequest element (from the BusinessDataServicesAdminService schema)
Parameter Notes The request can specify the following:
  • name. The name of the application that generated the case model.
  • majorVersion. The major version number of the application.

    You can get this information by running getCaseModelBasicInfo.

or

  • caseModelID. The case model ID can be obtained by running getCaseModel or getCaseModelBasicInfo.
  • caseClass (optional). Whether you specify name and majorVersion or caseModelID, you can also specify caseClass. If you know the case class whose attributes you want to return, then you can specify the fully qualified name of the case class. For example, com.example.ordermodel.Customer. Leave this blank if you want all the case classes for case model to be returned. You can specify as many case classes as you want.

or

  • Neither the application name, nor case model ID. This results in all case classes on the system being returned.

Attributes

The following attributes can also be specified in the request:

  • includeLabels (optional) - Specify "true" to include labels in the response (default = "false").
  • includeAttributes (optional) - Specify "true" to include attribute details in the response (default = "true").
  • includeGlobalObjectAttributes (optional) - Specify "true" to include attributes of contained global objects, as well as the case object itself, in the response (default = "true"). This is ignored unless includeAttributes="true".
  • includeAppDetails (optional) - Specify "true" to include details of each CaseClassInfo in the response (default = "false"). This is typically only used when retrieving class information for multiple applications.
Response Returns a GetCaseClassInfoResponse element (from the BusinessDataServicesAdminService schema), which includes a caseClassInfo element for each case class in the case model. Each caseClassInfo element provides the details (name, label, attributes, and application details) for each case class as specified in the request.
Example Request: 
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api="http://api.bds.tibco.com">
   <soapenv:Header/>
   <soapenv:Body>
      <api:GetCaseClassInfoRequest includeLabels="true" includeAttributes="true" includeGlobalObjectAttributes="false" includeAppDetails="false">
         <appDetails>
            <name>com.example.ordermodel-1</name>
            <majorVersion>1</majorVersion>
         </appDetails>
      </api:GetCaseClassInfoRequest>
   </soapenv:Body>
</soapenv:Envelope>
Response: 
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
   <SOAP-ENV:Header/>
   <SOAP-ENV:Body>
      <GetCaseClassInfoResponse xmlns="http://api.bds.tibco.com">
         <caseClassInfo xmlns="">
            <name>com.example.ordermodel.Customer</name>
            <label>Customer</label>
            <attributeInfo>
               <path>id</path>
               <label>id</label>
               <type>ATTR_TEXT</type>
            </attributeInfo>
            <attributeInfo>
               <path>name</path>
               <label>name</label>
               <type>ATTR_TEXT</type>
            </attributeInfo>
         </caseClassInfo>
         <caseClassInfo xmlns="">
            <name>com.example.ordermodel.Employee</name>
            <label>Employee</label>
            <attributeInfo>
               <path>id</path>
               <label>id</label>
               <type>ATTR_TEXT</type>
            </attributeInfo>
            <attributeInfo>
               <path>name</path>
               <label>name</label>
               <type>ATTR_TEXT</type>
            </attributeInfo>
            <attributeInfo>
               <path>department</path>
               <label>department</label>
               <type>ATTR_TEXT</type>
            </attributeInfo>
         </caseClassInfo>
         <caseClassInfo xmlns="">
            <name>com.example.ordermodel.Luggage</name>
            <label>Luggage</label>
            <attributeInfo>
               <path>isCabinBag</path>
               <label>isCabinBag</label>
               <type>ATTR_TEXT</type>
            </attributeInfo>
            <attributeInfo>
               <path>description</path>
               <label>description</label>
               <type>ATTR_TEXT</type>
            </attributeInfo>
         </caseClassInfo>
         <caseClassInfo xmlns="">
            <name>com.example.ordermodel.Order</name>
            <label>Order</label>
            <attributeInfo>
               <path>orderId</path>
               <label>orderId</label>
               <type>ATTR_TEXT</type>
            </attributeInfo>
         </caseClassInfo>
         <caseClassInfo xmlns="">
            <name>com.example.ordermodel.Person</name>
            <label>Person</label>
            <attributeInfo>
               <path>id</path>
               <label>id</label>
               <type>ATTR_TEXT</type>
            </attributeInfo>
            <attributeInfo>
               <path>name</path>
               <label>name</label>
               <type>ATTR_TEXT</type>
            </attributeInfo>
         </caseClassInfo>
         <caseClassInfo xmlns="">
            <name>com.example.ordermodel.ProductLine</name>
            <label>ProductLine</label>
            <attributeInfo>
               <path>partNum</path>
               <label>partNum</label>
               <type>ATTR_TEXT</type>
            </attributeInfo>
         </caseClassInfo>
      </GetCaseClassInfoResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>