{ "opencollection": "1.0.0", "info": { "name": "API Service Activation and Configuration", "version": "4.0.0" }, "items": [ { "info": { "name": "service", "type": "folder" }, "items": [ { "info": { "name": "List or find Service objects", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/service", "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 Service entities" }, { "info": { "name": "Creates a Service", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/service" }, "docs": "This operation creates a Service entity." }, { "info": { "name": "Retrieves a Service by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/service/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifier of the Service" }, { "name": "fields", "value": "", "type": "query", "description": "Comma-separated properties to provide in response" } ] }, "docs": "This operation retrieves a Service entity. Attribute selection is enabled for all first level attributes." }, { "info": { "name": "Updates partially a Service", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/service/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifier of the Service" } ] }, "docs": "This operation updates partially a Service entity." }, { "info": { "name": "Deletes a Service", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/service/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifier of the Service" } ] }, "docs": "This operation deletes a Service entity." } ] }, { "info": { "name": "monitor", "type": "folder" }, "items": [ { "info": { "name": "List or find Monitor objects", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/monitor", "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 Monitor entities" }, { "info": { "name": "Retrieves a Monitor by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/monitor/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifier of the Monitor" }, { "name": "fields", "value": "", "type": "query", "description": "Comma-separated properties to provide in response" } ] }, "docs": "This operation retrieves a Monitor entity. Attribute selection is enabled for all first level attributes." } ] }, { "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 ServiceCreateEvent", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/listener/serviceCreateEvent" }, "docs": "Example of a client listener for receiving the notification ServiceCreateEvent" }, { "info": { "name": "Client listener for entity ServiceAttributeValueChangeEvent", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/listener/serviceAttributeValueChangeEvent" }, "docs": "Example of a client listener for receiving the notification ServiceAttributeValueChangeEvent" }, { "info": { "name": "Client listener for entity ServiceStateChangeEvent", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/listener/serviceStateChangeEvent" }, "docs": "Example of a client listener for receiving the notification ServiceStateChangeEvent" }, { "info": { "name": "Client listener for entity ServiceDeleteEvent", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/listener/serviceDeleteEvent" }, "docs": "Example of a client listener for receiving the notification ServiceDeleteEvent" }, { "info": { "name": "Client listener for entity MonitorCreateEvent", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/listener/monitorCreateEvent" }, "docs": "Example of a client listener for receiving the notification MonitorCreateEvent" }, { "info": { "name": "Client listener for entity MonitorAttributeValueChangeEvent", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/listener/monitorAttributeValueChangeEvent" }, "docs": "Example of a client listener for receiving the notification MonitorAttributeValueChangeEvent" }, { "info": { "name": "Client listener for entity MonitorStateChangeEvent", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/listener/monitorStateChangeEvent" }, "docs": "Example of a client listener for receiving the notification MonitorStateChangeEvent" }, { "info": { "name": "Client listener for entity MonitorDeleteEvent", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/listener/monitorDeleteEvent" }, "docs": "Example of a client listener for receiving the notification MonitorDeleteEvent" } ] } ], "bundled": true }