{"type":"api","title":"Retrieve Jobs","meta":{"id":"/apps/pubhub/media/crosswork-network-controller-7-1/f445c17e25a1120e8fbde4bd413083d0fd88b2b3/4ecd3a14-d0be-3ef0-ba5d-c3cd958217a7","info":{"title":"Crosswork Device Lifecycle Management (DLM) Inventory API","description":"Crosswork DLM Inventory APIs allow the user to perform CRUD operations on Crosswork Tags, Credentials, Providers and Nodes.","version":"1.0.0","contact":{"name":"Crosswork Team, Cisco","email":"support@cisco.com"},"license":{"name":"Cisco Software License Agreement","url":"https://www.cisco.com/public/sw-license-agreement.html"}},"security":[{"bearerAuth":[]}],"x-parser-conf":{"overview":{"markdownPath":"reference/INFRA/DLM/nodedbapi-overview.md"}},"swagger":"2.0","basePath":"/crosswork/inventory/v1","schemes":["http","https"],"securityDefinitions":{"bearerAuth":{"type":"apiKey","description":"bearer auth","name":"Authorization","in":"header"}}},"spec":{"summary":"Retrieve Jobs","description":"Read the Jobs information\nRequest Body: RobotNodeJobGetReq\n -- Mandatory: RobotNodeJobGetReq, even if it is empty\nResponse Body: RobotNodeJobList Filters supported: JobId or State. Output is always sorted using creation time.\nDEPRECATED URL : post: /v2/dlm/invmgr/jobs/get","operationId":"NodeDb_GetJobs","responses":{"200":{"description":"A successful response.","schema":{"type":"object","properties":{"jobs":{"type":"array","items":{"type":"object","properties":{"job_id":{"type":"string","title":"Job id"},"inst_id":{"type":"string","title":"Server instance identifier"},"state":{"title":"Current State of the Job","type":"string","enum":["JOB_INVALID","JOB_REJECTED","JOB_ACCEPTED","JOB_DB_UPDATED","JOB_NOTIFICATION_PUBLISHED","JOB_COMPLETED","JOB_FAILED","JOB_RUNNING","JOB_PARTIAL","JOB_COMPLETED_WITH_WARNING"],"default":"JOB_INVALID","$$ref":"#/definitions/robotapiRobotJobState"},"type":{"type":"string","title":"Job type. Debug purpose"},"error":{"type":"string","title":"If any error"},"completion_time":{"type":"string","format":"int64","title":"Remaining time to complete"},"creation_time":{"type":"string","format":"int64","title":"Job creation time in epoch seconds"},"created_by":{"type":"string","title":"User"},"impacted_count":{"type":"integer","format":"int64","title":"Impacted nodes/tags, provider or profiles"},"impacted":{"type":"array","items":{"type":"string"},"title":"Impacted elements list"},"errors":{"type":"array","items":{"type":"string"}}},"title":"Every Action related to Inventory will have a Job","example":{"job_id":"6315b69e-0646-4714-a855-7a4e01227bc2","state":"JOB_COMPLETED","type":"1 credential(s)/ tag(s)/ provider(s)/ device(s) added successfully","completion_time":"1733908308","creation_time":"1733908308","created_by":"admin","impacted":["test"]},"$$ref":"#/definitions/robotapiRobotNodeJob"},"title":"creation time based sorted list of RobotNodeJob"},"total_count":{"type":"integer","format":"int32","title":"Number of total jobs available at present"}},"example":{"jobs":[{"job_id":"72f5e589-efe0-4e90-b77e-be80556e03f8","state":"JOB_COMPLETED_WITH_WARNING","type":"2 device(s) added/edited successfully via csv upload (Completed with warnings)","error":"Node 010609ce-7e53-4fb2-b777-23fd4b24f958 is not attached to CDG, Admin State moved to down","completion_time":"1733909074","creation_time":"1733909074","created_by":"admin","impacted":["010609ce-7e53-4fb2-b777-23fd4b24f958 device01 192.168.123.92","469ce5fe-d8f1-4862-8abe-f40cfe0300d6 device02 192.168.123.93"],"errors":["Node 010609ce-7e53-4fb2-b777-23fd4b24f958 is not attached to CDG, Admin State moved to down","Node 469ce5fe-d8f1-4862-8abe-f40cfe0300d6 is not attached to CDG, Admin State moved to down"]}],"total_count":1},"$$ref":"#/definitions/robotapiRobotNodeJobList"}},"default":{"description":"An unexpected error response.","schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"details":{"type":"array","items":{"type":"object","properties":{"type_url":{"type":"string"},"value":{"type":"string","format":"byte"}},"$$ref":"#/definitions/protobufAny"}}},"example":{"error":"string","code":0,"message":"string","details":[{"type_url":"string","value":"string"}]},"$$ref":"#/definitions/runtimeError"}}},"parameters":[{"name":"body","in":"body","description":"Read the Tags information request","required":true,"schema":{"type":"object","properties":{"job_id":{"type":"string","title":"job_id or State would be supported filter\ncreation_time would be used for offset and sorting"},"state":{"type":"string","enum":["JOB_INVALID","JOB_REJECTED","JOB_ACCEPTED","JOB_DB_UPDATED","JOB_NOTIFICATION_PUBLISHED","JOB_COMPLETED","JOB_FAILED","JOB_RUNNING","JOB_PARTIAL","JOB_COMPLETED_WITH_WARNING"],"default":"JOB_INVALID","title":"Result Job State","$$ref":"#/definitions/robotapiRobotJobState"},"creation_time":{"type":"string","format":"int64"},"limit":{"type":"integer","format":"int64","title":"Page size. Max limit 100 per req"},"filter":{"type":"object","properties":{"job_id":{"type":"string","title":"Job id"},"inst_id":{"type":"string","title":"Server instance identifier"},"state":{"title":"Current State of the Job","type":"string","enum":["JOB_INVALID","JOB_REJECTED","JOB_ACCEPTED","JOB_DB_UPDATED","JOB_NOTIFICATION_PUBLISHED","JOB_COMPLETED","JOB_FAILED","JOB_RUNNING","JOB_PARTIAL","JOB_COMPLETED_WITH_WARNING"],"default":"JOB_INVALID","$$ref":"#/definitions/robotapiRobotJobState"},"type":{"type":"string","title":"Job type. Debug purpose"},"error":{"type":"string","title":"If any error"},"completion_time":{"type":"string","format":"int64","title":"Remaining time to complete"},"creation_time":{"type":"string","format":"int64","title":"Job creation time in epoch seconds"},"created_by":{"type":"string","title":"User"},"impacted_count":{"type":"integer","format":"int64","title":"Impacted nodes/tags, provider or profiles"},"impacted":{"type":"array","items":{"type":"string"},"title":"Impacted elements list"},"errors":{"type":"array","items":{"type":"string"}}},"title":"Every Action related to Inventory will have a Job","example":{"job_id":"6315b69e-0646-4714-a855-7a4e01227bc2","state":"JOB_COMPLETED","type":"1 credential(s)/ tag(s)/ provider(s)/ device(s) added successfully","completion_time":"1733908308","creation_time":"1733908308","created_by":"admin","impacted":["test"]},"$$ref":"#/definitions/robotapiRobotNodeJob"},"filterData":{"type":"object","properties":{"SortBy":{"type":"string"},"PageSize":{"type":"integer","format":"int64"},"PageNum":{"type":"integer","format":"int64"},"Descending":{"type":"boolean"},"MatchCase":{"type":"boolean"},"Criteria":{"type":"string"}},"$$ref":"#/definitions/robotapiRobotFilterData"},"to_filter":{"type":"object","properties":{"job_id":{"type":"string","title":"Job id"},"inst_id":{"type":"string","title":"Server instance identifier"},"state":{"title":"Current State of the Job","type":"string","enum":["JOB_INVALID","JOB_REJECTED","JOB_ACCEPTED","JOB_DB_UPDATED","JOB_NOTIFICATION_PUBLISHED","JOB_COMPLETED","JOB_FAILED","JOB_RUNNING","JOB_PARTIAL","JOB_COMPLETED_WITH_WARNING"],"default":"JOB_INVALID","$$ref":"#/definitions/robotapiRobotJobState"},"type":{"type":"string","title":"Job type. Debug purpose"},"error":{"type":"string","title":"If any error"},"completion_time":{"type":"string","format":"int64","title":"Remaining time to complete"},"creation_time":{"type":"string","format":"int64","title":"Job creation time in epoch seconds"},"created_by":{"type":"string","title":"User"},"impacted_count":{"type":"integer","format":"int64","title":"Impacted nodes/tags, provider or profiles"},"impacted":{"type":"array","items":{"type":"string"},"title":"Impacted elements list"},"errors":{"type":"array","items":{"type":"string"}}},"title":"Every Action related to Inventory will have a Job","example":{"job_id":"6315b69e-0646-4714-a855-7a4e01227bc2","state":"JOB_COMPLETED","type":"1 credential(s)/ tag(s)/ provider(s)/ device(s) added successfully","completion_time":"1733908308","creation_time":"1733908308","created_by":"admin","impacted":["test"]},"$$ref":"#/definitions/robotapiRobotNodeJob"}},"$$ref":"#/definitions/robotapiRobotNodeJobGetReq"}}],"tags":["NodeDb"],"__originalOperationId":"NodeDb_GetJobs","consumes":["application/json"],"produces":["application/json"],"security":[{"bearerAuth":[]}],"method":"post","path":"/jobs/query"}}