{"type":"api","title":"Retrieve optimization plan","meta":{"id":"/apps/pubhub/media/crosswork-network-controller-7-2/8d0f326b1067b50b7f5b2e9defa86c664d7d22b7/91f20e79-1f37-3a3b-be2f-e9eea61d870f","info":{"description":"This API provides operations for managing Segment Routing (SR) policies, retrieving optimization plans, and configuring notifications for SR policy paths.","version":"7.2.0","title":"Cisco Crosswork Optimization Engine Operations API","contact":{"name":"API Support","url":"https://www.cisco.com/support","email":"support@cisco.com"},"license":{"name":"Cisco Software License Agreement","url":"http://www.cisco.com/public/sw-license-agreement.html"}},"openapi":"3.0.1","servers":[{"url":"https://{server_ip}:30603/crosswork/nbi/optimization/v3/restconf","description":"COE base server url"}],"securitySchemes":{"api_key":{"description":"Authentication: Bearer $JWT","type":"apiKey","name":"api_key","in":"header"}}},"spec":{"operationId":"getPlan","tags":["cisco-crosswork-optimization-engine-operations"],"summary":"Retrieve optimization plan","description":"Fetches the optimization plan in the specified format and version.","requestBody":{"description":"Request body containing the format and version of the optimization plan.","required":false,"content":{"application/yang-data+json":{"schema":{"type":"object","properties":{"input":{"type":"object","properties":{"format":{"description":"Format of the output plan.","type":"string","enum":["pln","txt"],"$$ref":"#/components/schemas/operations.Format"},"version":{"type":"string","description":"Version of output plan.","default":"current"}},"$$ref":"#/components/schemas/operations.getplan.Input"}}}}}},"responses":{"200":{"description":"Correct response","content":{"application/yang-data+json":{"schema":{"type":"object","properties":{"output":{"type":"object","properties":{"message":{"type":"string","description":"The details of status above"},"status":{"description":"Enumeration of the request state","type":"string","enum":["error","accepted","rejected"],"$$ref":"#/components/schemas/common.RequestStatus"},"planfile-content":{"type":"string"}},"$$ref":"#/components/schemas/operations.getplan.Output"}}}}}},"204":{"description":"No response"},"400":{"description":"Internal error"}},"__originalOperationId":"getPlan","method":"post","path":"/operations/cisco-crosswork-optimization-engine-operations:get-plan"}}