{"type":"api","title":"Update MOP Execution","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 Executor"],"summary":"Update MOP Execution","description":"This API is used to update the execution of a Method of Procedure (MOP) for a given set of resources.","operationId":"updateMopExecution","parameters":[{"name":"id","in":"path","description":"Job ID","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"MOP execution instance details","content":{"application/json":{"schema":{"required":["app","mopId","mopName","name","resource"],"type":"object","properties":{"app":{"type":"string","description":"Application name"},"batchSize":{"type":"integer","description":"Batch size for the MOP execution"},"data":{"type":"object","description":"MOP execution data"},"deviceGrp":{"type":"array","description":"Device group to execute the MOP","items":{"type":"string","description":"Device group name"}},"errorBudget":{"type":"integer","description":"Error budget for the MOP execution"},"mopId":{"type":"integer","description":"MOP ID"},"mopName":{"type":"string","description":"MOP name"},"name":{"type":"string","description":"Name of the MOP execution job"},"productSeries":{"type":"string","description":"Device product series"},"resource":{"type":"array","description":"List of resources to execute","items":{"type":"string","description":"Resource name"}},"scheduleCalendars":{"type":"array","description":"List of schedule calendars","items":{"type":"object","description":"A structure to hold the schedule calendar details","properties":{"dayOfMonth":{"type":"array","description":"DayOfMonth range to match (1-31)\n\ndefault: matches all days","items":{"type":"object","description":"A structure to hold the schedule range details","properties":{"end":{"type":"integer","description":"End of the range (inclusive)\nOptional: defaulted to Start"},"start":{"type":"integer","description":"Start of the range (inclusive)"},"step":{"type":"integer","description":"Step to be take between each value\nOptional: defaulted to 1"}},"$$ref":"#/components/schemas/ScheduleRange"}},"dayOfWeek":{"type":"array","description":"DayOfWeek range to match (0-6; 0 is Sunday)\n\ndefault: matches all days of the week","items":{"type":"object","description":"A structure to hold the schedule range details","properties":{"end":{"type":"integer","description":"End of the range (inclusive)\nOptional: defaulted to Start"},"start":{"type":"integer","description":"Start of the range (inclusive)"},"step":{"type":"integer","description":"Step to be take between each value\nOptional: defaulted to 1"}},"$$ref":"#/components/schemas/ScheduleRange"}},"hour":{"type":"array","description":"Hour range to match (0-23).\n\ndefault: matches 0","items":{"type":"object","description":"A structure to hold the schedule range details","properties":{"end":{"type":"integer","description":"End of the range (inclusive)\nOptional: defaulted to Start"},"start":{"type":"integer","description":"Start of the range (inclusive)"},"step":{"type":"integer","description":"Step to be take between each value\nOptional: defaulted to 1"}},"$$ref":"#/components/schemas/ScheduleRange"}},"minute":{"type":"array","description":"Minute range to match (0-59).\n\ndefault: matches 0","items":{"type":"object","description":"A structure to hold the schedule range details","properties":{"end":{"type":"integer","description":"End of the range (inclusive)\nOptional: defaulted to Start"},"start":{"type":"integer","description":"Start of the range (inclusive)"},"step":{"type":"integer","description":"Step to be take between each value\nOptional: defaulted to 1"}},"$$ref":"#/components/schemas/ScheduleRange"}},"month":{"type":"array","description":"Month range to match (1-12)\n\ndefault: matches all months","items":{"type":"object","description":"A structure to hold the schedule range details","properties":{"end":{"type":"integer","description":"End of the range (inclusive)\nOptional: defaulted to Start"},"start":{"type":"integer","description":"Start of the range (inclusive)"},"step":{"type":"integer","description":"Step to be take between each value\nOptional: defaulted to 1"}},"$$ref":"#/components/schemas/ScheduleRange"}},"second":{"type":"array","description":"Second range to match (0-59).\n\ndefault: matches 0","items":{"type":"object","description":"A structure to hold the schedule range details","properties":{"end":{"type":"integer","description":"End of the range (inclusive)\nOptional: defaulted to Start"},"start":{"type":"integer","description":"Start of the range (inclusive)"},"step":{"type":"integer","description":"Step to be take between each value\nOptional: defaulted to 1"}},"$$ref":"#/components/schemas/ScheduleRange"}},"year":{"type":"array","description":"Year range to match.\n\ndefault: empty that matches all years","items":{"type":"object","description":"A structure to hold the schedule range details","properties":{"end":{"type":"integer","description":"End of the range (inclusive)\nOptional: defaulted to Start"},"start":{"type":"integer","description":"Start of the range (inclusive)"},"step":{"type":"integer","description":"Step to be take between each value\nOptional: defaulted to 1"}},"$$ref":"#/components/schemas/ScheduleRange"}}},"$$ref":"#/components/schemas/ScheduleCalendarSpec"}},"intervals":{"type":"array","description":"List of schedule intervals","items":{"type":"object","properties":{"every":{"description":"Every - describes the period to repeat the interval.","type":"integer","example":3600},"offset":{"description":"Offset - is a fixed offset added to the intervals period.\nOptional: Defaulted to 0","type":"integer","example":0}},"$$ref":"#/components/schemas/ScheduleIntervalSpec"}},"timeZoneName":{"type":"string","description":"Time zone name","example":"America/Los_Angeles"},"tags":{"type":"array","description":"List of tags associated with the job","items":{"type":"string","description":"Tag name"}},"vendor":{"type":"string","description":"Device vendor"}},"description":"A structure to hold the MOP execution details","$$ref":"#/components/schemas/MOPExecution"}}},"required":true},"responses":{"202":{"description":"Returns the job ID","content":{"application/json":{"schema":{"type":"object","description":"A structure to hold the execute MOP response","properties":{"code":{"type":"integer","description":"HTTP status code"},"jobId":{"type":"integer","description":"Job ID"},"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/ExecuteMopResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","description":"A structure to hold the error details","properties":{"code":{"type":"integer","description":"HTTP status code"},"message":{"type":"string","description":"Error message"},"status":{"type":"string","description":"Status"},"statusInt":{"type":"integer","description":"Status integer"}},"$$ref":"#/components/schemas/AutomationsError"}}}},"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 error details","properties":{"code":{"type":"integer","description":"HTTP status code"},"message":{"type":"string","description":"Error message"},"status":{"type":"string","description":"Status"},"statusInt":{"type":"integer","description":"Status integer"}},"$$ref":"#/components/schemas/AutomationsError"}}}}},"x-codegen-request-body-name":"body","__originalOperationId":"updateMopExecution","method":"put","path":"/mop/{id}"}}