{ "opencollection": "1.0.0", "info": { "name": "Resource Inventory Management", "version": "4.1.0" }, "items": [ { "info": { "name": "logicalResource", "type": "folder" }, "items": [ { "info": { "name": "List or find LogicalResource objects", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/logicalResource", "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 LogicalResource entities" }, { "info": { "name": "Creates a LogicalResource", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/logicalResource" }, "docs": "This operation creates a LogicalResource entity." }, { "info": { "name": "Retrieves a LogicalResource by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/logicalResource/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifier of the LogicalResource" }, { "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 LogicalResource entity. Attribute selection is enabled for all first level attributes." }, { "info": { "name": "Updates a LogicalResource", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/logicalResource/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifier of the LogicalResource" } ] }, "docs": "This operation updates a LogicalResource entity." }, { "info": { "name": "Updates partially a LogicalResource", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/logicalResource/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifier of the LogicalResource" } ] }, "docs": "This operation updates partially a LogicalResource entity." }, { "info": { "name": "Deletes a LogicalResource", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/logicalResource/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifier of the LogicalResource" } ] }, "docs": "This operation deletes a LogicalResource entity." } ] }, { "info": { "name": "Resource", "type": "folder" }, "items": [ { "info": { "name": "Updates a Logical Resource by applying a list of json patch operations", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/logicalResource/executeJSONPatch", "params": [ { "name": "externalId", "value": "", "type": "query", "description": "Resource External Id" } ] }, "docs": "Updates a Logical Resource by applying a list of json patch operations" } ] }, { "info": { "name": "physicalResource", "type": "folder" }, "items": [ { "info": { "name": "List or find PhysicalResource objects", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/physicalResource", "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 PhysicalResource entities" }, { "info": { "name": "Creates a PhysicalResource", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/physicalResource" }, "docs": "This operation creates a PhysicalResource entity." }, { "info": { "name": "Retrieves a PhysicalResource by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/physicalResource/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifier of the PhysicalResource" }, { "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 PhysicalResource entity. Attribute selection is enabled for all first level attributes." }, { "info": { "name": "Updates partially a PhysicalResource", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/physicalResource/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifier of the PhysicalResource" } ] }, "docs": "This operation updates partially a PhysicalResource entity." }, { "info": { "name": "Deletes a PhysicalResource", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/physicalResource/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifier of the PhysicalResource" } ] }, "docs": "This operation deletes a PhysicalResource entity." } ] }, { "info": { "name": "resource", "type": "folder" }, "items": [ { "info": { "name": "List or find Resource objects", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/resource", "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 Resource entities" }, { "info": { "name": "Creates a Resource", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/resource" }, "docs": "This operation creates a Resource entity." }, { "info": { "name": "Retrieves a Resource by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/resource/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifier of the Resource" }, { "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 Resource entity. Attribute selection is enabled for all first level attributes." }, { "info": { "name": "Updates partially a Resource", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/resource/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifier of the Resource" } ] }, "docs": "This operation updates partially a Resource entity." }, { "info": { "name": "Deletes a Resource", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/resource/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifier of the Resource" } ] }, "docs": "This operation deletes a Resource 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 ResourceCreateEvent", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/listener/resourceCreateEvent" }, "docs": "Example of a client listener for receiving the notification ResourceCreateEvent" }, { "info": { "name": "Client listener for entity ResourceAttributeValueChangeEvent", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/listener/resourceAttributeValueChangeEvent" }, "docs": "Example of a client listener for receiving the notification ResourceAttributeValueChangeEvent" }, { "info": { "name": "Client listener for entity ResourceStateChangeEvent", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/listener/resourceStateChangeEvent" }, "docs": "Example of a client listener for receiving the notification ResourceStateChangeEvent" }, { "info": { "name": "Client listener for entity ResourceDeleteEvent", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/listener/resourceDeleteEvent" }, "docs": "Example of a client listener for receiving the notification ResourceDeleteEvent" }, { "info": { "name": "Client listener for entity PhysicalResourceCreateEvent", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/listener/physicalResourceCreateEvent" }, "docs": "Example of a client listener for receiving the notification PhysicalResourceCreateEvent" }, { "info": { "name": "Client listener for entity PhysicalResourceAttributeValueChangeEvent", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/listener/physicalResourceAttributeValueChangeEvent" }, "docs": "Example of a client listener for receiving the notification PhysicalResourceAttributeValueChangeEvent" }, { "info": { "name": "Client listener for entity PhysicalResourceStateChangeEvent", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/listener/physicalResourceStateChangeEvent" }, "docs": "Example of a client listener for receiving the notification PhysicalResourceStateChangeEvent" }, { "info": { "name": "Client listener for entity PhysicalResourceDeleteEvent", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/listener/physicalResourceDeleteEvent" }, "docs": "Example of a client listener for receiving the notification PhysicalResourceDeleteEvent" } ] } ], "bundled": true }