Create - Crosswork Network Controller 7.2 APIs

{"type":"api","title":"Create","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":["Application Type"],"summary":"Create","description":"Create an application type.","operationId":"createAppType","parameters":[{"name":"X-Correlation-ID","in":"header","description":"Unique correlation id","schema":{"type":"string"}}],"requestBody":{"description":"Application Type","content":{"application/json":{"schema":{"required":["app","mopExecScope","stages"],"type":"object","properties":{"app":{"maxLength":64,"type":"string","description":"Name of the application type.","format":"^[a-zA-Z][a-zA-Z0-9\\s_-]*$","example":"Fleet Upgrade"},"description":{"type":"string","description":"Description of the application type.","example":"Application type for fleet upgrade"},"deviceLabels":{"type":"array","description":"List of device labels associated with the application type.","example":["source","target"],"items":{"type":"string","format":"^[a-zA-Z][a-zA-Z0-9_-]*$"}},"isScopeCrossSeries":{"type":"boolean","description":"Flag to indicate if the MOP execution scope is across product series.","example":true},"jobFormId":{"type":"string","description":"Form ID of the application type job input.","example":"cwm.form.fleetUpgrade"},"jobSchema":{"type":"object","additionalProperties":{"type":"string"},"description":"Job schema of the application type job input.","example":{"type":"object"}},"mopExecScope":{"type":"integer","description":"MOP execution scope for the application type, i.e., 1: per device or 2: multiple devices.","example":2},"products":{"type":"array","description":"List of vendors associated with the application type.","items":{"required":["productSeries"],"type":"object","properties":{"productSeries":{"type":"array","description":"Product series.","example":["Cisco 8000 Series Routers","Cisco Network Convergence System 5500 Series"],"items":{"type":"string"}},"vendor":{"type":"string","description":"Vendor name.","example":"Cisco Systems"}},"description":"Product model.","$$ref":"#/components/schemas/mop.Product"}},"stages":{"minItems":1,"type":"array","description":"List of stages associated with the application type.","items":{"required":["orderIndex","stage"],"type":"object","properties":{"orderIndex":{"minimum":1,"type":"integer","description":"Ordering index of the stage.","example":1},"stage":{"maxLength":64,"type":"string","description":"Name of the stage.","format":"^[a-zA-Z][a-zA-Z0-9_-]*$","example":"pre"}},"description":"Application type stage model.","$$ref":"#/components/schemas/mop.Stage"}}},"description":"Application type create model.","$$ref":"#/components/schemas/mop.AppTypeCreate"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"HTTP status code.","example":200},"key":{"type":"string","description":"Object key."},"message":{"type":"string","description":"Message of the response.","example":"Success message"},"status":{"type":"string","description":"Status of the response.","example":"Success"}},"description":"SuccessResponse model.","$$ref":"#/components/schemas/mop.SuccessResponse"}}}},"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/mop.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/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"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"HTTP status code.","example":406},"message":{"type":"string","description":"Message of the response.","example":"Not acceptable error message"},"status":{"type":"string","description":"Status of the response.","example":"Failed"}},"description":"NotAcceptableResponse model.","$$ref":"#/components/schemas/mop.NotAcceptableResponse"}}}},"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":"createAppType","method":"post","path":"/appTypes"}}