{"type":"api","title":"Get Subscription","meta":{"id":"/apps/pubhub/media/crosswork-network-controller-7-1/f445c17e25a1120e8fbde4bd413083d0fd88b2b3/90eed0f5-89f5-3b38-91bd-a82e5776883c","info":{"title":"External Kafka Subscription APIs","description":"External kafka subscription APIs exposed by Notification service.","contact":{"name":"Crosswork Team, Cisco","email":"support@cisco.com"},"license":{"name":"Cisco Software License Agreement","url":"http://www.cisco.com/public/sw-license-agreement.html"},"version":"1.0.0"},"x-parser-conf":{"overview":{"markdownPath":"reference/EMF/Notification/extrnl-kafka-api-overview.md"}},"openapi":"3.1.0","servers":[{"url":"https://{server_ip}:30603/crosswork/notification/v1","description":"Generated server url"}]},"spec":{"tags":["External Kafka Subscription"],"summary":"Get Subscription","operationId":"getAllSubscription","responses":{"200":{"description":"Success with response message-body","content":{"application/json":{"schema":{"type":"object","description":"This is a wrapper of ExtnalKafkaSubscriptionDTO","properties":{"kafkaSubscriptionDestList":{"uniqueItems":true,"type":"array","description":"Collection of ExtnalKafkaSubscriptionDTO","items":{"type":"object","description":"This is a record of external kafka subscription","required":["destinationName","destinationType","topicName"],"properties":{"destinationName":{"type":"string","description":"The destination name created as part of destination api"},"destinationType":{"type":"string","description":"The type of destination, (possible values [INVENTORY_CHANGES, ALARM, SYSTEM_AUDIT, PERFORMANCE_MONITORING])"},"filter":{"type":["string","null"],"description":"This field is optional. (Only supported for Inventory & Performance) Inventory : Filter based on Device type. E.g \"filter\": \"Routers/Cisco 1000 Series Routers/Cisco 1004 Router\" Performance : Filter based on Policy type & Policy Instance (Policy name)E.g \"filter\": \"policy_type=OpticalSFP, policy_instance=instance1"},"topicName":{"type":"string","description":"Topic name to be subscribed for"}},"$$ref":"#/components/schemas/ExtnalKafkaSubscriptionDTO"}}},"$$ref":"#/components/schemas/ExtnalKafkaSubscriptionListDTO"},"examples":{"example":{"summary":"Sample response","value":{"kafkaSubscriptionDestList":[{"destinationName":"kafkadest","destinationType":"SYSTEM_AUDIT","filter":null,"topicName":"audit"}]},"$$ref":"#/components/examples/GetKafkaSubscription"}}}}},"400":{"description":"Bad Request - Invalid request"},"401":{"description":"Unauthorized. The request has not been applied because it lacks valid authentication credentials for the target resource."},"403":{"description":"Forbidden. The server recognizes the authentication credentials, but the client is not authorized to perform this request."},"500":{"description":"Internal Server Error - operation-failed"}},"method":"get","path":"/externalkafka/subscription"}}