/services

Resource URI

/services

HTTP GET

Retrieves all available system services and the overall run state of the system services.

Valid "state" values:

STOPPED
STARTING
RUNNING
STOPPING
FAILED

Valid "mode" values:

native
msml

GET /services

Method

Response Payload

JSON

{
  "mode":"native",
  "state":"RUNNING",
  "restart_required":"no",
  "services" : [
    {
      "id" : "appmanager",
      "uri" : "\/services\/appmanager"
    },
    {
      "id" : "broker",
      "uri" : "\/services\/broker"
    },
    {
      "id" : "xmserver",
      "uri" : "\/services\/xmserver"
    },
    {
      "id" : "restapi",
      "uri" : "\/services\/restapi"
    },
    {
      "id" : "mediasubsystem",
      "uri" : "\/services\/mediasubsystem"
    }
  ]
}

Single Instance

Resource URI

/services/appmanger
/services/broker
/services/xmserver
/services/restapi
/services/msmlserver
/services/mediasubsystem

Retrieves information for a single service resource.

GET /services/broker

Method	Response Payload
JSON	{ "service" : { "id" : "appmanager", "state" : "RUNNING", "description" : "The appmanager process" } }

HTTP PUT

Modifies the system services overall run state and operation mode.

Valid "state" settings:

RUNNING
STOPPED

Valid "mode" settings:

native
msml

Note: The "restart_required" parameter is read-only and is an indication that any change requires a services restart.

Native Mode

PUT /services

Method	Request Payload	Response Payload
JSON	{ "mode" : "native", "state" : "STOPPED", }	{ "mode":"native", "state":"STOPPING", "restart_required":"no", "services" : [ { "id" : "appmanager", "uri" : "\/services\/appmanager" }, { "id" : "broker", "uri" : "\/services\/broker" }, { "id" : "xmserver", "uri" : "\/services\/xmserver" }, { "id" : "restapi", "uri" : "\/services\/restapi" }, { "id" : "mediasubsystem", "uri" : "\/services\/mediasubsystem" }, ] }

MSML Mode

PUT /services

Method	Request Payload	Response Payload
JSON	{ "mode" : "msml", "state" : "STOPPED", }	{ "mode":"msml", "state":"STOPPING", "restart_required":"no", "services" : [ { "id" : "msmlserver", "uri" : "\/services\/msmlserver" }, { "id" : "mediasubsystem", "uri" : "\/services\/mediasubsystem" }, ] }