REST API - getDataViewCategories

The table summarizes the REST API - getDataViewCategories.

Request

Format 
POST <baseurl>/globaldata/dataviewcategory/get
Body categorySearchDetails. Contains the parameters in the CategorySearchDetails element (from the BusinessDataServices schema). See Defining Dataview Conditions.

Response

JSON Returns a JSON representation of the contents of a GetDataViewCategoriesResponseelement.
XML Returns the contents of a GetDataViewCategoriesResponseelement (from the BusinessDataServices schema)

Example

Request 
POST <baseurl>/globaldata/dataviewcategory/get
Body 
{
  "categorySearchDetails": {
    "category": { "childDepth": "2" }
  }
}
Response 
{
        "xml-fragment":
        {
            "category":
            [
                "Orders",
                "Orders/Pending orders",
                "Orders/Cancelled orders",
                "Orders/Current orders"
            ]
        }
    }