SOAP API - createDataView

The table summarizes the SOAP API createDataView.

Request Uses the CreateDataViewRequest element (from the BusinessDataServices schema)
Parameter notes
  • caseClass: The fully qualified name of the case class. For example, com.example.gddemo.Car. You can obtain class names by using getCaseClassInfo.
  • caseModelVersion: The version of the case model. For example, 2 or 2.0.0.
  • name. The name of your dataview. This must be unique.
  • description (optional): A description of your dataview.
  • condition. See Defining Dataview Conditions.
  • sortAttribute (optional). Specifies the sort order of the attribute.
    • attrPath. Specifies the attribute to sort.
    • order. Specifies the sort order, either ASC for ascending or DESC for descending.
  • category (optional). Specifies the category. See Dataview Categories.
Response Returns a CreateDataViewResponse element (from the BusinessDataServices schema)
Example Request: 
<soapenv:Body>
      <api:CreateDataViewRequest>
         <viewSpecification>
            <caseClassDetails>
               <caseClass>com.example.gddemo.Car</caseClass>
               <majorVersion>2</majorVersion>
            </caseClassDetails>
            <name>Luxury cars</name>
            <description>Cars with luxury features</description>
         </viewSpecification>
      </api:CreateDataViewRequest>
</soapenv:Body>
Response: 
<SOAP-ENV:Body>
<CreateDataViewResponse xmlns="http://api.bds.tibco.com">
<viewID xmlns="">2</viewID>
</CreateDataViewResponse>
</SOAP-ENV:Body>