Abort MoP job(s) or job set(s) - Crosswork Network Controller 7.1 APIs

{"type":"api","title":"Abort MoP job(s) or job set(s)","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":"Abort MoP job(s) or job set(s)","operationId":"NCA_PostMopJobsAbort","tags":["NCA"],"requestBody":{"description":"Argument passed to abort the MopJob(s)","required":true,"content":{"application/json":{"schema":{"type":"object","description":"Change Automation Mop Jobs Abort Request","properties":{"stabilize":{"type":"boolean","title":"Denotes if orchestrator is supposed to wait for the system to reach a\nstable state before ending execution. This flag will denote if the mopjobs\nare terminated with STOP signal or KILL signal. Currently the abort\noperation waits until the end of current operation","description":"Denotes if orchestrator is supposed to wait for the system to reach a\nstable state before ending execution. This flag will denote if the mopjobs\nare terminated with STOP signal or KILL signal. Currently the abort\noperation waits until the end of current operation"},"execution_ids":{"type":"array","items":{"type":"string"},"description":"A list of execution IDs that the user wishes to abort."},"set_ids":{"type":"array","items":{"type":"string"},"description":"A list of job set IDs that the user wishes to abort."},"submitter":{"type":"string","description":"The user who submitted the request."}},"$$ref":"#/components/schemas/change_automationMopJobsAbortReq"},"example":{"execution_ids":["123456789"]}}}},"responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"type":"object","description":"Change Automation Mop Jobs Abort Response","properties":{"results":{"type":"array","items":{"type":"object","description":"Change Automation Abort Response","properties":{"execution_id":{"type":"string","description":"Execution ID of the MoP job for which abort request was processed."},"status":{"description":"Status of the abort request. The status only reflects whether the request\nwas accepted or rejected. Even if a request is ACCEPTED, the abort request\nmight not get processed if the mop has run to completion before a chance to\nprocess the request.","type":"string","enum":["STATUS_UNKNOWN","STATUS_ACCEPTED","STATUS_DECLINED"],"default":"STATUS_UNKNOWN","$$ref":"#/components/schemas/change_automationRequestStatus"},"message":{"type":"string","description":"In case of request getting rejected, message field provides more details."}},"$$ref":"#/components/schemas/change_automationAbortResp"},"description":"List of results corresponding to all the jobs requested for abortion."}},"example":{"results":[{"execution_id":"1687426280907-75acbf9b-044b-44fe-bc5f-7b9cf107b825","status":"STATUS_ACCEPTED","message":"Abort request accepted for job ID: 1687426280907-75acbf9b-044b-44fe-bc5f-7b9cf107b825"}]},"$$ref":"#/components/schemas/change_automationMopJobsAbortResp"}}}},"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":"post","path":"/mopjobs/abort"}}