...
| Hide If |
|---|
|
| Note |
|---|
| title | To access this API specification you wil need to be logged in |
|---|
| To login with your TM Forum account please click on the Login button below | Button Hyperlink |
|---|
| title | Login |
|---|
| type | primary |
|---|
| url | https://projects.tmforum.org/wiki/login.action?os_destination=%2Fdisplay%2FAPI%2FOpen%2BAPI%2BTable |
|---|
|
Don't have an account? You can register by clicking here: | Button Hyperlink |
|---|
| title | Register |
|---|
| type | primary |
|---|
| url | https://www.tmforum.org/user-registration/ |
|---|
| target | true |
|---|
|
|
|
| Show If |
|---|
|
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. |
...
REGISTER LISTENER POST /hubDescription :
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. |
...
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 |
|
...
publish {EventTYPE} POST /listenerDescription :
Provide the Event description
Behavior :
Returns HTTP/1.1 status code 201 if the service is able to set the configuration. REQUEST | POST /client/listener
Accept: application/json
{
"eventType": "EventType",
"eventTime": "2014-09-27T05:46:25.0Z",
"eventId": "1562231",
"event":
{
EVENT BODY }
} | RESPONSE | 201
Content-Type: application/json |
Example see TMF REST Design Guidelines.
|
© TM Forum 2015. All Rights Reserved