Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

For every single of operation on the entities use the following templates and provide sample REST notification POST calls.
It is assumed that the Pub/Sub uses the Register and UnRegister mechanisms described in the REST Guidelines reproduced below.

Anchor
_Toc404174516
_Toc404174516
REGISTER LISTENER POST /hub

Description :
Sets the communication endpoint address the service instance must use to deliver information about its health state, execution state, failures and metrics. Subsequent POST calls will be rejected by the service if it does not support multiple listeners. In this case DELETE /api/hub/{id} must be called before an endpoint can be created again.
Behavior :
Returns HTTP/1.1 status code 204 if the request was successful.
Returns HTTP/1.1 status code 409 if request is not successful.

REQUEST

POST /api/hub
Accept: application/json

{"callback": "http://in.listener.com"}

RESPONSE

201
Content-Type: application/json
Location: /api/hub/42

{"id":"42","callback":"http://in.listener.com","query":null}

 

Anchor
_Toc404174517
_Toc404174517
UNREGISTER LISTENER DELETE hub/{id}

Description :
Clears the communication endpoint address that was set by creating the Hub.
Behavior :
Returns HTTP/1.1 status code 204 if the request was successful.
Returns HTTP/1.1 status code 404 if the resource is not found.

REQUEST

DELETE /api/hub/{id}
Accept: application/json

RESPONSE

204

 

Anchor
_Toc404174518
_Toc404174518
publish {EventTYPE} POST /listener

Description :
Provide the Event description
Behavior :
Returns HTTP/1.1 status code 201 if the service is able to set the configuration.

...