{"type":"model","meta":{"id":"/apps/pubhub/media/crosswork-network-controller-7-2/76fd4bb9d069fd2530d7a02f0b3a4ca00eccfd35/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.2.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":{"required":["app","mopId","mopName","name"],"type":"object","properties":{"app":{"type":"string","description":"Application name","example":"Device Migration"},"batchSize":{"type":"integer","description":"Batch size for the MOP execution","example":10},"data":{"type":"object","description":"MOP execution data","example":{}},"deviceGrp":{"type":"array","description":"Device group to execute the MOP","items":{"type":"string","description":"Device group name"},"example":["xrv-edge-group"]},"errorBudget":{"type":"integer","description":"Error budget for the MOP execution","example":2},"mopId":{"type":"integer","description":"MOP ID","example":6},"mopName":{"type":"string","description":"MOP name","example":"xrv-migration-mop"},"name":{"type":"string","description":"Name of the MOP execution job","example":"scheduled-xrv-device-migration"},"productSeries":{"type":"string","description":"Device product series","example":"Cisco XRv 9000 Series Virtual Routers"},"resource":{"type":"array","description":"List of device UUIDs for per-device or fleet-wide execution. MUTUALLY EXCLUSIVE with 'resourceWithLabels' - use only one.","items":{"type":"string","description":"Device UUID"}},"resourceWithLabels":{"type":"object","description":"Map of device UUID to user-defined label for resource identification. MUTUALLY EXCLUSIVE with 'resource' - use only one.","additionalProperties":{"type":"string"},"example":{"3e523496-6c32-4c2a-86a7-a5f5d6256b4a":"source","7b6e9638-d374-43ce-8de7-5322ceeab098":"neighbor","a4d86e4b-5464-4703-a4c6-295bbc8acf3f":"target"}},"executionModel":{"type":"integer","description":"Execution model determined by MOP service - 1 = per-device, 2 = fleet-wide","readOnly":true,"example":2},"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"},"example":[{"dayOfMonth":[{"start":13,"end":0,"step":0}],"month":[{"start":11,"end":0,"step":0}],"year":[{"start":2025,"end":0,"step":0}],"hour":[{"start":3,"end":0,"step":0}],"minute":[{"start":4,"end":0,"step":0}],"second":[{"start":0,"end":0,"step":0}]}]},"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"},"example":[{"every":3600,"offset":0}]},"scheduleByStage":{"type":"array","description":"List of schedule by stage specifications","items":{"type":"object","description":"A structure to hold the schedule by stage details","properties":{"stageName":{"type":"string","description":"Name of the stage"},"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"}},"$$ref":"#/components/schemas/ScheduleByStageSpec"},"example":[{"stageName":"upgrade-stage-1"}]},"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"},"example":["xr-upgrade"]},"vendor":{"type":"string","description":"Device vendor","example":"Cisco Systems"}},"description":"A structure to hold the MOP execution details. Supports dual execution models (per-device and fleet-wide). CRITICAL: 'resource' and 'resourceWithLabels' are mutually exclusive - you must provide exactly one of them, never both. Use 'resource' for device UUIDs or 'resourceWithLabels' for device UUID to label mapping, but not both in the same request.","$$ref":"#/components/schemas/MOPExecution","title":"MOPExecution"}}