{ "opencollection": "1.0.0", "info": { "name": "Event Streaming API", "version": "4.0.0" }, "items": [ { "info": { "name": "event", "type": "folder" }, "items": [ { "info": { "name": "List or find Event objects", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/topic/:topicId/event", "params": [ { "name": "topicId", "value": "", "type": "path", "description": "Identifier of the parent Topic entity" }, { "name": "fields", "value": "", "type": "query", "description": "Comma-separated properties to be provided in response" }, { "name": "offset", "value": "", "type": "query", "description": "Requested index for start of resources to be provided in response" }, { "name": "limit", "value": "", "type": "query", "description": "Requested number of resources to be provided in response" } ] }, "docs": "This operation list or find Event entities" }, { "info": { "name": "Creates a Event", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/topic/:topicId/event", "params": [ { "name": "topicId", "value": "", "type": "path", "description": "Identifier of the parent Topic entity" } ] }, "docs": "This operation creates a Event entity." }, { "info": { "name": "Retrieves a Event by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/topic/:topicId/event/:id", "params": [ { "name": "topicId", "value": "", "type": "path", "description": "Identifier of the parent Topic entity" }, { "name": "id", "value": "", "type": "path", "description": "Identifier of the Event" }, { "name": "fields", "value": "", "type": "query", "description": "Comma-separated properties to provide in response" } ] }, "docs": "This operation retrieves a Event entity. Attribute selection is enabled for all first level attributes." } ] }, { "info": { "name": "topic", "type": "folder" }, "items": [ { "info": { "name": "List or find Topic objects", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/topic", "params": [ { "name": "fields", "value": "", "type": "query", "description": "Comma-separated properties to be provided in response" }, { "name": "offset", "value": "", "type": "query", "description": "Requested index for start of resources to be provided in response" }, { "name": "limit", "value": "", "type": "query", "description": "Requested number of resources to be provided in response" } ] }, "docs": "This operation list or find Topic entities" }, { "info": { "name": "Creates a Topic", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/topic" }, "docs": "This operation creates a Topic entity." }, { "info": { "name": "Retrieves a Topic by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/topic/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifier of the Topic" }, { "name": "fields", "value": "", "type": "query", "description": "Comma-separated properties to provide in response" } ] }, "docs": "This operation retrieves a Topic entity. Attribute selection is enabled for all first level attributes." }, { "info": { "name": "Deletes a Topic", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/topic/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifier of the Topic" } ] }, "docs": "This operation deletes a Topic entity." } ] }, { "info": { "name": "hub", "type": "folder" }, "items": [ { "info": { "name": "List or find Hub objects", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/topic/:topicId/hub", "params": [ { "name": "topicId", "value": "", "type": "path", "description": "Identifier of the parent Topic entity" }, { "name": "fields", "value": "", "type": "query", "description": "Comma-separated properties to be provided in response" }, { "name": "offset", "value": "", "type": "query", "description": "Requested index for start of resources to be provided in response" }, { "name": "limit", "value": "", "type": "query", "description": "Requested number of resources to be provided in response" } ] }, "docs": "This operation list or find Hub entities" }, { "info": { "name": "Creates a Hub", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/topic/:topicId/hub", "params": [ { "name": "topicId", "value": "", "type": "path", "description": "Identifier of the parent Topic entity" } ] }, "docs": "This operation creates a Hub entity." }, { "info": { "name": "Retrieves a Hub by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/topic/:topicId/hub/:id", "params": [ { "name": "topicId", "value": "", "type": "path", "description": "Identifier of the parent Topic entity" }, { "name": "id", "value": "", "type": "path", "description": "Identifier of the Hub" }, { "name": "fields", "value": "", "type": "query", "description": "Comma-separated properties to provide in response" } ] }, "docs": "This operation retrieves a Hub entity. Attribute selection is enabled for all first level attributes." }, { "info": { "name": "Deletes a Hub", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/topic/:topicId/hub/:id", "params": [ { "name": "topicId", "value": "", "type": "path", "description": "Identifier of the parent Topic entity" }, { "name": "id", "value": "", "type": "path", "description": "Identifier of the Hub" } ] }, "docs": "This operation deletes a Hub entity." } ] }, { "info": { "name": "events subscription", "type": "folder" }, "items": [ { "info": { "name": "Register a listener", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hub" }, "docs": "Sets the communication endpoint address the service instance must use to deliver information about its health state, execution state, failures and metrics." }, { "info": { "name": "Unregister a listener", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/hub/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The id of the registered listener" } ] }, "docs": "Resets the communication endpoint address the service instance must use to deliver information about its health state, execution state, failures and metrics." } ] }, { "info": { "name": "notification listeners (client side)", "type": "folder" }, "items": [ { "info": { "name": "Client listener for entity TopicCreateEvent", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/listener/topicCreateEvent" }, "docs": "Example of a client listener for receiving the notification TopicCreateEvent" }, { "info": { "name": "Client listener for entity TopicChangeEvent", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/listener/topicChangeEvent", "params": [ { "name": "sourceIdentifier", "value": "", "type": "query", "description": "source system details for routing purpose" } ] }, "docs": "Example of a client listener for receiving the notification TopicChangeEvent" }, { "info": { "name": "Client listener for entity TopicDeleteEvent", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/listener/topicDeleteEvent" }, "docs": "Example of a client listener for receiving the notification TopicDeleteEvent" } ] } ], "bundled": true }