{"type":"api","title":"Details","meta":{"id":"/apps/pubhub/media/crosswork-network-controller-7-1/f445c17e25a1120e8fbde4bd413083d0fd88b2b3/86ecd438-8734-3f16-a735-542a35795cd3","info":{"title":"Crosswork Workflow Manager Solutions - MOP","description":"MOP component enables users to assemble pre and post checks based on the use case, known as mop profiles, and attach to device upgrade/smu upg activities such as fleet-upgrade.\nMOP also supports CRUD operations on MOP profiles and includes filters for browsing created MOPs.","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/mop-api.overview.md"}},"openapi":"3.0.1","servers":[{"url":"https://crosswork-ip:30603/crosswork/cwms/mop/v1"}],"securitySchemes":{"Bearer":{"type":"apiKey","description":"Type \"Bearer\" followed by a space and JWT token.","name":"Authorization","in":"header"}}},"spec":{"tags":["MOP"],"summary":"Details","description":"Get details of a MOP.","operationId":"getMopDetails","parameters":[{"name":"id","in":"path","description":"MOP id","required":true,"schema":{"type":"integer"}},{"name":"X-Correlation-ID","in":"header","description":"Unique correlation id","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"required":["app","name","productSeries","tags","vendor"],"type":"object","properties":{"actions":{"type":"array","description":"List of actions for the MOP.","items":{"required":["name","position","stage","wfName","wfVersion"],"type":"object","properties":{"data":{"type":"object","additionalProperties":{"type":"string"},"description":"Input to be passed to the selected action (workflow).","example":{"cmd":"show install activate summary"}},"ignoreFailure":{"type":"boolean","description":"Flag to indicate if the selected action should be ignored on failure and continue with other action execution during MOP execution.","example":false},"invalid":{"type":"boolean","description":"Flag to indicate if the action is invalid (associated with a workflow which is either not present or changed in cwm).","example":false},"name":{"maxLength":64,"type":"string","description":"Name of the selected action.","format":"^[a-zA-Z][a-zA-Z0-9\\s_-]*$","example":"package summary"},"phase":{"maxLength":64,"type":"string","description":"Phase of the selected action.","format":"^[a-zA-Z][a-zA-Z0-9_-]*$","example":"rollback"},"position":{"maximum":255,"minimum":1,"type":"integer","description":"Position (order of execution within a stage) of the selected action in the MOP.","example":1},"stage":{"maxLength":64,"type":"string","description":"Stage of the selected action.","format":"^[a-zA-Z][a-zA-Z0-9_-]*$","example":"post"},"uses":{"type":"array","description":"List of selected actions output on which this selected action is dependent on.","items":{"required":["depActionName"],"type":"object","properties":{"depActionName":{"maxLength":64,"type":"string","description":"Name of the selected action on which other selected actions are dependent on.","format":"^[a-zA-Z][a-zA-Z0-9\\s_-]*$","example":"package summary"},"depActionStage":{"maxLength":64,"type":"string","description":"Stage of the selected action on which other selected actions are dependent on.","format":"^[a-zA-Z][a-zA-Z0-9_-]*$","example":"pre"}},"description":"Dependent action model.","$$ref":"#/components/schemas/DependentAction"}},"wfName":{"type":"string","description":"Workflow name associated with the selected action.","example":"package summary check"},"wfVersion":{"maxLength":32,"type":"string","description":"Workflow version associated with the selected action.","example":"1.0.0"}},"description":"Selected action view model.","$$ref":"#/components/schemas/SelectedActionView"}},"app":{"type":"string","description":"Application group name.","example":"Fleet Upgrade"},"createdBy":{"type":"string","description":"User who create/update the MOP.","example":"admin"},"degraded":{"type":"boolean","description":"Flag to indicate if the MOP is degraded. (one or more actions are invalid).","example":false},"name":{"maxLength":64,"type":"string","description":"Name of the MOP.","format":"^[a-zA-Z][a-zA-Z0-9\\s_-]*$","example":"IOSXR Upgrade"},"productSeries":{"type":"string","description":"Product series.","example":"Cisco 8000 Series Routers"},"tags":{"minItems":1,"type":"array","description":"Tags associated with the MOP.","example":["cisco","iosxr"],"items":{"type":"string","format":"^[a-zA-Z][a-zA-Z0-9_-]*$"}},"vendor":{"type":"string","description":"Product vendor name.","example":"Cisco Systems"},"wfName":{"type":"string","description":"Name of the MOP wrapper workflow.","example":"mop-IOSXR Upgrade-1"},"wfVersion":{"type":"string","description":"Version of the MOP wrapper workflow.","example":"1.0.0"}},"description":"MOP view model.","$$ref":"#/components/schemas/MopView"}}}},"204":{"description":"No Content","content":{}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"HTTP status code.","example":400},"message":{"type":"string","description":"Message of the response.","example":"Bad request error message"},"status":{"type":"string","description":"Status of the response.","example":"Failed"}},"description":"BadRequestResponse model.","$$ref":"#/components/schemas/BadRequestResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Error message.","example":"Key not authorized: token has expired"}},"description":"FailureInfraResponse model.","$$ref":"#/components/schemas/FailureInfraResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Error message.","example":"Key not authorized: token has expired"}},"description":"FailureInfraResponse model.","$$ref":"#/components/schemas/FailureInfraResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"HTTP status code.","example":500},"message":{"type":"string","description":"Message of the response.","example":"Internal server error message"},"status":{"type":"string","description":"Status of the response.","example":"Failed"}},"description":"InternalErrorResponse model.","$$ref":"#/components/schemas/InternalErrorResponse"}}}}},"security":[{"Bearer":[]}],"__originalOperationId":"getMopDetails","method":"get","path":"/mops/{id}"}}