Get a List of Jobs - Crosswork Network Controller 7.1 APIs

{"type":"api","title":"Get a List of Jobs","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":"Get a List of Jobs","description":"GetJobs serves as a generic API to get a list of underlying jobs in Collection Services. The return will include some associated information.","operationId":"CollectionService_GetJobs","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"},"query_options":{"type":"object","properties":{"page_token":{"type":"string","title":"Page token used to echo back to get the next page. If collection_job_device_sets is empty or the page token are empty, there are no more results"},"page_size":{"type":"integer","format":"int64","title":"page_size"},"filter_list":{"type":"array","items":{"type":"object","properties":{"operator":{"description":"The filter logical or conditional operator (such as AND, OR, \u003e, \u003c).","type":"string","enum":["UNKNOWN_OPERATOR","OPERATOR_OR","OPERATOR_AND","OPERATOR_EQ","OPERATOR_REGEX","OPERATOR_CONTAINS"],"default":"UNKNOWN_OPERATOR","$$ref":"#/definitions/collection_serviceFilterOperator"},"field_list":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"The name of the field to filter on. Only CollectionState String is supported."},"value":{"type":"string","description":"The field value to filter on. For non-strings, the backend will convert it to honor actual DB type."}},"$$ref":"#/definitions/collection_serviceFilterField"},"title":"The list of filter criteria"}},"title":"Filter","$$ref":"#/definitions/collection_serviceFilter"},"title":"filtering options"},"filter_query":{"type":"string","description":"Reserved for future use."}},"title":"Query Options","$$ref":"#/definitions/collection_serviceQueryOptions"},"jobs":{"type":"array","items":{"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"},"user":{"type":"string","description":"The ID of the user who initiated the collection job."},"created":{"type":"string","format":"uint64","description":"The time the job was created. Specified as Unix epoch in milliseconds."},"completed":{"type":"string","format":"uint64","description":"The time the job completed executing. Specified as Unix epoch in milliseconds."},"progress":{"type":"integer","format":"int64","description":"Job execution progress as a percentage (0-100)."},"status":{"description":"The current runtime status.","type":"string","enum":["JOB_UNKNOWN","JOB_CREATED","JOB_IN_PROGRESS","JOB_COMPLETED","JOB_FAILED"],"default":"JOB_UNKNOWN","$$ref":"#/definitions/collection_serviceJobStatus"},"type":{"description":"The type of underlying concrete job.","type":"string","enum":["UNKNOWN_JOB","COLLECTION_JOB","TEMPLATE_COLLECTION_JOB","EXPORT_COLLECTIONS"],"default":"UNKNOWN_JOB","$$ref":"#/definitions/collection_serviceJobType"},"description":{"type":"string","description":"Short text description of the job."}},"description":"The collection_serviceJob object aggregates basic runtime information associated to a collection services job.","$$ref":"#/definitions/collection_serviceJob"}}},"example":{"result":{"request_result":"ACCEPTED","error":{"error":""}},"query_options":{"page_token":"1739189572173","page_size":100,"filter_list":[],"filter_query":""},"jobs":[{"id":{"export_id":{"application_context":{"application_id":"cw.dlminvmgr0","context_id":"dlm/cli-collector/group/te-tunnel-id/subscription1739189572141"}}},"user":"admin","created":"1739189572173","completed":"1739189588412","progress":100,"status":"JOB_COMPLETED","type":"EXPORT_COLLECTIONS","description":"Export status/metrics to 10.64.102.100"}]},"description":"GetJobsResponse encapsulates a generic response from the collection services API to a GetJobsRequest.\nIt includes a result to indicate success or failure of the request itself,\nwith an associated error message upon failure.\nCurrently the query options are not utilized.","$$ref":"#/definitions/collection_serviceGetJobsResponse"}},"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"},"query_options":{"type":"object","properties":{"page_token":{"type":"string","title":"Page token used to echo back to get the next page. If collection_job_device_sets is empty or the page token are empty, there are no more results"},"page_size":{"type":"integer","format":"int64","title":"page_size"},"filter_list":{"type":"array","items":{"type":"object","properties":{"operator":{"description":"The filter logical or conditional operator (such as AND, OR, \u003e, \u003c).","type":"string","enum":["UNKNOWN_OPERATOR","OPERATOR_OR","OPERATOR_AND","OPERATOR_EQ","OPERATOR_REGEX","OPERATOR_CONTAINS"],"default":"UNKNOWN_OPERATOR","$$ref":"#/definitions/collection_serviceFilterOperator"},"field_list":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"The name of the field to filter on. Only CollectionState String is supported."},"value":{"type":"string","description":"The field value to filter on. For non-strings, the backend will convert it to honor actual DB type."}},"$$ref":"#/definitions/collection_serviceFilterField"},"title":"The list of filter criteria"}},"title":"Filter","$$ref":"#/definitions/collection_serviceFilter"},"title":"filtering options"},"filter_query":{"type":"string","description":"Reserved for future use."}},"title":"Query Options","$$ref":"#/definitions/collection_serviceQueryOptions"},"jobs":{"type":"array","items":{"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"},"user":{"type":"string","description":"The ID of the user who initiated the collection job."},"created":{"type":"string","format":"uint64","description":"The time the job was created. Specified as Unix epoch in milliseconds."},"completed":{"type":"string","format":"uint64","description":"The time the job completed executing. Specified as Unix epoch in milliseconds."},"progress":{"type":"integer","format":"int64","description":"Job execution progress as a percentage (0-100)."},"status":{"description":"The current runtime status.","type":"string","enum":["JOB_UNKNOWN","JOB_CREATED","JOB_IN_PROGRESS","JOB_COMPLETED","JOB_FAILED"],"default":"JOB_UNKNOWN","$$ref":"#/definitions/collection_serviceJobStatus"},"type":{"description":"The type of underlying concrete job.","type":"string","enum":["UNKNOWN_JOB","COLLECTION_JOB","TEMPLATE_COLLECTION_JOB","EXPORT_COLLECTIONS"],"default":"UNKNOWN_JOB","$$ref":"#/definitions/collection_serviceJobType"},"description":{"type":"string","description":"Short text description of the job."}},"description":"The collection_serviceJob object aggregates basic runtime information associated to a collection services job.","$$ref":"#/definitions/collection_serviceJob"}}},"example":{"result":{"request_result":"REJECTED","error":{"error":"empty request"}},"query_options":null,"jobs":[]},"$$ref":"#/definitions/jobsqueryErrorResponse"}}},"parameters":[{"name":"body","in":"body","description":"Get Jobs.","required":true,"schema":{"type":"object","properties":{"query_options":{"type":"object","properties":{"page_token":{"type":"string","title":"Page token used to echo back to get the next page. If collection_job_device_sets is empty or the page token are empty, there are no more results"},"page_size":{"type":"integer","format":"int64","title":"page_size"},"filter_list":{"type":"array","items":{"type":"object","properties":{"operator":{"description":"The filter logical or conditional operator (such as AND, OR, \u003e, \u003c).","type":"string","enum":["UNKNOWN_OPERATOR","OPERATOR_OR","OPERATOR_AND","OPERATOR_EQ","OPERATOR_REGEX","OPERATOR_CONTAINS"],"default":"UNKNOWN_OPERATOR","$$ref":"#/definitions/collection_serviceFilterOperator"},"field_list":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"The name of the field to filter on. Only CollectionState String is supported."},"value":{"type":"string","description":"The field value to filter on. For non-strings, the backend will convert it to honor actual DB type."}},"$$ref":"#/definitions/collection_serviceFilterField"},"title":"The list of filter criteria"}},"title":"Filter","$$ref":"#/definitions/collection_serviceFilter"},"title":"filtering options"},"filter_query":{"type":"string","description":"Reserved for future use."}},"title":"Query Options","$$ref":"#/definitions/collection_serviceQueryOptions"},"ids":{"type":"array","items":{"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":{"query_options":{"page_token":"0","page_size":100,"filter_list":[],"filter_query":""},"ids":[{"export_id":{"application_context":{"application_id":"cw.dlminvmgr0","context_id":"dlm/cli-collector/group/te-tunnel-id/subscription1739189572141"}}}]},"description":"GetJobsRequest encapsulates a generic request to the collection services API to get a list of underlying jobs with some associated information.\nCurrently the query options are not utilized.","$$ref":"#/definitions/collection_serviceGetJobsRequest"}}],"tags":["CollectionService"],"__originalOperationId":"CollectionService_GetJobs","consumes":["application/json"],"produces":["application/json"],"method":"post","path":"/jobs/query"}}