All Service instance references in a batch - Crosswork Network Controller 7.1 APIs

{"type":"api","title":"All Service instance references in a batch","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":"All Service instance references in a batch","description":"return all services in the system (istp inventory db). The return\nset of records can be indexed and limited using the collection-header\nparameters - offset and limit. Also, the query criteria can be\nspecified to filter the services returned. This operation can\nbe called iteratively to retrieve all the services for a given\ncriteria by passing the offset incremented based on the last response\nto the operation. ","operationId":"operations_cat_inventory_rpc_get_all_services_post","requestBody":{"description":"return all services in the system (istp inventory db). The return\nset of records can be indexed and limited using the collection-header\nparameters - offset and limit. Also, the query criteria can be\nspecified to filter the services returned. This operation can\nbe called iteratively to retrieve all the services for a given\ncriteria by passing the offset incremented based on the last response\nto the operation. ","content":{"application/yang-data+json":{"schema":{"type":"object","properties":{"cat-inventory-rpc:input":{"type":"object","properties":{"cat-inventory-rpc:get-all-services-request":{"type":"object","properties":{"collection-header":{"type":"object","properties":{"offset":{"type":"integer","description":"offset of the first record of the collection (leaf)","format":"uint32","x-yang":{"type":"leaf"}},"limit":{"type":"string","description":"max number of records that should be in collection (leaf)","format":"int32","x-yang":{"type":"leaf"}},"count":{"type":"string","description":"actual number of records in the collection. (leaf)","format":"int32","x-yang":{"type":"leaf"}}},"description":"(non-presence)","x-yang":{"type":"container","is_presence":"false"}},"query-criteria":{"type":"object","properties":{"service-name-filters":{"type":"object","properties":{"start-with":{"type":"string","description":"start with pattern to apply for service-name match - example:\n for [foo-service, foo-bar-service] services, start-with=foo return\n both, start-with=foo-s return only foo-service (leaf)","format":"string","x-yang":{"type":"leaf"}},"case-sensitive":{"type":"string","description":"indicate if the filter value should be used for case sensitive\n filtering or not. if missing, it is considered as false (leaf)","format":"boolean","x-yang":{"type":"leaf"}}},"description":"filter to match the service-name to include services that match\nwith the pattern specified in the filter - default when this filter\nin not specified, no matching pattern is added on service name.\nWhen matching service name is not needed, it is recomended to\nommit this filter in the input as using this filter afffects query\nperformance. (non-presence)","x-yang":{"type":"container","is_presence":"false"}},"service-type-filters":{"type":"object","properties":{"includes":{"type":"object","properties":{"service-type":{"type":"array","items":{"type":"string","description":"type of the service (leaf-list)","format":"string"},"x-yang":{"type":"leaf-list"}}},"description":"filter to specify the included service types for retrieval. When\n includes is empty or missing, it is treated as all includes (non-presence)","x-yang":{"type":"container","is_presence":"false"}},"excludes":{"type":"object","properties":{"service-type":{"type":"array","items":{"type":"string","description":"type of the service (leaf-list)","format":"string"},"x-yang":{"type":"leaf-list"}}},"description":"filter to specify the excluded service types for retrieval. When\n excludes is empty or missing, it is treated as nothing excluded (non-presence)","x-yang":{"type":"container","is_presence":"false"}}},"description":"filter to specify the included and excluded service types from\nretrieval. by default if none of includes and excludes specified,\nall available service types are included. when these filters are\napplied the resulting service types included in the retrieval\nare subset of available service types computed out of includes\nand excludes together. (non-presence)","x-yang":{"type":"container","is_presence":"false"}}},"description":"(non-presence)","x-yang":{"type":"container","is_presence":"false"}}},"description":"(non-presence)","x-yang":{"type":"container","is_presence":"false"}}}}},"$$ref":"#/components/schemas/operations_cat-inventory-rpc_get-all-services-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-all-services-response":{"type":"object","properties":{"collection-header":{"type":"object","properties":{"offset":{"type":"integer","description":"offset of the first record of the collection (leaf)","format":"uint32","x-yang":{"type":"leaf"}},"limit":{"type":"string","description":"max number of records that should be in collection (leaf)","format":"int32","x-yang":{"type":"leaf"}},"count":{"type":"string","description":"actual number of records in the collection. (leaf)","format":"int32","x-yang":{"type":"leaf"}}},"description":"(non-presence)","x-yang":{"type":"container","is_presence":"false"}},"collection-data":{"type":"object","properties":{"service-info":{"type":"array","description":"(list)","items":{"type":"object","properties":{"service-name":{"type":"string","description":"name of the service (leaf)","format":"string","x-yang":{"type":"leaf"}},"service-type":{"type":"string","description":"type of the service with qname in string format e.g. {urn:a:b:c:foo}bar\nfor bar service type (leaf)","format":"string","x-yang":{"type":"leaf"}},"yang-path":{"type":"string","description":"restconf yang path to the data resource that can retrieve full\ndetails of the service intent (leaf)","format":"string","x-yang":{"type":"leaf"}},"plan-yang-path":{"type":"string","description":"restconf yang path to the service plan data resource that can\nretrieve full details of the service plan/deployment corresponds\nto this service intent (leaf)","format":"string","x-yang":{"type":"leaf"}}}},"x-yang":{"type":"list"}}},"description":"(non-presence)","x-yang":{"type":"container","is_presence":"false"}}},"description":"(non-presence)","x-yang":{"type":"container","is_presence":"false"}}}}},"$$ref":"#/components/schemas/operations_cat-inventory-rpc_get-all-services-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-all-services","__originalOperationId":"operations_cat_inventory_rpc_get_all_services_post","method":"post","path":"/operations/cat-inventory-rpc:get-all-services"}}