{ "opencollection": "1.0.0", "info": { "name": "Controlplane Api ApiChangelog EventSpecification API", "version": "1.0.0" }, "items": [ { "info": { "name": "EventSpecification", "type": "folder" }, "items": [ { "info": { "name": "Find all EventSpecifications", "type": "http" }, "http": { "method": "GET", "url": "https://api.telekom.de/controlplane/v1/eventspecifications", "params": [ { "name": "limit", "value": "", "type": "query", "description": "page size requested by the consumer; must not be larger than the maximal page size" }, { "name": "cursor", "value": "", "type": "query", "description": "cursor to be used for pagination. If not provided, the first page will be returned. The cursor is a string that points to a page of data." }, { "name": "sort", "value": "", "type": "query", "description": "list of fields to be used for sorting. Default is name" } ] }, "docs": "Find all EventSpecifications of a Team" }, { "info": { "name": "Create an EventSpecification", "type": "http" }, "http": { "method": "POST", "url": "https://api.telekom.de/controlplane/v1/eventspecifications", "body": { "type": "json", "data": "{}" } }, "docs": "Create an EventSpecification. Creating and updating resources is asynchronous, which is why the status is given as an answer to a POST/PUT request, since it is possible that the resource to be created has not yet been processed at the time the response is created. If the status after creation is in state \"Processing\", the resource must be queried with GET to see whether it was created successfully or whether errors/warnings are written in the status. If the creation/update is incorrect, the proc" }, { "info": { "name": "Find an existing EventSpecification", "type": "http" }, "http": { "method": "GET", "url": "https://api.telekom.de/controlplane/v1/eventspecifications/:eventSpecificationId", "params": [ { "name": "eventSpecificationId", "value": "", "type": "path", "description": "The unique id of this resource" } ] }, "docs": "Find an existing EventSpecification" }, { "info": { "name": "Update an existing EventSpecification", "type": "http" }, "http": { "method": "PUT", "url": "https://api.telekom.de/controlplane/v1/eventspecifications/:eventSpecificationId", "params": [ { "name": "eventSpecificationId", "value": "", "type": "path", "description": "The unique id of this resource" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an existing EventSpecification. Creating and updating resources is asynchronous, which is why the status is given as an answer to a POST/PUT request, since it is possible that the resource to be created has not yet been processed at the time the response is created. If the status after creation is in state \"Processing\", the resource must be queried with GET to see whether it was created successfully or whether errors/warnings are written in the status. If the creation/update is incorrect," }, { "info": { "name": "Delete an EventSpecification", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telekom.de/controlplane/v1/eventspecifications/:eventSpecificationId", "params": [ { "name": "eventSpecificationId", "value": "", "type": "path", "description": "The unique id of this resource" } ] }, "docs": "**Important:** The deletion is done asynchronously to ensure that the resource was actually deleted, use this or the GET resource until you receive a 404 response. \nDelete an EventSpecification\n" }, { "info": { "name": "Find an existing EventSpecification and return its status", "type": "http" }, "http": { "method": "GET", "url": "https://api.telekom.de/controlplane/v1/eventspecifications/:eventSpecificationId/status", "params": [ { "name": "eventSpecificationId", "value": "", "type": "path", "description": "The unique id of this resource" } ] }, "docs": "Find an existing EventSpecification and return its status" } ] } ], "bundled": true }