REST API - getBusinessServiceDetailsByModule

The table summarizes the REST API - getBusinessServiceDetailsByModule.

Request

Format
GET <baseurl>/businessservice/details/<module>/<process>
Path parameters
  • module: module name of the business service whose details are being requested.
  • process: the business service process name whose details are being requested.
Query parameters
  • version=string (optional, default = latest version): Version number of the business service whose details are being requested.
  • channelid=string (optional, default=openspaceGWTPull_DefaultChannel): Identifier of the channel to which the requesting client application is bound.
  • channeltype=string (optional, default=openspaceChannel): Enumerated value defining the channel type (technology) associated with the specified channelid. For a list of available enumerations, see channeltype enumerations.

    See Identifying the Client Channel in a Service Call for more information.

Response

JSON Returns a JSON representation of the contents of a businessServiceDetailsResponse element.
XML Returns a businessServiceDetailsResponse element (from the WorkPresentationServices schema)

Example

Request
GET <baseurl>/businessservice/details/%2FSimplestProc%2FProcessPackages%2FSimplestProc.xpdl/SimplestProcCatchMessageEvent
Response
{

    "xml-fragment": {

        "@moduleName": "/SimplestProc/ProcessPackages/SimplestProc.xpdl",

        "@moduleVersion": "1.0.0.201301301211",

        "@name": "SimplestProcCatchMessageEvent",

        "@id": "_W9JBQGCxEeKQSvLdcLuD4A",

        "@url": "SimplestProc/.bpm/.processOut/pageflow/SimplestProc.xpdl/SimplestProcCatchMessageEvent.bpel",

        "page-activity": {

            "@id": "_XMHRY2CxEeKQSvLdcLuD4A",

            "@name": "UserTask",

            "page-reference": {

                "@guid": "",

                "@name": "UserTask.gwt.json",

                "@version": "1.0.0.201301301211",

                "relative-path": "1.0.0.201301301211/GIGWTPull_DefaultChannel/.default/SimplestProc/SimplestProcCatchMessageEvent/UserTask",

                "base-path": "http://localhost:8080/bpm"

            }

        }

    }

}