Event Sources (GET)

Retrieves metadata for the list of event sources.

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/eventsources

Example

https://www.example.com/worklightadmin/management-apis/1.0/runtimes/myruntime/notifications/eventsources?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 metadata of the event sources.

JSON Example

{
  "eventsources" : [
    {
      "numberOfMessagesSent" : 1,
      "numberOfSubscribedUsers" : 1,
      "qname" : "myadapter.myeventsource",
    },
    ...
  ],
  "productVersion" : "7.1.0",
}

XML Example

<?xml version="1.0" encoding="UTF-8"?>
<eventsources productVersion="7.1.0">
  <eventsources>
    <eventsource
      numberOfMessagesSent="1"
      numberOfSubscribedUsers="1"
      qname="myadapter.myeventsource"/>
    ...
  </eventsources>
</eventsources>

Response Properties

The response has the following properties:

eventsources: The array of event source metadata
productVersion: The exact product version.

The eventsource has the following properties:

numberOfMessagesSent: Number of messages sent to this event source.
numberOfSubscribedUsers: Number of subscribed users of this event source.
qname: The name of the event source.

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.