Get Job With Runs - Crosswork Network Controller 7.1 APIs - Cisco DevNet

{"type":"api","title":"Get Job With Runs","meta":{"id":"/apps/pubhub/media/crosswork-network-controller-7-1/f445c17e25a1120e8fbde4bd413083d0fd88b2b3/54824bc0-ac6b-3139-b893-395e312ba651","info":{"title":"Device Configuration Backup Restore Jobs API","description":"Device Configuration Backup Restore Jobs 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-backup-restore-jobs-api-overview.md"}},"openapi":"3.1.0","servers":[{"url":"https://{server-ip}:30603/crosswork/config/v1","description":"Generated server url"}]},"spec":{"tags":["Device Backup & Restore API"],"operationId":"getJobWithRuns","parameters":[{"description":"Name of Job","name":"job_name","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"description":"JobRunFilterRequest","type":"object","properties":{"run_status_value":{"description":"Run Status Value List","type":"array","items":{"type":"integer","format":"int32"}},"run_status":{"description":"Run Status List","type":"array","items":{"type":"string","enum":["NOT_STARTED","SUCCESS","IN_PROGRESS","RUN_FAILED","PARTIAL","UNRECOGNIZED"]}},"run_id":{"description":"Run Id","type":"string"}},"$$ref":"#/components/schemas/JobRunFilterRequest"},"example":{}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"description":"ConfigBackupRestoreJobSummary","type":"object","properties":{"config_backup_restore_job":{"description":"ConfigBackupRestoreJob","type":"object","properties":{"job":{"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"},"params_count":{"description":"Params Count","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","format":"date-time","type":"string"},"last_run_at":{"description":"Last Run At","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","type":"object","properties":{"every_nhour":{"description":"Every N Hour","type":"integer","format":"int32"}},"$$ref":"#/components/schemas/HourlyTrigger"},"daily":{"description":"Daily","type":"object","properties":{"every_nday":{"description":"Every N Day","type":"integer","format":"int32"}},"$$ref":"#/components/schemas/DailyTrigger"},"weekly":{"description":"Weekly","type":"object","properties":{"days_of_week_count":{"description":"Days of Week Count","type":"integer","format":"int32"},"days_of_week":{"description":"Days of Week List","type":"array","properties":{"empty":{"description":"Empty","type":"boolean"}},"items":{"description":"Items","type":"string"}}},"$$ref":"#/components/schemas/WeeklyTrigger"},"monthly":{"description":"Monthly","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"},"device_count":{"description":"Device Count","type":"integer","format":"int32"}},"$$ref":"#/components/schemas/ConfigBackupRestoreJob"},"job_runs":{"description":"Job Runs","type":"object","properties":{"backup_job_run":{"description":"Backup Job Run List","type":"array","items":{"description":"BackupJobRun","type":"object","properties":{"start_at":{"description":"Start At","format":"date-time","type":"string"},"run_status_value":{"description":"Run Status Value","type":"integer","format":"int32"},"run_status":{"description":"Run Status","type":"string","enum":["NOT_STARTED","SUCCESS","IN_PROGRESS","RUN_FAILED","PARTIAL","UNRECOGNIZED"]},"job_name":{"description":"Job Name","type":"string"},"run_id":{"description":"Run Id","type":"string"},"duration":{"description":"Duration","type":"integer","format":"int64"}},"$$ref":"#/components/schemas/BackupJobRun"}},"backup_job_run_count":{"description":"Backup Job Run Count","type":"integer","format":"int32"}},"$$ref":"#/components/schemas/BackupJobRunList"}},"$$ref":"#/components/schemas/ConfigBackupRestoreJobSummary"},"example":{"config_backup_restore_job":{"job":{"name":"bkup","task":"com.cisco.ems.config.service.ConfigBackupJob","schedule":{},"params":{},"status":"COMPLETED","last_run_at":"2025-02-12T14:48:21.001Z","next_run_at":"1970-01-01T00:00:00Z","last_run_status":"NOT_STARTED","job_type":"BACKUP","duration":1007,"percentage_completed":0,"created_by":"admin","run_count":0},"device_count":1},"job_runs":{"backup_job_run":[{"run_id":"e79bb231-3b4d-425e-940e-e229a526f06b","job_name":"bkup","run_status":"NOT_STARTED","start_at":"2025-02-12T14:48:21.001Z","duration":"1007"}]}}}}},"403":{"description":"Forbidden. The server recognizes the authentication credentials, but the client is not authorized to perform this request."}},"method":"post","path":"/config-backup-job/{job_name}"}}