{"info":{"_postman_id":"5a0c11a7-b717-4ea1-a0b3-cf17491135e2","name":"New Performance Management","description":"

This collection describes the REST calls related to the new Performance management module that helps to retrieve performance metrics and KPIs, create and manage North Bound Interface (NBI) Kafka Notification Services, validate, process, store, and report from Network Elements.

Environment Settings:

To execute the REST calls, configure the environment for local set-up. An environment is a set of key-value pairs. The key represents the name of the configurable variable in the REST call.

The following are the mandatory variables that have to be configured before executing the REST calls:

{{otneIP}}: IP of the MnC Server.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"7109072","collectionId":"5a0c11a7-b717-4ea1-a0b3-cf17491135e2","publishedId":"Uyxoh4DF","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2022-05-20T12:13:16.000Z"},"item":[{"name":"PM Kafka Notification Service","item":[{"name":"Create Subscription","id":"34d72cd9-f02c-41c8-a604-2510a3cac5a2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}"}],"body":{"mode":"raw","raw":"{ \"filterBy\": \"ne\",\n\"granularity\": \"15mins\", \n\"profileName\": \"Test_doc\", \n\"startDtInSeconds\": 0, \n\"status\": \"active\"\n}"},"url":"https://{{otneIP}}:8443/mncpm/nbi-streaming/api/v1/subscriptions/","description":"

This API is used to create Kafka notification subscription. The Response includes the subscription ID and topic ID attributes.

The 'subscriptionId' field contains the subscription ID of the created Kafka notification subscription. This ID should be used in subsequent REST calls.
The field 'topicId' contains the PM Kafka topic name to which the NBI system can connect and consume data.

In this call, PM data subscription is created with a granularity of '15mins'. To set the subscription for 24 hours, set the granularity attribute to '24hours'.

\n","urlObject":{"protocol":"https","port":"8443","path":["mncpm","nbi-streaming","api","v1","subscriptions",""],"host":["{{otneIP}}"],"query":[],"variable":[]}},"response":[{"id":"f1b8f74c-9086-44fc-b76c-e4ee62993fd0","name":"Create Subscription 22.6","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}"}],"body":{"mode":"raw","raw":"{ \"filterBy\": \"ne\",\n\"granularity\": \"15mins\", \n\"profileName\": \"ne_filter3\", \n\"startDtInSeconds\": 0, \n\"status\": \"active\"\n}"},"url":"https://{{otneIP}}:8443/mncpm/nbi-streaming/api/v1/subscriptions/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"content-security-policy","value":"frame-ancestors 'self' https://135.250.140.239:* https://otncore.nfmt-net:* https://otntomcat.nfmt-net:* https://172.29.2.15:* https://172.29.2.16:*; connect-src 'self' wss://otncore.nfmt-net:* wss://172.29.2.15:* wss://172.29.2.16:* wss://otntomcat.nfmt-net:* wss://135.250.140.239:* https://135.250.140.239:* https://otncore.nfmt-net:* https://otntomcat.nfmt-net:* https://172.29.2.15:* https://172.29.2.16:*; default-src 'self' data: https://135.250.140.239:* https://otncore.nfmt-net:* https://otntomcat.nfmt-net:* https://172.29.2.15:* https://172.29.2.16:* 'unsafe-inline' 'unsafe-eval'"},{"key":"set-cookie","value":"JSESSIONID=bXDdGb0MnmtmFnTyV0HJvMrlqJywe1fB; Path=/mncpm; Secure; HttpOnly"},{"key":"vary","value":"Origin"},{"key":"vary","value":"Access-Control-Request-Method"},{"key":"vary","value":"Access-Control-Request-Headers"},{"key":"content-type","value":"application/json"},{"key":"transfer-encoding","value":"chunked"},{"key":"date","value":"Wed, 18 May 2022 16:40:55 GMT"},{"key":"strict-transport-security","value":"max-age=31536000; includeSubDomains; preload"}],"cookie":[],"responseTime":null,"body":"{\n \"subscriptionId\": \"7b0ff423-ff15-4907-b5a0-c96f971ccf80\",\n \"topicId\": \"PM-NBI-7b0ff423-ff15-4907-b5a0-c96f971ccf80\"\n}"}],"_postman_id":"34d72cd9-f02c-41c8-a604-2510a3cac5a2"},{"name":"Create Subscription with Filter","id":"8b5339f8-a138-4a8e-85c3-a17da74f0a8f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}"}],"body":{"mode":"raw","raw":"{ \"filterBy\": \"ne\",\n\"granularity\": \"15mins\", \n\"profileName\": \"ne_filter3\", \n\"startDtInSeconds\": 0, \n \"neFilter\" : \n{\n \"neLabel\":\"starts pss32\",\n \"addr\":\"ends 82\",\n \"loc\":\"\",\n \"rel\":\"contains 14 \",\n \"type\":\"\"\n},\n\"status\": \"active\"\n}"},"url":"https://{{otneIP}}:8443/mncpm/nbi-streaming/api/v1/subscriptions/","description":"

This API is used to create subscription with additional filter options and returns the subscription ID and topic ID.

In this call, the PM data subscription is created with a granularity of '15mins'. Additionally, an Network Element (NE) filter is applied to retrieve Kafka notifications specific to 1830 PSS 32 NE.

\n","urlObject":{"protocol":"https","port":"8443","path":["mncpm","nbi-streaming","api","v1","subscriptions",""],"host":["{{otneIP}}"],"query":[],"variable":[]}},"response":[{"id":"c47cae32-e7ce-4c9b-85bd-032abd220579","name":"Create Subscription with Filter","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}"}],"body":{"mode":"raw","raw":"{ \"filterBy\": \"ne\",\n\"granularity\": \"15mins\", \n\"profileName\": \"ne_filter3\", \n\"startDtInSeconds\": 0, \n \"neFilter\" : \n{\n \"neLabel\":\"starts pss32\",\n \"addr\":\"ends 82\",\n \"loc\":\"\",\n \"rel\":\"contains 14 \",\n \"type\":\"\"\n},\n\"status\": \"active\"\n}"},"url":"https://{{otneIP}}:8443/mncpm/nbi-streaming/api/v1/subscriptions/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"content-security-policy","value":"frame-ancestors 'self' https://135.250.140.239:* https://otncore.nfmt-net:* https://otntomcat.nfmt-net:* https://172.29.2.15:* https://172.29.2.16:*; connect-src 'self' wss://otncore.nfmt-net:* wss://172.29.2.15:* wss://172.29.2.16:* wss://otntomcat.nfmt-net:* wss://135.250.140.239:* https://135.250.140.239:* https://otncore.nfmt-net:* https://otntomcat.nfmt-net:* https://172.29.2.15:* https://172.29.2.16:*; default-src 'self' data: https://135.250.140.239:* https://otncore.nfmt-net:* https://otntomcat.nfmt-net:* https://172.29.2.15:* https://172.29.2.16:* 'unsafe-inline' 'unsafe-eval'"},{"key":"vary","value":"Origin"},{"key":"vary","value":"Access-Control-Request-Method"},{"key":"vary","value":"Access-Control-Request-Headers"},{"key":"content-type","value":"application/json"},{"key":"transfer-encoding","value":"chunked"},{"key":"date","value":"Thu, 19 May 2022 14:30:07 GMT"},{"key":"strict-transport-security","value":"max-age=31536000; includeSubDomains; preload"}],"cookie":[],"responseTime":null,"body":"{\n \"subscriptionId\": \"143f3ad6-afe4-4937-92a4-32002a509dbf\",\n \"topicId\": \"PM-NBI-143f3ad6-afe4-4937-92a4-32002a509dbf\"\n}"}],"_postman_id":"8b5339f8-a138-4a8e-85c3-a17da74f0a8f"},{"name":"Retrieve Subscriptions","id":"ae62c56d-7942-4607-ad32-7a3fc58b3e01","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"accept":true}},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"url":"https://{{otneIP}}:8443/mncpm/nbi-streaming/api/v1/subscriptions/","description":"

This API is used to retrieve all the Kafka notification subscriptions created by the user.

\n","urlObject":{"protocol":"https","port":"8443","path":["mncpm","nbi-streaming","api","v1","subscriptions",""],"host":["{{otneIP}}"],"query":[],"variable":[]}},"response":[{"id":"4d38cb3f-22cd-45a1-b9be-7439cd40fad2","name":"Retrieve Subscriptions","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"url":"https://{{otneIP}}:8443/mncpm/nbi-streaming/api/v1/subscriptions/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"content-security-policy","value":"frame-ancestors 'self' https://135.250.140.239:* https://otncore.nfmt-net:* https://otntomcat.nfmt-net:* https://172.29.2.15:* https://172.29.2.16:*; connect-src 'self' wss://otncore.nfmt-net:* wss://172.29.2.15:* wss://172.29.2.16:* wss://otntomcat.nfmt-net:* wss://135.250.140.239:* https://135.250.140.239:* https://otncore.nfmt-net:* https://otntomcat.nfmt-net:* https://172.29.2.15:* https://172.29.2.16:*; default-src 'self' data: https://135.250.140.239:* https://otncore.nfmt-net:* https://otntomcat.nfmt-net:* https://172.29.2.15:* https://172.29.2.16:* 'unsafe-inline' 'unsafe-eval'"},{"key":"vary","value":"Origin"},{"key":"vary","value":"Access-Control-Request-Method"},{"key":"vary","value":"Access-Control-Request-Headers"},{"key":"content-type","value":"application/json"},{"key":"transfer-encoding","value":"chunked"},{"key":"date","value":"Thu, 19 May 2022 14:30:48 GMT"},{"key":"strict-transport-security","value":"max-age=31536000; includeSubDomains; preload"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"subscriptionId\": \"143f3ad6-afe4-4937-92a4-32002a509dbf\",\n \"profileName\": \"ne_filter3\",\n \"topicId\": \"PM-NBI-143f3ad6-afe4-4937-92a4-32002a509dbf\",\n \"jobType\": \"nbisubsciption\",\n \"filterBy\": \"ne\",\n \"cxnsFilter\": {},\n \"neFilter\": {\n \"rel\": \"contains 14 \",\n \"loc\": \"\",\n \"addr\": \"ends 82\",\n \"type\": \"\",\n \"neLabel\": \"starts pss32\"\n },\n \"granularity\": \"15mins\",\n \"startDtInSeconds\": 1652970601,\n \"endDtInSeconds\": 1652974201,\n \"cts\": 1652970601,\n \"lmts\": 1652970601,\n \"status\": \"active\"\n }\n]"}],"_postman_id":"ae62c56d-7942-4607-ad32-7a3fc58b3e01"},{"name":"Retrieve Subscription details","id":"04aa1f5b-8790-4c66-8b11-813812506be6","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"accept":true}},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"url":"https://{{otneIP}}:8443/mncpm/nbi-streaming/api/v1/subscriptions/{{subscriptionID}}","description":"

This API is used to retrieve the subscription information for a specific subscription ID. The subscription ID is provided as an input path parameter and can be obtained from the response of the Retrieve Subscription REST call (GET /mncpm/nbi-streaming/api/v1/subscriptions/).

\n","urlObject":{"protocol":"https","port":"8443","path":["mncpm","nbi-streaming","api","v1","subscriptions","{{subscriptionID}}"],"host":["{{otneIP}}"],"query":[],"variable":[]}},"response":[{"id":"79f810fe-0615-4194-b54f-cc50eb504e9a","name":"Retrieve Subscription details","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"url":"https://{{otneIP}}:8443/mncpm/nbi-streaming/api/v1/subscriptions/{{subscriptionID}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"content-security-policy","value":"frame-ancestors 'self' https://135.250.140.239:* https://otncore.nfmt-net:* https://otntomcat.nfmt-net:* https://172.29.2.15:* https://172.29.2.16:*; connect-src 'self' wss://otncore.nfmt-net:* wss://172.29.2.15:* wss://172.29.2.16:* wss://otntomcat.nfmt-net:* wss://135.250.140.239:* https://135.250.140.239:* https://otncore.nfmt-net:* https://otntomcat.nfmt-net:* https://172.29.2.15:* https://172.29.2.16:*; default-src 'self' data: https://135.250.140.239:* https://otncore.nfmt-net:* https://otntomcat.nfmt-net:* https://172.29.2.15:* https://172.29.2.16:* 'unsafe-inline' 'unsafe-eval'"},{"key":"vary","value":"Origin"},{"key":"vary","value":"Access-Control-Request-Method"},{"key":"vary","value":"Access-Control-Request-Headers"},{"key":"content-type","value":"application/json"},{"key":"transfer-encoding","value":"chunked"},{"key":"date","value":"Thu, 19 May 2022 14:32:58 GMT"},{"key":"strict-transport-security","value":"max-age=31536000; includeSubDomains; preload"}],"cookie":[],"responseTime":null,"body":"{\n \"subscriptionId\": \"143f3ad6-afe4-4937-92a4-32002a509dbf\",\n \"profileName\": \"ne_filter3\",\n \"topicId\": \"PM-NBI-143f3ad6-afe4-4937-92a4-32002a509dbf\",\n \"jobType\": \"nbisubsciption\",\n \"filterBy\": \"ne\",\n \"cxnsFilter\": {},\n \"neFilter\": {\n \"rel\": \"contains 14 \",\n \"loc\": \"\",\n \"addr\": \"ends 82\",\n \"type\": \"\",\n \"neLabel\": \"starts pss32\"\n },\n \"granularity\": \"15mins\",\n \"startDtInSeconds\": 1652970601,\n \"endDtInSeconds\": 1652974201,\n \"cts\": 1652970601,\n \"lmts\": 1652970601,\n \"status\": \"active\"\n}"}],"_postman_id":"04aa1f5b-8790-4c66-8b11-813812506be6"},{"name":"Renew or Update Subscription","id":"5624525c-2b70-43c0-9795-c6fdca243978","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}"}],"body":{"mode":"raw","raw":"{ \"filterBy\": \"ne\",\n\"granularity\": \"24hours\", \n\"profileName\": \"Test_doc\", \n\"startDtInSeconds\": 0, \n\"status\": \"active\"\n}"},"url":"https://{{otneIP}}:8443/mncpm/nbi-streaming/api/v1/subscriptions/{{subscriptionID}}","description":"

This API is used to update or renew the subscription. The subscription ID is provided as an input path parameter and can be obtained from the response of the Retrieve Subscription REST call (GET /mncpm/nbi-streaming/api/v1/subscriptions/).
The subscriptions are valid only for a certain period of time. For 15 minutes granularity, the subscription is valid for one hour. For 24 hours granularity the subscription is valid for one day.

Configure the /nfmt/config/runtimconfig.properties file in pm-components container to change the timer values.

The NBI client has to send an update request to renew the subscription within this time post which the subscription will be deleted from the system and PM Data forwarding in Kafka topic will be stopped.

In this call, the granularity is changed from '15mins' to 24hours' and the subscription is renewed.

\n","urlObject":{"protocol":"https","port":"8443","path":["mncpm","nbi-streaming","api","v1","subscriptions","{{subscriptionID}}"],"host":["{{otneIP}}"],"query":[],"variable":[]}},"response":[{"id":"50b3959e-6844-4007-8052-7ed489216a20","name":"Renew or Update Subscription 24hrs","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}"}],"body":{"mode":"raw","raw":"{ \"filterBy\": \"ne\",\n\"granularity\": \"24hours\", \n\"profileName\": \"Test_doc\", \n\"startDtInSeconds\": 0, \n\"status\": \"active\"\n}"},"url":"https://{{otneIP}}:8443/mncpm/nbi-streaming/api/v1/subscriptions/{{subscriptionID}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"content-security-policy","value":"frame-ancestors 'self' https://135.250.140.239:* https://otncore.nfmt-net:* https://otntomcat.nfmt-net:* https://172.29.2.15:* https://172.29.2.16:*; connect-src 'self' wss://otncore.nfmt-net:* wss://172.29.2.15:* wss://172.29.2.16:* wss://otntomcat.nfmt-net:* wss://135.250.140.239:* https://135.250.140.239:* https://otncore.nfmt-net:* https://otntomcat.nfmt-net:* https://172.29.2.15:* https://172.29.2.16:*; default-src 'self' data: https://135.250.140.239:* https://otncore.nfmt-net:* https://otntomcat.nfmt-net:* https://172.29.2.15:* https://172.29.2.16:* 'unsafe-inline' 'unsafe-eval'"},{"key":"vary","value":"Origin"},{"key":"vary","value":"Access-Control-Request-Method"},{"key":"vary","value":"Access-Control-Request-Headers"},{"key":"content-type","value":"application/json"},{"key":"transfer-encoding","value":"chunked"},{"key":"date","value":"Thu, 19 May 2022 15:11:43 GMT"},{"key":"strict-transport-security","value":"max-age=31536000; includeSubDomains; preload"}],"cookie":[],"responseTime":null,"body":"{\n \"subscriptionId\": \"0cdf71dd-1020-41d2-8fb1-ec0fc5c1882f\",\n \"topicId\": \"PM-NBI-0cdf71dd-1020-41d2-8fb1-ec0fc5c1882f\"\n}"}],"_postman_id":"5624525c-2b70-43c0-9795-c6fdca243978"},{"name":"Delete Subscription","id":"28d7d099-0605-4da6-9f3b-f0e4edb385e7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{otneIP}}:8443/mncpm/nbi-streaming/api/v1/subscriptions/{{subscriptionID}}","description":"

This API is used to unsubscribe and stop receiving the PM data through the corresponding NBI Kafka topic.

The subscription ID is provided as an input path parameter and can be obtained from the response of the Retrieve Subscription REST call (GET /mncpm/nbi-streaming/api/v1/subscriptions/).

Note:
As soon as the subscription is successfully deleted, the Kafka notifications will not be forwarded for that topic, However, the topic will continue to exist and will be deleted only when all consumers for that topic are closed.

This section describes the REST calls related to the new Performance management module that helps to retrieve performance metrics of Network Elements using North Bound Interface (NBI) Kafka Notification Services.

Use the following REST calls to create and manage the PM NBI Kafka Subscriptions.

\n","_postman_id":"213527da-0ed8-49b5-8bbe-af891188b372"},{"name":"New Request","id":"fe5fe18a-24e9-49f0-bd9d-a2f67c9b7dae","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"fe5fe18a-24e9-49f0-bd9d-a2f67c9b7dae"}],"event":[{"listen":"prerequest","script":{"id":"880f63be-8da0-46d8-8449-e9edf90b271f","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"213e0659-a6e5-4df9-9483-a1e70183a829","type":"text/javascript","exec":[""]}}]}