{ "opencollection": "1.0.0", "info": { "name": "API ChangeManagement", "version": "4.2.0" }, "items": [ { "info": { "name": "changeRequest", "type": "folder" }, "items": [ { "info": { "name": "List or find ChangeRequest objects", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/changeRequest", "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" }, { "name": "sort", "value": "", "type": "query", "description": "To have the output sorted by fields. Can support one or many fields, as well as ascending and descending sort order" }, { "name": "expand", "value": "", "type": "query", "description": "Lists the sub-entities to expand along with the depth value. Empty means expand all at depth level N" }, { "name": "depth", "value": "", "type": "query", "description": "Depth level where objects are dereferenced and inserted as values into the response" } ] }, "docs": "This operation list or find ChangeRequest entities" }, { "info": { "name": "Creates a ChangeRequest", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/changeRequest" }, "docs": "This operation creates a ChangeRequest entity." }, { "info": { "name": "Retrieves a ChangeRequest by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/changeRequest/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifier of the ChangeRequest" }, { "name": "fields", "value": "", "type": "query", "description": "Comma-separated properties to be provided in response" }, { "name": "expand", "value": "", "type": "query", "description": "Lists the sub-entities to expand along with the depth value. Empty means expand all at depth level N" }, { "name": "depth", "value": "", "type": "query", "description": "Depth level where objects are dereferenced and inserted as values into the response" } ] }, "docs": "This operation retrieves a ChangeRequest entity. Attribute selection is enabled for all first level attributes." }, { "info": { "name": "Updates partially a ChangeRequest", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/changeRequest/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifier of the ChangeRequest" } ] }, "docs": "This operation updates partially a ChangeRequest entity." }, { "info": { "name": "Deletes a ChangeRequest", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/changeRequest/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifier of the ChangeRequest" } ] }, "docs": "This operation deletes a ChangeRequest 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 ChangeRequestCreateEvent", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/listener/changeRequestCreateEvent" }, "docs": "Example of a client listener for receiving the notification ChangeRequestCreateEvent" }, { "info": { "name": "Client listener for entity ChangeRequestStatusChangeEvent", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/listener/changeRequestStatusChangeEvent" }, "docs": "Example of a client listener for receiving the notification ChangeRequestStatusChangeEvent" }, { "info": { "name": "Client listener for entity ChangeRequestDeleteEvent", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/listener/changeRequestDeleteEvent" }, "docs": "Example of a client listener for receiving the notification ChangeRequestDeleteEvent" }, { "info": { "name": "Client listener for entity ChangeRequestAttributeValueChangeEvent", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/listener/changeRequestAttributeValueChangeEvent" }, "docs": "Example of a client listener for receiving the notification ChangeRequestAttributeValueChangeEvent" }, { "info": { "name": "Client listener for entity ChangeRequestApprovalRequiredEvent", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/listener/changeRequestApprovalRequiredEvent" }, "docs": "Example of a client listener for receiving the notification ChangeRequestApprovalRequiredEvent" }, { "info": { "name": "Client listener for entity ChangeRequestFailureEvent", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/listener/changeRequestFailureEvent" }, "docs": "Example of a client listener for receiving the notification ChangeRequestFailureEvent" } ] } ], "bundled": true }