{"type":"api","title":"Get All Jobs","meta":{"id":"/apps/pubhub/media/crosswork-network-controller-7-1/f445c17e25a1120e8fbde4bd413083d0fd88b2b3/773d8c2d-0de2-3906-8d3f-8a19d6895750","info":{"title":"Crosswork Workflow Manager Solutions - Automations","description":"The automation service acts as an orchestrator, handling the scheduling, execution,\nbatch processing, and monitoring of MOPs and their activities. The API provides endpoints for managing these operations.","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"},"version":"7.1.0"},"x-parser-conf":{"overview":{"markdownPath":"reference/CWM-SOLUTIONS/automations-api.overview.md"}},"openapi":"3.0.1","servers":[{"url":"https://crosswork-ip:30603/crosswork/cwms/automations/v1"}]},"spec":{"tags":["MOP Jobs"],"summary":"Get All Jobs","description":"Get summary of all the jobs in a paginated format.","operationId":"getAllJobs","parameters":[{"name":"page_number","in":"query","description":"page_number value","required":true,"schema":{"type":"integer"}},{"name":"page_size","in":"query","description":"page_size value","required":true,"schema":{"type":"integer"}},{"name":"jobresults","in":"query","description":"jobresults value","schema":{"type":"string"}},{"name":"app","in":"query","description":"automation value","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns the list of jobs","content":{"application/json":{"schema":{"type":"object","description":"A structure to hold the list of jobs in pagenated format","properties":{"data":{"type":"object","description":"A structure to hold the list of jobs and a summary of the job results","properties":{"data":{"type":"array","description":"List of jobs","items":{"type":"object","description":"A structure to hold the job details","properties":{"app":{"type":"string","description":"Application name"},"describeURI":{"type":"string","description":"A downstream URI to retrieve job details"},"immutable":{"type":"boolean","description":"Flag to indicate if the job is in immutable state"},"jobId":{"type":"string","description":"Job ID"},"jobName":{"type":"string","description":"Job name"},"jobStatus":{"type":"string","description":"Job status enum of success, failure, running, schedule, cancelled, and pending"},"jobTags":{"type":"array","description":"List of tags associated with the job","items":{"type":"string","description":"Tag name"}},"mop":{"type":"string","description":"MOP name"},"resourceCount":{"type":"integer","description":"Number of resources associated with the job"},"startDateTime":{"type":"string","description":"Start date and time of the job"},"endDateTime":{"type":"string","description":"End date and time of the job"},"createdBy":{"type":"string","description":"User who created the job"}},"$$ref":"#/components/schemas/JobRowData"}},"jobResults":{"type":"object","description":"Summary of job results","additionalProperties":{"type":"integer"}}},"$$ref":"#/components/schemas/Jobs"},"pagination":{"type":"object","description":"A structure to hold the pagination details","properties":{"pageNumber":{"type":"integer","description":"Page number"},"pageSize":{"type":"integer","description":"Page size"},"total":{"type":"integer","description":"Total number of records"}},"$$ref":"#/components/schemas/Pagination"}},"$$ref":"#/components/schemas/AllJobsViewResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","description":"A structure to hold the standard response","properties":{"code":{"type":"integer","description":"HTTP status code"},"key":{"type":"string","description":"Key to retrieve the job details"},"message":{"type":"string","description":"Message"},"status":{"type":"string","description":"Status"},"statusInt":{"type":"integer","description":"Status integer"}},"$$ref":"#/components/schemas/StandardResponse"}}}},"406":{"description":"API requests are not acceptable at this time","content":{"application/json":{"schema":{"type":"object","description":"A structure to hold the standard response","properties":{"code":{"type":"integer","description":"HTTP status code"},"key":{"type":"string","description":"Key to retrieve the job details"},"message":{"type":"string","description":"Message"},"status":{"type":"string","description":"Status"},"statusInt":{"type":"integer","description":"Status integer"}},"$$ref":"#/components/schemas/StandardResponse"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"type":"object","description":"A structure to hold the standard response","properties":{"code":{"type":"integer","description":"HTTP status code"},"key":{"type":"string","description":"Key to retrieve the job details"},"message":{"type":"string","description":"Message"},"status":{"type":"string","description":"Status"},"statusInt":{"type":"integer","description":"Status integer"}},"$$ref":"#/components/schemas/StandardResponse"}}}}},"__originalOperationId":"getAllJobs","method":"get","path":"/status/job"}}