{"type":"api","title":"Get service plan details","meta":{"id":"/apps/pubhub/media/crosswork-network-controller-7-1/f445c17e25a1120e8fbde4bd413083d0fd88b2b3/c1291a25-ce7e-325c-9659-0646f41e1a52","info":{"title":"cat-inventory-rpc","description":"This module defines service inventory RPC operations for retrieving services details from CNC.","termsOfService":"http://www.cisco.com/web/siteassets/legal/terms_condition.html","contact":{"name":"Cisco Systems","url":"https://www.cisco.com","email":"support@cisco.com"},"license":{"name":"Cisco Software License Agreement","url":"http://www.cisco.com/public/sw-license-agreement.html"},"version":"7.1.0"},"security":[{"bearerAuth":[]}],"tags":[{"name":"operations","description":"service inventory operations"}],"x-parser-conf":{"overview":{"markdownPath":"reference/CNC/cat-inventory-rpc-api-overview.md"}},"openapi":"3.0.1","servers":[{"url":"https://{cnc-host}:{cnc-port}/crosswork/nbi/cat-inventory/v1/restconf","variables":{"cnc-host":{"default":"127.0.0.1","description":"host name or ip address of the target CNC Cluster"},"cnc-port":{"default":"30603","description":"port number of the target CNC Cluster"}}}],"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}}},"spec":{"tags":["operations","Since 1.0.0"],"summary":"Get service plan details","description":"this rpc returns the service plan status and creation time for\none or more service instances passed in the input","operationId":"operations_cat_inventory_rpc_get_service_plan_data_post","requestBody":{"description":"this rpc returns the service plan status and creation time for\none or more service instances passed in the input","content":{"application/yang-data+json":{"schema":{"type":"object","properties":{"cat-inventory-rpc:input":{"type":"object","properties":{"cat-inventory-rpc:get-service-plan-data-request":{"type":"object","properties":{"service-plan-yang-path":{"type":"array","items":{"type":"string","description":"yang path with key corresponding to the service plan that has\n the status details (leaf-list)","format":"string"},"x-yang":{"type":"leaf-list"}}},"description":"(non-presence)","x-yang":{"type":"container","is_presence":"false"}}}}},"$$ref":"#/components/schemas/operations_cat-inventory-rpc_get-service-plan-data-post-input"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/yang-data+json":{"schema":{"type":"object","properties":{"cat-inventory-rpc:output":{"type":"object","properties":{"cat-inventory-rpc:get-service-plan-data-response":{"type":"object","properties":{"service-plan-data":{"type":"array","description":"(list)","items":{"type":"object","properties":{"yang-path":{"type":"string","description":"yang path with key corresponding to the service plan (leaf)","format":"string","x-yang":{"type":"leaf"}},"status":{"type":"string","description":"status of the service deployment - unknown: no plan data available\n or has errors before the deployment reached to create plan data.\n completed: service deployment is successful on all phases. failed:\n one or more components have status not reached. in-progress: service\n deployment is in progress and there are no errors reported currently\n in the plan (leaf)","format":"enumeration","default":"unknown","enum":["unknown","completed","failed","in-progress","delete-in-progress"],"x-yang":{"type":"leaf"}},"error-info":{"type":"object","properties":{"message":{"type":"string","description":"An explanatory message for the failing plan. or plan does not\nexists (leaf)","format":"string","x-yang":{"type":"leaf"}}},"description":"(presence)","x-yang":{"type":"container","is_presence":"true"}},"creation-time":{"type":"string","description":"service creation time - this is the time reported in service\n plan data in self component's init state status (leaf)","format":"string","x-yang":{"type":"leaf"}},"last-updated-time":{"type":"string","description":"service last updated time - this is the time reported in service\n plan data in self component's ready state status (leaf)","format":"string","x-yang":{"type":"leaf"}}}},"x-yang":{"type":"list"}}},"description":"(non-presence)","x-yang":{"type":"container","is_presence":"false"}}}}},"$$ref":"#/components/schemas/operations_cat-inventory-rpc_get-service-plan-data-post-output"}}}},"204":{"description":"No Content","content":{}},"400":{"description":"Bad Request","content":{}},"401":{"description":"Unauthorized","content":{}},"404":{"description":"Not Found","content":{}},"405":{"description":"Method Not Allowed","content":{}},"409":{"description":"Conflict","content":{}}},"security":[{"bearerAuth":[]}],"x-codegen-request-body-name":"get-service-plan-data","__originalOperationId":"operations_cat_inventory_rpc_get_service_plan_data_post","method":"post","path":"/operations/cat-inventory-rpc:get-service-plan-data"}}