{"type":"api","title":"Get Rest Conf Monitoring Status","meta":{"id":"/apps/pubhub/media/crosswork-network-controller-7-1/f445c17e25a1120e8fbde4bd413083d0fd88b2b3/59d48f60-cd88-3cf8-8862-0da20c3d549d","info":{"title":"Connectionless Subscription APIs","description":"Connectionless 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"},"tags":[{"name":"Connectionless Subscriptions","description":"Points to note: \nThe actual response will,\n- Have namespace prefixed in the attribute name\n- Not have attributes whose values are null\n- Have the attribute names \"-\" separated in some cases\n- Have additional section with firstIndex and lastIndex attributes"}],"x-parser-conf":{"overview":{"markdownPath":"reference/EMF/Notification/cnctnless-api-overview.md"}},"openapi":"3.1.0","servers":[{"url":"https://{server_ip}:30603/crosswork/notification/restconf/data/v2","description":"Generated server url"}]},"spec":{"tags":["Connectionless Subscriptions"],"operationId":"getRestConfMonitoringStatus","responses":{"200":{"description":"Success with response message-body","content":{"application/json":{"schema":{"type":"object","xml":{"name":"streams","namespace":"urn:ietf:params:xml:ns:yang:ietf-restconf-monitoring","prefix":"ns20"},"description":"This is restconf streams","properties":{"stream":{"type":"array","description":"stream","items":{"type":"object","xml":{"name":"stream","prefix":"ns20"},"description":"this is stream","properties":{"name":{"type":"string","description":"name","xml":{"prefix":"ns20"}},"description":{"type":"string","description":"description","xml":{"prefix":"ns20"}},"access":{"type":"array","description":"access","items":{"type":"object","description":"access","properties":{"encoding":{"type":"string","description":"encoding","xml":{"prefix":"ns20"}},"location":{"type":"string","description":"location","xml":{"prefix":"ns20"}}},"$$ref":"#/components/schemas/Access"}}},"$$ref":"#/components/schemas/Stream"}}},"$$ref":"#/components/schemas/Streams"},"examples":{"example":{"summary":"Streams sample","value":{"rcmon.streams":{"rcmon.stream":[{"rcmon.name":"RestConf (connection-less) alarm and inventory notification subscription","rcmon.description":"Connection-less client subscription using payload","rcmon.access":[{"rcmon.encoding":"xml","rcmon.location":"POST https://server-IP:30603/crosswork/notification/restconf/data/v2/cisco-notifications:subscription"},{"rcmon.encoding":"json","rcmon.location":"POST https://server-IP:30603/crosswork/notification/restconf/data/v2/cisco-notifications:subscription"}]},{"rcmon.name":"WebSocket (connection-oriented) Alarm Notification Streaming","rcmon.description":"Connection-oriented client subscription","rcmon.access":[{"rcmon.encoding":"xml","rcmon.location":"wss://server-IP:30603/crosswork/notification/restconf/streams/v2/alarm.xml"},{"rcmon.encoding":"json","rcmon.location":"wss://server-IP:30603/crosswork/notification/restconf/streams/v2/alarm.json"}]},{"rcmon.name":"WebSocket (connection-oriented) Alarm Notification Streaming with Filter","rcmon.description":"Multiple filter values are supported and the value should be comma separated.","rcmon.access":[{"rcmon.encoding":"xml","rcmon.location":"wss://server-IP:30603/crosswork/notification/restconf/streams/v2/alarm.xml?productFamily=value&productType=value&severity=value&deviceUUId=value"},{"rcmon.encoding":"json","rcmon.location":"wss://server-IP:30603/crosswork/notification/restconf/streams/v2/alarm.json?productFamily=value&productType=value&severity=value&deviceUUId=value"}]},{"rcmon.name":"WebSocket (connection-oriented) Inventory Notification Streaming","rcmon.description":"Connection-oriented client subscription","rcmon.access":[{"rcmon.encoding":"xml","rcmon.location":"wss://server-IP:30603/crosswork/notification/restconf/streams/v1/inventory.xml"},{"rcmon.encoding":"json","rcmon.location":"wss://server-IP:30603/crosswork/notification/restconf/streams/v1/inventory.json"}]},{"rcmon.name":"WebSocket (connection-oriented) Inventory Notification Streaming with Filter","rcmon.description":"Multiple filter values are supported and the value should be comma separated.","rcmon.access":[{"rcmon.encoding":"xml","rcmon.location":"wss://server-IP:30603/crosswork/notification/restconf/streams/v1/inventory.xml?productFamily=value&productType=value"},{"rcmon.encoding":"json","rcmon.location":"wss://server-IP:30603/crosswork/notification/restconf/streams/v1/inventory.json?productFamily=value&productType=value"}]}]}},"$$ref":"#/components/examples/StreamsJson"}}},"application/xml":{"schema":{"type":"object","xml":{"name":"streams","namespace":"urn:ietf:params:xml:ns:yang:ietf-restconf-monitoring","prefix":"ns20"},"description":"This is restconf streams","properties":{"stream":{"type":"array","description":"stream","items":{"type":"object","xml":{"name":"stream","prefix":"ns20"},"description":"this is stream","properties":{"name":{"type":"string","description":"name","xml":{"prefix":"ns20"}},"description":{"type":"string","description":"description","xml":{"prefix":"ns20"}},"access":{"type":"array","description":"access","items":{"type":"object","description":"access","properties":{"encoding":{"type":"string","description":"encoding","xml":{"prefix":"ns20"}},"location":{"type":"string","description":"location","xml":{"prefix":"ns20"}}},"$$ref":"#/components/schemas/Access"}}},"$$ref":"#/components/schemas/Stream"}}},"$$ref":"#/components/schemas/Streams"},"examples":{"example":{"summary":"Streams sample","value":{"stream":[{"name":"RestConf (connection-less) alarm and inventory notification subscription","description":"Connection-less client subscription using payload","access":[{"encoding":"xml","location":"POST https://server-IP:30603/crosswork/notification/restconf/data/v2/cisco-notifications:subscription"},{"encoding":"json","location":"POST https://server-IP:30603/crosswork/notification/restconf/data/v2/cisco-notifications:subscription"}]},{"name":"WebSocket (connection-oriented) Alarm Notification Streaming","description":"Connection-oriented client subscription","access":[{"encoding":"xml","location":"wss://server-IP:30603/crosswork/notification/restconf/streams/v2/alarm.xml"},{"encoding":"json","location":"wss://server-IP:30603/crosswork/notification/restconf/streams/v2/alarm.json"}]},{"name":"WebSocket (connection-oriented) Alarm Notification Streaming with Filter","description":"Multiple filter values are supported and the value should be comma separated.","access":[{"encoding":"xml","location":"wss://server-IP:30603/crosswork/notification/restconf/streams/v2/alarm.xml?productFamily=value&productType=value&severity=value&deviceUUId=value"},{"encoding":"json","location":"wss://server-IP:30603/crosswork/notification/restconf/streams/v2/alarm.json?productFamily=value&productType=value&severity=value&deviceUUId=value"}]},{"name":"WebSocket (connection-oriented) Inventory Notification Streaming","description":"Connection-oriented client subscription","access":[{"encoding":"xml","location":"wss://server-IP:30603/crosswork/notification/restconf/streams/v1/inventory.xml"},{"encoding":"json","location":"wss://server-IP:30603/crosswork/notification/restconf/streams/v1/inventory.json"}]},{"name":"WebSocket (connection-oriented) Inventory Notification Streaming with Filter","description":"Multiple filter values are supported and the value should be comma separated.","access":[{"encoding":"xml","location":"wss://server-IP:30603/crosswork/notification/restconf/streams/v1/inventory.xml?productFamily=value&productType=value"},{"encoding":"json","location":"wss://server-IP:30603/crosswork/notification/restconf/streams/v1/inventory.json?productFamily=value&productType=value"}]}]},"$$ref":"#/components/examples/StreamsXml"}}}}},"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":"/ietf-restconf-monitoring:restconf-state/streams"}}