Hub API (4.1.0)
Download OpenAPI specification:Download
Provides the ability to subscribe to and unsubscribe from External API notifications.
Main operation
POST /hubrequest sample 1
{
"callback": "http://mydomain/notification",
"query": "eventType = ServiceOrderCreationNotification"
}request sample 2
{
"callback": "http://mydomain/notification",
"query": "eventType=ServiceOrderCreationNotification,ServiceOrderStateChangeNotification"
}EventType for serviceOrdering
- ServiceOrderCreationNotification
- ServiceOrderStateChangeNotification
- ServiceOrderItemStateChangeNotification
EventType for serviceInventory
- ServiceCreationNotification
- ServiceAttributeValueChangeNotification
- ServiceRemoveNotification
create hub
Request Body schema: application/json;charset=utf-8
| query required | string The query must have an eventType= information.\nOptionally a ? could be added to reduce hub.\nquery”:”eventType = ServiceOrderStateChangeNotification”&serviceOrder.state=COMPLETED |
| callback required | string URL where notification must be send |
Responses
201
Created
post /hub
http://serverRoot:30274/nbi/api/v4/hub
https://serverRoot:30274/nbi/api/v4/hub
Request samples
- Payload
Content type
application/json;charset=utf-8
Copy
Expand all Collapse all {- "query": "string",
- "callback": "string"
}Response samples
- 201
Content type
application/json;charset=utf-8
Copy
Expand all Collapse all {- "id": "string",
- "query": "string",
- "callback": "string"
} get /hub/{hubId}
http://serverRoot:30274/nbi/api/v4/hub/{hubId}
https://serverRoot:30274/nbi/api/v4/hub/{hubId}
Response samples
- 200
Content type
application/json;charset=utf-8
Copy
Expand all Collapse all {- "id": "string",
- "query": "string",
- "callback": "string"
}