REST API - listBusinessServices

The table summarizes the REST API - listBusinessServices.

Request

Request 
GET <baseurl>/businessservice/list
Query parameters
  • channelid=string (optional): ID of a specific channel for which business services 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 listBusinessServicesResponse element.
XML Returns the contents of a listBusinessServicesResponse element (from the BusinessService schema)

Example

Request 
GET <baseurl>/businessservice/list
Response 
{
    "xml-fragment": {
        "startPosition": 0,
        "endPosition": 2,
        "totalItems": 2,
        "businessCategory": [
            {
                "@name": "WelcomeUsersImplementSolution",
                "ChildBusinessCategory": {
                    "@name": "ProcessPackage",
                    "BusinessServiceTemplate": {
                        "@moduleName": "/WelcomeUsersImplementSolution/Process Packages/ProcessPackage.xpdl",
                        "@version": "1.0.0.201301021250",
                        "@processName": "RequestCall",
                        "@hasFormalParameters": "false"
                    }
                }
            },
            {
                "@name": "RestSample3",
                "ChildBusinessCategory": {
                    "@name": "Sample3",
                    "BusinessServiceTemplate": {
                        "@moduleName": "/RestSample1/ProcessPackages/RestSample1.xpdl",
                        "@version": "1.0.0.201301031722",
                        "@processName": "StartClaimProcess",
                        "@hasFormalParameters": "false"
                    }
                }
            }
        ]
    }
}