{"type":"api","title":"MOP summary & filter","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":"MOP summary & filter","description":"Get MOP summary with pagination information.\nFilter MOP summary with pagination information.","operationId":"getMopSummaryList","parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":true,"schema":{"minimum":1,"type":"integer"}},{"name":"pageSize","in":"query","description":"Items per page","required":true,"schema":{"minimum":1,"type":"integer"}},{"name":"vendor","in":"query","description":"Vendor name","schema":{"type":"string"}},{"name":"productSeries","in":"query","description":"Product series","schema":{"type":"string"}},{"name":"app","in":"query","description":"Application group","schema":{"type":"string"}},{"name":"tags","in":"query","description":"Comma separated MOP tags","schema":{"type":"string"}},{"name":"X-Correlation-ID","in":"header","description":"Unique correlation id","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","description":"List of MOP summaries.","items":{"required":["app","name","productSeries","tags","vendor"],"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":"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"}},"description":"MOP summary model.","$$ref":"#/components/schemas/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/Pagination"}},"description":"MOP summary list model.","$$ref":"#/components/schemas/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/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":"getMopSummaryList","method":"get","path":"/mops"}}