SOAP API - getDataViewDetails

The table summarizes the SOAP API - getDataViewDetails.

Request Uses the GetDataViewDetailsRequest element (from the BusinessDataServices schema)
Parameter notes
  • viewID. The unique identifier of the dataview.
  • viewName. The unique name of the dataview. If you do not know the dataview name, you can use wild cards to search for it. See Using Wildcards to Search for Dataviews .
  • appDetails (optional). The details of the application.
    • name. The name of the deployed application in TIBCO ActiveMatrix BPM. For example, com.example.gddemo-2.
    • majorVersion. The current version number of the deployed application.
  • caseClassDetails (optional).
    • 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.
  • category (optional) Specifies the category. See Dataview Categories .
    • name. Slash-separated path to the category in the hierarchy. Leave this blank to return all top-level categories.
    • childDepth. Number of levels of child categories beneath the matching categories. -1 is unlimited depth. Leave blank to return no children.
    • childrenOnly (optional): Use with childDepth. If this is set to true, the category is omitted and only the child categories are retrieved.
  • viewDetailsRequirement (optional). Select this if you only want the response to return the name or name and description of the dataview and nothing else. If this is omitted, then all the details of the dataview are returned. Specify either:
    • NAME to display the name of the dataview.
    • NAME_AND_DESCRIPTON to display the name and description of the dataview.
  • includeAppDetails (optional). If this is specified as true, the application details (in other words, the application name and its major version) are returned in each response.
Response Returns a GetDataViewDetailsResponse element (from the BusinessDataServices schema)
Example Request: 
<soapenv:Body>

      <api:GetDataViewDetailsRequest>

         <viewName>Car pool</viewName>

      </api:GetDataViewDetailsRequest>

</soapenv:Body>
Response: 
<SOAP-ENV:Body>

      <GetDataViewDetailsResponse xmlns="http://api.bds.tibco.com">

         <result xmlns="">

            <viewID>4</viewID>

            <specification>

               <caseClassDetails>

                  <caseClass>com.example.gddemo.Car</caseClass>

                  <majorVersion>2</majorVersion>

               </caseClassDetails>

               <name>Car pool</name>

               <description>List of cars in the car pool</description>

            </specification>

         </result>

      </GetDataViewDetailsResponse>

</SOAP-ENV:Body>
Contents
Search Results