Integrating Service

HTTP Interface

Method URL Description
GET /mdworkbench/service Provides access to a list of available services

Request Header

  • Accept (optional): the media type which is acceptable for the response. Values can either be application/json (default) or application/xml.

Response Header

  • Content-Type: the media type of the response content. Values can either be application/json (default) or application/xml.

Response Body

JSON or XML content of services.
See the /mdworkbench/service/<id> method for details.
GET /mdworkbench/service/<id> Provides access to a specific service.

Request URL Path

  • <id>: must be a valid service identifier

Request Header

  • Accept (optional): the media type which is acceptable for the response. Values can either be application/json (default) or application/xml.

Response Header

  • Content-Type: the media type of the response content. Values can either be application/json (default) or application/xml.

Response Body

A JSON or XML node:
  • id: id of the service.
  • uri: uri of the service (i.e. the request uri).
  • name: display name of the service.
  • version: version of the service (part of the jar name in which the service is deployed).
  • description: description of the service.
  • launchFactory: uri on which a POST can invoked to launch the service.
  • rule: qualified name of the rule executed by the service.
  • parameters: array of nodes representing the service parameters. A parameter node might have properties (see below). Each parameter node has the following attributes:
    • name - the parameter name.
    • type - the parameter type.
  • properties: array of nodes representing the service properties. Each property node has the following attributes:
    • name - the property name.
    • value - the property value.

Related concepts
Service

Related tasks
Integrating Launch
Adding Services