{"type":"api","title":"Patch a Mop execution job","meta":{"id":"/apps/pubhub/media/crosswork-network-controller-7-1/f445c17e25a1120e8fbde4bd413083d0fd88b2b3/c0404d8d-ff8e-36e9-bb59-ee336d247534","info":{"title":"Crosswork Change Automation API","version":"7.1.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"},"description":"A web server dedicated to RESTful queries into the Crosswork Change Automation application."},"x-parser-conf":{"overview":{"markdownPath":"reference/CAHI/change_automation.overview.md"}},"openapi":"3.1.0","servers":[{"url":"https://{server_ip}:30603/crosswork/nca/v1","description":"Generated server url"}]},"spec":{"summary":"Patch a Mop execution job.","operationId":"NCA_PatchMopJob","tags":["NCA"],"requestBody":{"description":"Argument to Patch a Mop Job Execution","required":true,"content":{"application/json":{"schema":{"type":"object","description":"Change Automation Mop Job Update Request","properties":{"execution_id":{"type":"string","description":"Execution ID of the mopjob being patched."},"task_id":{"type":"integer","format":"int64","description":"Task ID with of the task within the execution instance which is being\npatched."},"op":{"title":"Type of patch operation","type":"string","enum":["OP_UNKNOWN","OP_ROLLBACK","OP_RESUME","OP_ABORT","OP_PAUSE"],"default":"OP_UNKNOWN","description":"Mop Job Update Req Op Type","$$ref":"#/components/schemas/MopJobUpdateReqOpType"},"rollback_to_task":{"type":"integer","format":"int64","title":"Parameter for rollback operation","description":"Parameter for rollback operation"},"run_params":{"type":"string","title":"Parameter for run operation","description":"Parameter for run operation"},"submitter":{"type":"string","description":"The user who submitted the request."}},"$$ref":"#/components/schemas/change_automationMopJobUpdateReq"},"example":{"mop_id":"router_check_accessibility","devices":{"ids":[]},"check_start_time":0,"exec_start_time":0,"wae_threshold":"90","name":"test-run","tags":[],"device_user":"","device_pass":"","execution_params":{"1":{},"2":{}},"execution_policy":{"execution_strategy":"STRATEGY_CONTINUOUS","on_failure":"ON_FAILURE_ABORT","collect_syslog":false,"timeout":"600s"}}}}},"responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"type":"object","description":"Change Automation Mop Job Update Response","properties":{"status":{"title":"Status of the patch request. The status only reflects whether the request\nwas accepted or rejected based on the input params","description":"Status of the patch request. The status only reflects whether the request\nwas accepted or rejected based on the input params","type":"string","enum":["STATUS_UNKNOWN","STATUS_ACCEPTED","STATUS_DECLINED"],"default":"STATUS_UNKNOWN","$$ref":"#/components/schemas/change_automationRequestStatus"},"message":{"type":"string","title":"In case of request getting rejected, message field provides more details","description":"In case of request getting rejected, message field provides more details"}},"example":{"status":"STATUS_ACCEPTED","message":"OK"},"$$ref":"#/components/schemas/change_automationMopJobUpdateResp"}}}},"400":{"description":"Bad Request. The request is malformed in some way and the server cannot process it.","content":{"application/json":{"schema":{"type":"object","description":"Change Automation Error 400","required":["code","severity","message"],"properties":{"code":{"type":"string","description":"HTTP return code","example":"400"},"severity":{"type":"string","description":"Error severity level","enum":["Critical","Warning","Fatal"]},"message":{"type":"string","description":"Error message","example":"top level error string"},"data":{"type":"string","description":"Details of the error","example":"detailed description of the error"}},"example":{"code":"400","severity":"Critical","message":"error message","data":"detailed description of the error"},"$$ref":"#/components/schemas/change_automationError400"}}}},"500":{"description":"Internal Server Error. The server could not fulfill the request.","content":{"application/json":{"schema":{"type":"object","description":"Change Automation Error 500","required":["code","severity","message"],"properties":{"code":{"type":"string","description":"HTTP return code","example":"500"},"severity":{"type":"string","description":"Error severity level","enum":["Critical","Warning","Fatal"]},"message":{"type":"string","description":"Error message","example":"top level error string"},"data":{"type":"string","description":"Error detailed description"}},"example":{"code":"500","severity":"Critical","message":"error message","data":"Server Error. detailed description of the error"},"$$ref":"#/components/schemas/change_automationError500"}}}}},"method":"patch","path":"/mopjobs"}}