REST API - queryBusinessServices

The table summarizes the REST API - queryBusinessServices.

Request

Format 
GET <baseurl>/businessservice/query/<category>
Path parameters category: The category name to use for this query.
Query parameters
  • channelid=string (optional): ID of a specific channel for which business services should be listed.
  • includeparam=boolean (optional, default = true): Whether the query should return business services that have formal parameters.

    Note: If you are using wildcards to specify the filter based on category or channelid, the wildcard character ’*’ cannot be the only or last character in the search string. For example, to search for all categories, specify the search string as **. To search for all categories under Category1, specify the search string as Category1/**.

Response

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

Example

Request 
GET <baseurl>/businessservice/query/RestSample3%2F**
Response 
{
    "businessServiceTemplate": {
        "@moduleName": "/RestSample1/ProcessPackages/RestSample1.xpdl",
        "@version": "1.0.0.201301031722",
        "@processName": "StartClaimProcess",
        "@hasFormalParameters": "false"
    }
}