{ "opencollection": "1.0.0", "info": { "name": "API ServiceOrdering", "version": "4.6.0" }, "items": [ { "info": { "name": "cancelServiceOrder", "type": "folder" }, "items": [ { "info": { "name": "List or find CancelServiceOrder objects", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/cancelServiceOrder", "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 CancelServiceOrder entities" }, { "info": { "name": "Creates a CancelServiceOrder", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/cancelServiceOrder" }, "docs": "This operation creates a CancelServiceOrder entity." }, { "info": { "name": "Retrieves a CancelServiceOrder by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/cancelServiceOrder/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifier of the CancelServiceOrder" }, { "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 CancelServiceOrder entity. Attribute selection is enabled for all first level attributes." } ] }, { "info": { "name": "serviceOrder", "type": "folder" }, "items": [ { "info": { "name": "List or find ServiceOrder objects", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/serviceOrder", "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 ServiceOrder entities" }, { "info": { "name": "Creates a ServiceOrder", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/serviceOrder" }, "docs": "This operation creates a ServiceOrder entity." }, { "info": { "name": "Retrieves a ServiceOrder by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/serviceOrder/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifier of the ServiceOrder" }, { "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 ServiceOrder entity. Attribute selection is enabled for all first level attributes." }, { "info": { "name": "Updates partially a ServiceOrder", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/serviceOrder/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifier of the ServiceOrder" } ] }, "docs": "This operation updates partially a ServiceOrder entity." }, { "info": { "name": "Deletes a ServiceOrder", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/serviceOrder/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifier of the ServiceOrder" } ] }, "docs": "This operation deletes a ServiceOrder 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 ServiceOrderCreateEvent", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/listener/serviceOrderCreateEvent" }, "docs": "Example of a client listener for receiving the notification ServiceOrderCreateEvent" }, { "info": { "name": "Client listener for entity ServiceOrderAttributeValueChangeEvent", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/listener/serviceOrderAttributeValueChangeEvent" }, "docs": "Example of a client listener for receiving the notification ServiceOrderAttributeValueChangeEvent" }, { "info": { "name": "Client listener for entity ServiceOrderStateChangeEvent", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/listener/serviceOrderStateChangeEvent" }, "docs": "Example of a client listener for receiving the notification ServiceOrderStateChangeEvent" }, { "info": { "name": "Client listener for entity ServiceOrderDeleteEvent", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/listener/serviceOrderDeleteEvent" }, "docs": "Example of a client listener for receiving the notification ServiceOrderDeleteEvent" }, { "info": { "name": "Client listener for entity ServiceOrderInformationRequiredEvent", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/listener/serviceOrderInformationRequiredEvent" }, "docs": "Example of a client listener for receiving the notification ServiceOrderInformationRequiredEvent" }, { "info": { "name": "Client listener for entity ServiceOrderMilestoneEvent", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/listener/serviceOrderMilestoneEvent" }, "docs": "Example of a client listener for receiving the notification ServiceOrderMilestoneEvent" }, { "info": { "name": "Client listener for entity ServiceOrderJeopardyEvent", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/listener/serviceOrderJeopardyEvent" }, "docs": "Example of a client listener for receiving the notification ServiceOrderJeopardyEvent" }, { "info": { "name": "Client listener for entity CancelServiceOrderCreateEvent", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/listener/cancelServiceOrderCreateEvent" }, "docs": "Example of a client listener for receiving the notification CancelServiceOrderCreateEvent" }, { "info": { "name": "Client listener for entity CancelServiceOrderStateChangeEvent", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/listener/cancelServiceOrderStateChangeEvent" }, "docs": "Example of a client listener for receiving the notification CancelServiceOrderStateChangeEvent" }, { "info": { "name": "Client listener for entity CancelServiceOrderInformationRequiredEvent", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/listener/cancelServiceOrderInformationRequiredEvent" }, "docs": "Example of a client listener for receiving the notification CancelServiceOrderInformationRequiredEvent" }, { "info": { "name": "Client listener for entity ServiceOrderFailureEvent", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/listener/serviceOrderFailureEvent" }, "docs": "Example of a client listener for receiving the notification ServiceOrderFailureEvent" } ] } ], "bundled": true }