REST API - listCategories

The table summarizes the REST API - listCategories.

Request

Format 
GET <baseurl>/businessservice/categories/list
Query parameters
  • channelid=string (optional): ID of a specific channel for which categories should be listed.
  • start=long (optional, default = 0): Position in the list from which to start this page.
  • total=long (optional, default = 100): Number of items (in the list) to include in this page.
  • gettotal=boolean (optional, default = true): Whether to build a count of the total number of items in the list. If gettotal is set to false, total is set to -1.
  • includeparam=boolean (optional, default = true): Whether the response should include business services that have formal parameters.

Response

JSON Returns a JSON representation of the contents of a listCategoriesResponse element.
XML Returns the contents of a listCategoriesResponse element (from the BusinessService schema)

Example

Request 
GET <baseurl>/businessservice/categories/list
Response 
{
    "xml-fragment": {
        "startPosition": 0,
        "endPosition": 2,
        "totalItems": 2,
        "Category": [
            {
                "@name": "WelcomeUsersImplementSolution",
                "ChildCategory": {
                    "@name": "ProcessPackage"
                }
            },
            {
                "@name": "RestSample3",
                "ChildCategory": {
                    "@name": "Sample3"
                }
            }
        ]
    }
}