Delete Export Collection Job - Crosswork Network Controller 7.1 APIs

{"type":"api","title":"Delete Export Collection Job","meta":{"id":"/apps/pubhub/media/crosswork-network-controller-7-1/f445c17e25a1120e8fbde4bd413083d0fd88b2b3/b44e8ba1-6566-34bf-b4f1-d28c15d76254","info":{"title":"Crosswork Collection Service APIs","description":"Crosswork Collector Services APIs manage application intents for collection jobs across multiple devices and different collection types, including SNMP, CLI, TRAP, MDT, GNMI, and SYSLOG.","version":"1.0.0","contact":{"name":"Crosswork Team, Cisco","email":"support@cisco.com"},"license":{"name":"Cisco Software License Agreement","url":"http://www.cisco.com/public/sw-license-agreement.html"}},"x-parser-conf":{"overview":{"markdownPath":"reference/INFRA/COLLECTIONS/collection-service-overview.md"}},"swagger":"2.0","basePath":"/crosswork/collection/v1","schemes":["https","http"],"securityDefinitions":{"bearerAuth":{"type":"apiKey","description":"bearer auth","name":"Authorization","in":"header"}}},"spec":{"summary":"Delete Export Collection Job","description":"DeleteJob serves as a generic API to delete many underlying types of jobs in collection services.\nCurrently, only export collection jobs are supported. \nIf not explicitly deleted, Helios will purge export collection jobs periodically, based on Helios configuration settings. \nIf explicitly deleted while the job is currently in progress, Magellan will abort them and Helios will purge them. Crosswork Data Gateway takes no action in these cases.","operationId":"CollectionService_DeleteJob","responses":{"200":{"description":"OK. The request was successful. The result is contained in the response body","schema":{"type":"object","properties":{"result":{"type":"object","properties":{"request_result":{"description":"The result values indicates whether the request was accepted or rejected, not the outcome of the work itself.","type":"string","enum":["UNKNOWN_RESULT","REJECTED","ACCEPTED"],"default":"UNKNOWN_RESULT","$$ref":"#/definitions/collection_serviceRequestResult"},"error":{"description":"A text message describing the reason for rejection. It can be safely passed on to the operator through logs or the UI.","type":"object","properties":{"error":{"type":"string","description":"Message is a textual description of the reason for rejection. You can safely pass it on to the operator through logs or the UI."}},"title":"Error associated with an object","$$ref":"#/definitions/collection_serviceError"}},"description":"Result is used to convey whether an operation (individual or in a batch) has been accepted or rejected.\nFor sync APIs, an error or rejection indicates failure of the operation.\nA string error message accompanies rejection to support troubleshooting.\nFor notification objects, rejection represents failure to do intended operation.","$$ref":"#/definitions/collection_serviceResult"}},"example":{"result":{"request_result":"ACCEPTED","error":{"error":""}}},"description":"DeleteJobResponse encapsulates a generic response from the collection service API from a DeleteJobRequest.\nIt includes a result to indicate success or failure of the request itself,\nwith an associated error message upon failure.","$$ref":"#/definitions/collection_serviceDeleteJobResponse"}},"default":{"description":"An unexpected error response.","schema":{"type":"object","properties":{"result":{"type":"object","properties":{"request_result":{"description":"The result values indicates whether the request was accepted or rejected, not the outcome of the work itself.","type":"string","enum":["UNKNOWN_RESULT","REJECTED","ACCEPTED"],"default":"UNKNOWN_RESULT","$$ref":"#/definitions/collection_serviceRequestResult"},"error":{"description":"A text message describing the reason for rejection. It can be safely passed on to the operator through logs or the UI.","type":"object","properties":{"error":{"type":"string","description":"Message is a textual description of the reason for rejection. You can safely pass it on to the operator through logs or the UI."}},"title":"Error associated with an object","$$ref":"#/definitions/collection_serviceError"}},"description":"Result is used to convey whether an operation (individual or in a batch) has been accepted or rejected.\nFor sync APIs, an error or rejection indicates failure of the operation.\nA string error message accompanies rejection to support troubleshooting.\nFor notification objects, rejection represents failure to do intended operation.","$$ref":"#/definitions/collection_serviceResult"}},"example":{"result":{"request_result":"REJECTED","error":{"error":"empty request"}}},"$$ref":"#/definitions/jobdeleteErrorResponse"}}},"parameters":[{"name":"body","in":"body","description":"Delete Job.","required":true,"schema":{"type":"object","properties":{"id":{"type":"object","properties":{"export_id":{"type":"object","properties":{"application_context":{"description":"The application_context is a handle that uniquely identifies your application's collection job. It serves as the key to the object on which CRUD operations are performed.\nThe combination of application_id and context_id should be unique globally.","type":"object","properties":{"application_id":{"type":"string","description":"The application_id is a unique ID that identifies your application. Crosswork applications always prefix the application_id with “cw“."},"context_id":{"type":"string","description":"The context_id is a unique ID that identifies your application subscription across all collection jobs. We recommend that you use the device UUID for the context_id."}},"$$ref":"#/definitions/collection_serviceApplicationContext"}},"description":"ExportCollectionsId serves as the globally unique identifier for an export collections job.","$$ref":"#/definitions/collection_serviceExportCollectionsId"}},"description":"JobId encapsulates many underlying collection job ID types.","$$ref":"#/definitions/collection_serviceJobId"}},"example":{"id":{"export_id":{"application_context":{"application_id":"test3","context_id":"test3-context1750825717660"}}}},"description":"DeleteJobRequest encapsulates a generic request to the collection services.\nAPI to remove a pre-existing job, based on it's associated unique ID.","$$ref":"#/definitions/collection_serviceDeleteJobRequest"}}],"tags":["CollectionService"],"__originalOperationId":"CollectionService_DeleteJob","consumes":["application/json"],"produces":["application/json"],"method":"delete","path":"/jobs"}}