{"type":"api","title":"MOP summary & filter","meta":{"id":"/apps/pubhub/media/crosswork-network-controller-7-2/76fd4bb9d069fd2530d7a02f0b3a4ca00eccfd35/86ecd438-8734-3f16-a735-542a35795cd3","info":{"title":"Crosswork Workflow Manager Solutions - MOP","description":"The MOP (Method of Procedure) service provides a flexible framework for orchestrating network maintenance activities through reusable workflow components.\n\nApplication type represents a specific use case with mop execution startegy and are associated with products.\n\nMOP Actions are reusable CWM workflows that perform specific tasks during maintenance operations at different stages.\n\nMOPs (MOP Profiles) are complete maintenance procedures assembled from multiple actions. MOPs provide:\n- Ordered execution of actions across maintenance stages\n- Reusability across similar maintenance scenarios\n- Consistent operational procedures\n- Integration with Crosswork maintenance activities\n\nThis service enables network operators to build, manage, and execute standardized maintenance procedures while maintaining flexibility for custom workflows and device-specific requirements.","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/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":"MOP summary & filter","description":"Filter MOP summary with pagination information.","operationId":"getMopSummaryList","parameters":[{"name":"X-Correlation-ID","in":"header","description":"Unique correlation id","schema":{"type":"string"}}],"requestBody":{"description":"MOP Summary Query","content":{"application/json":{"schema":{"required":["pagination","productSeries"],"type":"object","properties":{"app":{"type":"string","description":"Application group name.","example":"Fleet Upgrade"},"pagination":{"required":["pageNumber","pageSize"],"type":"object","properties":{"pageNumber":{"type":"integer","description":"Current page number."},"pageSize":{"type":"integer","description":"Number of items per page."}},"description":"Pagination details.","$$ref":"#/components/schemas/mop.PageQuery"},"productSeries":{"type":"array","description":"Product series.","example":["Cisco 8000 Series Routers","Cisco Network Convergence System 5500 Series"],"items":{"type":"string"}},"search":{"type":"string","description":"Search keyword.","example":"iosxr"},"vendor":{"type":"string","description":"Vendor name.","example":"Cisco Systems"}},"description":"MOP summary query model.","$$ref":"#/components/schemas/mop.MopSummaryQuery"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","description":"List of MOP summaries.","items":{"required":["name","productSeries","tags"],"type":"object","properties":{"actionCount":{"type":"integer","description":"Number of actions in the MOP.","example":2},"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},"id":{"type":"integer","description":"MOP ID.","example":1},"name":{"maxLength":64,"type":"string","description":"Name of the MOP.","format":"^[a-zA-Z][a-zA-Z0-9\\s_-]*$","example":"IOSXR Upgrade"},"productSeries":{"type":"array","description":"Product series.","example":["Cisco 8000 Series Routers","Cisco Network Convergence System 5500 Series"],"items":{"type":"string"}},"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":"Vendor name.","example":"Cisco Systems"}},"description":"MOP summary model.","$$ref":"#/components/schemas/mop.MopSummary"}},"pagination":{"type":"object","properties":{"pageNumber":{"type":"integer","description":"Current page number.","example":1},"pageSize":{"type":"integer","description":"Number of items per page.","example":10},"total":{"type":"integer","description":"Total number of items.","example":30}},"description":"Pagination details.","$$ref":"#/components/schemas/mop.Pagination"}},"description":"MOP summary list model.","$$ref":"#/components/schemas/mop.MopSummaryList"}}}},"204":{"description":"No Content","content":{}},"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/mop.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/mop.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/mop.InternalErrorResponse"}}}}},"security":[{"Bearer":[]}],"x-codegen-request-body-name":"request","__originalOperationId":"getMopSummaryList","method":"post","path":"/summary"}}