NSP External Notification Application REST API - v3

This API describes the REST interface to interact with the NSP External Notification Application

More information:
Customer documentation
https://infoproducts.alcatel-lucent.com/cgi-bin/doc_welc.pl
Technical support
http://support.alcatel-lucent.com
Documentation feedback
documentation.feedback@nokia.com
BasePath:/ean

Access

Methods

[ Jump to Models ]

Table of Contents

  1. get /api/v3/notifications/subscriber
Up
get /api/v3/notifications/subscriber
Subscription for notifications (subscribe)
The method allows clients (consumers) to subscribe to state change events (AdminState and OperState). <br>Once connected, the consumers will be'pushed' events using the W3C Server-Sent Events mechanism ('text/event-stream'). <br>The format of the response is JSON and the schema is derived from the YANG-defined model. <br>Notifications' interface behavior: <br>- Clients are responsible for managing the connection. If the connection is lost, the clients have to reconnect. <br>- Clients MUST call explicitly terminate the connection once they are no longer interested in receiving notifications. Failure in doing so will result in connection being 'leaked', thus reducing the number of available connections. <br>- Subscription are not persisted (durable). <br>- Notifications are not persisted. <br>- Disconnected clients will miss notifications sent while they where disconnected. <br>- Subscribers MUST not perform long operations in the thread they are receiving the notifications. <br>- There is a maximum, reconfigurable, number of subscribers. The default value is 10. The configuration parameter is <i>'ean.maxSubscribers'</i>. <br>- Clients attempting to subscribe for events after the subscription limit has been exceeded will be disconnected with exception: <i>SubscriberConnectionsExceededException</i>. <br><dl><dt>Examples:</dt><br><dd>Ex1 - Notification in JSON format for Admin and Operational state changes:</dd><pre><code>{<br> \"ietf-restconf:notification\": { <br> \"eventTime\": \"2016-10-17T22:13:12.170Z\", <br> \"nsp-service:service-state-change\": { <br> \"uuid\": \"5613-f89530bc-d71b-490e-9a64-59f3b2be41fc\", <br> \"operational-state\": { <br> \"new-value\": \"PARTIALLY_DOWN\", <br> \"old-value\": \"UP\" <br> }, <br> \"admin-state\": { <br> \"new-value\": \"MAINTENANCE\", <br> \"old-value\": \"UP\" <br> } <br> } <br> } <br>} <br></pre></code><dd>Ex2 - Notification in JSON format for an Operational state change </dd><pre><code>{ <br> \"ietf-restconf:notification\": { <br> \"eventTime\": \"2016-10-17T22:13:31.986Z\", <br> \"nsp-service:endpoint-state-change\": { <br> \"uuid\": \"5625-55fff8a5-7040-467e-887d-c9e46ea57d4d\", <br> \"operational-state\": { <br> \"new-value\": \"UP\", <br> \"old-value\": \"DOWN\" <br> } <br> } <br> } <br>} <br></code></pre></dl>

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

SseEmitter

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success SseEmitter

401

Unauthorized

403

Forbidden

404

Not Found

Up

Models

[ Jump to Methods ]

Table of Contents

  1. SseEmitter

SseEmitter Up

timeout (optional)