SOAP API - getDataViewCategories

The table summarizes the SOAP API - getDataViewCategories.

Request Uses the GetDataViewCategoriesRequest element (from the BusinessDataServices schema)
Parameter notes
  • 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.
Response Returns a GetDataViewCategoriesResponse element (from the BusinessDataServices schema)
Example Request: 
<soapenv:Body>
      <api:GetDataViewCategoriesRequest>
      	<category>
      		<childDepth>-1</childDepth>
      	</category>
      </api:GetDataViewCategoriesRequest>
   </soapenv:Body>
Response: 
<SOAP-ENV:Body>
      <GetDataViewCategoriesResponse xmlns="http://api.bds.tibco.com">
         <category xmlns="">UNCATEGORIZED</category>
         <category xmlns="">Marketing</category>
      </GetDataViewCategoriesResponse>
</SOAP-ENV:Body>