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 | ||||
|---|---|---|---|---|
|
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 |
RESPONSE |
201 |
| Anchor | ||||
|---|---|---|---|---|
|
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} |
RESPONSE |
204 |
| Anchor | ||||
|---|---|---|---|---|
|
Description :
Provide the Event description
Behavior :
Returns HTTP/1.1 status code 201 if the service is able to set the configuration.
...
Example see TMF REST Design Guidelines.
| Anchor | ||||
|---|---|---|---|---|
|
| Anchor | ||||
|---|---|---|---|---|
|
| Anchor | ||||
|---|---|---|---|---|
|
| Anchor | ||||
|---|---|---|---|---|
|
| Anchor | ||||
|---|---|---|---|---|
|
Release Number | Date | Release led by: | Description |
Release 1.0 | 04/15/2013 | Pierre Gauthier | First Release of Draft Version of the Document. |
Release 1.1 |
|
| Updated for use in the Paris Spec Jam – and rebranded,. |
...