Mediators (GET)

Retrieves the list of all supported mediators for sending notifications.

Roles

Users in the following roles are authorized to perform this operation:

worklightadmin
worklightdeployer
worklightmonitor
worklightoperator

Method

GET

Path

/management-apis/1.0/runtimes/runtime-name/notifications/mediators

Example

https://www.example.com/worklightadmin/management-apis/1.0/runtimes/myruntime/notifications/mediators?locale=de_DE

Path Parameters

runtime-name: The name of the runtime. This is the context root of the runtime web application, without the leading slash.

Query Parameters

Query parameters are optional.

locale: The locale used for error messages.

Produces

application/json, application/xml, text/xml

Response

The list of all supported mediators for sending notifications.

JSON Example

{
  "mediators" : [
    {
      "type" : "Google",
    },
    ...
  ],
  "productVersion" : "7.0.0",
}

XML Example

<?xml version="1.0" encoding="UTF-8"?>
<mediators productVersion="7.0.0">
  <mediators>
    <mediator type="Google"/>
    ...
  </mediators>
</mediators>

Response Properties

The response has the following properties:

mediators: The array of mediator metadata
productVersion: The exact product version.

The mediator has the following properties:

type: The type of the mediator.

Errors

403

The user is not authorized to call this service.

404

The corresponding runtime is not found or not running.

500

An internal error occurred.