{"type":"api","title":"Get Deployment Jobs","meta":{"id":"/apps/pubhub/media/crosswork-network-controller-7-1/f445c17e25a1120e8fbde4bd413083d0fd88b2b3/7d836703-14a3-32cb-ad8e-6816d26ee7c8","info":{"title":"Device Configuration Deployments API","description":"Device Configuration Deployments API","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/EMF/Device Configuration/device-config-deployments-api-overview.md"}},"openapi":"3.1.0","servers":[{"url":"https://{server-ip}:30603/crosswork/config/v1/templates","description":"Generated server url"}]},"spec":{"tags":["Template API"],"operationId":"getDeploymentJobs","requestBody":{"content":{"application/json":{"schema":{"description":"Job Filter Request","type":"object","properties":{"last_run_status_value":{"description":"Last Run Status Value List","type":"array","items":{"type":"integer","format":"int32"}},"status_value":{"description":"Status Value List","type":"array","items":{"type":"integer","format":"int32"}},"job_type":{"description":"Job Type List","type":"array","properties":{"empty":{"description":"Empty","type":"boolean"}},"items":{"type":"string"}},"created_by":{"description":"Created By","type":"string"},"last_run_status":{"description":"Last Run Status List","type":"array","items":{"type":"string","enum":["NOT_STARTED","SUCCESS","IN_PROGRESS","RUN_FAILED","PARTIAL","UNRECOGNIZED"]}},"status":{"description":"Status List","type":"array","items":{"type":"string","enum":["UNKNOWN","SCHEDULED","RUNNING","COMPLETED","PAUSED","BLOCKED","FAILED","UNRECOGNIZED"]}},"operation":{"description":"Operation","type":"string"},"frequency":{"description":"Frequency","type":"string"},"name":{"description":"Name","type":"string"},"duration":{"description":"Duration","type":"integer","format":"int32"}},"$$ref":"#/components/schemas/JobFilterRequest"},"example":{"last_run_status":["SUCCESS","IN_PROGRESS","RUN_FAILED","PARTIAL"]}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"description":"Job List","type":"object","properties":{"jobs":{"description":"Jobs List","type":"array","items":{"description":"Job","type":"object","properties":{"last_run_status_value":{"description":"Last Run Status Value","type":"integer","format":"int32"},"run_count":{"description":"Run Count","type":"integer","format":"int32"},"status_value":{"description":"Status Value","type":"integer","format":"int32"},"percentage_completed":{"description":"Percentage Completed","type":"integer","format":"int32"},"params":{"description":"Params","type":"object","additionalProperties":{"description":"Any","type":"object","properties":{"type_url":{"description":"Type Url","type":"string"},"value":{"description":"Value","type":"string"}},"$$ref":"#/components/schemas/Any"},"deprecated":true},"next_run_at":{"description":"Next Run At Time","format":"date-time","type":"string"},"last_run_at":{"description":"Last Run At Time","format":"date-time","type":"string"},"last_run_status":{"description":"Last Run Status","type":"string","enum":["NOT_STARTED","SUCCESS","IN_PROGRESS","RUN_FAILED","PARTIAL","UNRECOGNIZED"]},"job_type":{"description":"Job Type","type":"string"},"params_map":{"description":"Params Map","type":"object","additionalProperties":{"description":"Any","type":"object","properties":{"type_url":{"description":"Type Url","type":"string"},"value":{"description":"Value","type":"string"}},"$$ref":"#/components/schemas/Any"}},"created_by":{"description":"Created By","type":"string"},"status":{"description":"Status","type":"string","enum":["UNKNOWN","SCHEDULED","RUNNING","COMPLETED","PAUSED","BLOCKED","FAILED","UNRECOGNIZED"]},"schedule":{"description":"Schedule","type":"object","properties":{"start_now":{"description":"Start Now","type":"boolean"},"recurrence_case":{"description":"Recurrence Case","type":"string","enum":["HOURLY","DAILY","WEEKLY","MONTHLY","RECURRENCE_NOT_SET"]},"start_at_case":{"description":"Start At Case","type":"string","enum":["START_AT_TIME","START_NOW","STARTAT_NOT_SET"]},"start_at_time":{"description":"Start At Time","format":"date-time","type":"string"},"end_at_case":{"description":"End At Case","type":"string","enum":["END_AT_TIME","END_AFTER","ENDAT_NOT_SET"]},"end_after":{"description":"End After","type":"integer","format":"int32"},"end_at_time":{"description":"End At Time","format":"date-time","type":"string"},"hourly":{"description":"Hourly Trigger","type":"object","properties":{"every_nhour":{"description":"Every N Hour","type":"integer","format":"int32"}},"$$ref":"#/components/schemas/HourlyTrigger"},"daily":{"description":"Daily Trigger","type":"object","properties":{"every_nday":{"description":"Every N Day","type":"integer","format":"int32"}},"$$ref":"#/components/schemas/DailyTrigger"},"weekly":{"description":"Weekly Trigger","type":"object","properties":{"days_of_week":{"description":"Days Of Week List","type":"array","properties":{"empty":{"description":"Empty","type":"boolean"}},"items":{"type":"string"}}},"$$ref":"#/components/schemas/WeeklyTrigger"},"monthly":{"description":"Monthly Trigger","type":"object","properties":{"every_nmonth":{"description":"Every N Month","type":"integer","format":"int32"}},"$$ref":"#/components/schemas/MonthlyTrigger"}},"$$ref":"#/components/schemas/JobSchedule"},"name":{"description":"Name","type":"string"},"duration":{"description":"Duration","type":"integer","format":"int32"},"task":{"description":"Task","type":"string"}},"$$ref":"#/components/schemas/Job"}}},"$$ref":"#/components/schemas/JobList"},"example":{"jobs":[{"name":"d-template-name-sanity_DeployJob_2025-02-21_07:05:05","task":"com.cisco.ems.config.service.TemplateJob","params":{},"status":"COMPLETED","last_run_at":"2025-02-21T07:05:11.321Z","last_run_status":"RUN_FAILED","job_type":"DEPLOYMENT","duration":188,"percentage_completed":0,"created_by":"admin","run_count":0},{"name":"d-loopback-1_DeployJob_2025-02-17_07:06:57","task":"com.cisco.ems.config.service.TemplateJob","params":{},"status":"COMPLETED","last_run_at":"2025-02-17T07:07:02.855Z","last_run_status":"IN_PROGRESS","job_type":"DEPLOYMENT","duration":0,"percentage_completed":0,"created_by":"admin","run_count":0}]}}}},"403":{"description":"Forbidden. The server recognizes the authentication credentials, but the client is not authorized to perform this request."}},"method":"post","path":"/jobs/deployments/query"}}