Newer
Older
"description": "Data volume of uplink non-GBR traffic of a UE as defined in ETSI TS 136 314",
"style": "form",
"explode": true,
"schema": {
"type": "integer",
"contentEncoding": "int32"
}
"description": "Successful response to layer2 measurements info request",
}
}
}
},
"400": {
"description": "Bad Request : used to indicate that incorrect parameters were passed to the request.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
"description": "Unauthorized : used when the client did not submit credentials.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
"description": "Forbidden : operation is not allowed given the current status of the resource.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
"description": "Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
"description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
"description": "URI Too Long : used to indicate that the server is refusing to process the request because the request URI is longer than the server is willing or able to process.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
"description": "Too Many Requests : used when a rate limiter has triggered.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
"deprecated": false
},
"parameters": []
"summary": "Queries information on subscriptions for notifications",
"description": "Queries information on subscriptions for notifications",
"operationId": "subscriptionLinkList_subscriptionsGET",
"parameters": [
{
"name": "subscription_type",
"in": "query",
"description": "Filter on a specific subscription type. Permitted values: cell_change, rab_est, rab_mod, rab_rel, meas_rep_ue, nr_meas_rep_ue, timing_advance_ue, ca_reconf, s1_bearer.",
"style": "form",
"explode": true,
"schema": {
"type": "string"
}
"description": "Response body contains the list of links to requestors subscriptions.",
"examples": {
"example-ofsub-link-list": {
"value": {
"href": "http://meAppServer.example.com/rni/v2/subscriptions"
},
"subscription": [
{
"_links": null,
"self": {
"href": "http://meAppServer.example.com/rni/v2/subscriptions/sub123"
},
"callbackReference": "http://my.callback.com/rni-cell-change/some-id",
"subscriptionType": "CellChangeSubscription"
}
]
}
}
}
}
},
"400": {
"description": "Bad Request : used to indicate that incorrect parameters were passed to the request.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
"description": "Unauthorized : used when the client did not submit credentials.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
"description": "Forbidden : operation is not allowed given the current status of the resource.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
"description": "Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
"description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
"description": "Too Many Requests : used when a rate limiter has triggered.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
"summary": "Creates a new subscription to Radio Network Information notifications",
"description": "Creates a new subscription to Radio Network Information notifications",
"operationId": "subscriptionsPOST",
"requestBody": {
"description": "Subscription to be created",
"content": {
"application/json": {
"schema": {
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
"oneOf": [
{
"$ref": "#/components/schemas/CellChangeSubscription"
},
{
"$ref": "#/components/schemas/RabEstSubscription"
},
{
"$ref": "#/components/schemas/RabModSubscription"
},
{
"$ref": "#/components/schemas/RabRelSubscription"
},
{
"$ref": "#/components/schemas/MeasRepUeSubscription"
},
{
"$ref": "#/components/schemas/NrMeasRepUeSubscription"
},
{
"$ref": "#/components/schemas/MeasTaSubscription"
},
{
"$ref": "#/components/schemas/CaReconfSubscription"
},
{
"$ref": "#/components/schemas/S1BearerSubscription"
}
],
"description": "Subscription to be created",
"contentMediaType": "application/json"
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
"examples": {
"example-cell-change-subscription:callbacks": {
"value": {
"subscriptionType": "CellChangeSubscription",
"callbackReference": "http://my.callback.com/rni-cell-change/some-id",
"filterCriteriaAssocHo": {
"appInstanceId": "myApp",
"associateId": [
{
"type": 1,
"value": "10.100.0.1"
}
],
"ecgi": [
{
"plmn": {
"mnc": "01",
"mcc": "001"
},
"cellId": "ACBDEFA"
}
],
"hoStatus": [
1,
2
]
},
"expiryDeadline": {
"seconds": 1977836800,
"nanoSeconds": 0
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
"oneOf": [
{
"$ref": "#/components/schemas/CellChangeSubscription"
},
{
"$ref": "#/components/schemas/RabEstSubscription"
},
{
"$ref": "#/components/schemas/RabModSubscription"
},
{
"$ref": "#/components/schemas/RabRelSubscription"
},
{
"$ref": "#/components/schemas/MeasRepUeSubscription"
},
{
"$ref": "#/components/schemas/NrMeasRepUeSubscription"
},
{
"$ref": "#/components/schemas/MeasTaSubscription"
},
{
"$ref": "#/components/schemas/CaReconfSubscription"
},
{
"$ref": "#/components/schemas/S1BearerSubscription"
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
],
"contentMediaType": "application/json"
},
"examples": {
"example-call-change-subscription": {
"value": {
"subscriptionType": "CellChangeSubscription",
"callbackReference": "http://my.callback.com/rni-cell-change/some-id",
"_links": {
"self": {
"href": "http://meAppServer.example.com/rni/v2/subscriptions/sub123"
}
},
"filterCriteriaAssocHo": {
"appInstanceId": "myApp",
"associateId": [
{
"type": 1,
"value": "10.100.0.1"
}
],
"ecgi": [
{
"plmn": {
"mnc": "01",
"mcc": "001"
},
"cellId": "ACBDEFA"
}
],
"hoStatus": [
1,
2
]
},
"expiryDeadline": {
"seconds": 1977836800,
"nanoSeconds": 0
}
}
}
}
},
"400": {
"description": "Bad Request : used to indicate that incorrect parameters were passed to the request.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
"description": "Unauthorized : used when the client did not submit credentials.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
"description": "Forbidden : operation is not allowed given the current status of the resource.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
"description": "Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
"description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
"description": "Precondition failed : used when a condition has failed during conditional requests, e.g. when using ETags to avoid write conflicts when using PUT",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
"description": "Unprocessable Entity : used to indicate that the server understands the content type of the request entity and that the syntax of the request entity is correct but that the server is unable to process the contained instructions. This error condition can occur if an JSON request body is syntactically correct but semantically incorrect, for example if the target area for the request is considered too large. This error condition can also occur if the capabilities required by the request are not supported.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
},
"examples": {
"application/problem+json": {
"value": {
"type": "https://meAppServer.example.com/rni/v2/probs/too-many targets",
"title": "Too many targets",
"status": 422,
"detail": "The target area for the request is considered too large",
"instance": "/meAppClient.example.com/77777/msgs/abc"
}
}
}
}
}
"description": "Too Many Requests : used when a rate limiter has triggered.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"callbacks": {
"notification": {
"{$request.body#/notificationSubscription.callbackReference}": {
"post": {
"summary": "Callback POST used to send a notification",
"description": "Notification from RNIS, content based on subscription type",
"operationId": "notificationPOST",
"requestBody": {
"description": "Subscription notification",
"required": true,
"content": {
"application/json": {
"schema": {
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
"examples": {
"message": {
"value": {
"notificationType": "CellChangeNotification",
"associateId": [
{
"type": 1,
"value": "10.100.0.1"
}
],
"hoStatus": 1,
"srcEcgi": {
"plmn": {
"mnc": "01",
"mcc": "001"
},
"cellId": "ACBDEFA"
},
"tempUeId": {
"mmec": 1,
"mtmsi": 69967622812
},
"timeStamp": {
"seconds": 1977836800,
"nanoSeconds": 0
},
"trgEcgi": {
"plmn": {
"mnc": "01",
"mcc": "001"
}
},
"cellId": "FEDCBAA"
}
}
}
}
}
},
"responses": {
"204": {
"deprecated": false
},
"parameters": []
"summary": "Queries information about an existing subscription, identified by its self-referring URI returned on creation (initial POST)",
"description": "Queries information about an existing subscription, identified by its self-referring URI returned on creation (initial POST)",
"operationId": "subscriptionsGET",
"name": "subscriptionId",
"in": "path",
"description": "Subscription Id, specifically the \"Self-referring URI\" returned in the subscription request",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Subscription information regarding subscription notifications",
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
"oneOf": [
{
"$ref": "#/components/schemas/CellChangeSubscription"
},
{
"$ref": "#/components/schemas/RabEstSubscription"
},
{
"$ref": "#/components/schemas/RabModSubscription"
},
{
"$ref": "#/components/schemas/RabRelSubscription"
},
{
"$ref": "#/components/schemas/MeasRepUeSubscription"
},
{
"$ref": "#/components/schemas/NrMeasRepUeSubscription"
},
{
"$ref": "#/components/schemas/MeasTaSubscription"
},
{
"$ref": "#/components/schemas/CaReconfSubscription"
},
{
"$ref": "#/components/schemas/S1BearerSubscription"
}
],
"contentMediaType": "application/json"
},
"examples": {
"example-of-cell-change-subscription": {
"value": {
"subscriptionType": "CellChangeSubscription",
"callbackReference": "http://my.callback.com/rni-cell-change/some-id",
"_links": {
"self": {
"href": "http://meAppServer.example.com/rni/v2/subscriptions/sub123"
}
},
"filterCriteriaAssocHo": {
"appInstanceId": "myApp",
"associateId": [
{
"type": 1,
"value": "10.100.0.1"
}
],
"ecgi": [
{
"plmn": {
"mnc": "01",
"mcc": "001"
},
"cellId": "ACBDEFA"
}
],
"hoStatus": [
1,
2
]
},
"expiryDeadline": {
"seconds": 1977836800,
"nanoSeconds": 0
}
}
}
}
}
"description": "Bad Request : used to indicate that incorrect parameters were passed to the request.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
"description": "Unauthorized : used when the client did not submit credentials.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
"description": "Forbidden : operation is not allowed given the current status of the resource.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
"description": "Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
"description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
"description": "Too Many Requests : used when a rate limiter has triggered.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
"summary": "Updates an existing subscription, identified by its self-referring URI returned on creation (initial POST)",
"description": "Updates an existing subscription, identified by its self-referring URI returned on creation (initial POST)",
"operationId": "subscriptionsPUT",
"parameters": [
{
"name": "subscriptionId",
"in": "path",
"description": "Subscription Id, specifically the \"Self-referring URI\" returned in the subscription request",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Subscription to be modified",
"content": {
"application/json": {
"schema": {
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
"oneOf": [
{
"$ref": "#/components/schemas/CellChangeSubscription"
},
{
"$ref": "#/components/schemas/RabEstSubscription"
},
{
"$ref": "#/components/schemas/RabModSubscription"
},
{
"$ref": "#/components/schemas/RabRelSubscription"
},
{
"$ref": "#/components/schemas/MeasRepUeSubscription"
},
{
"$ref": "#/components/schemas/NrMeasRepUeSubscription"
},
{
"$ref": "#/components/schemas/MeasTaSubscription"
},
{
"$ref": "#/components/schemas/CaReconfSubscription"
},
{
"$ref": "#/components/schemas/S1BearerSubscription"
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
],
"description": "Subscription to be modified",
"contentMediaType": "application/json"
},
"examples": {
"example-of-cell-change-subscription": {
"value": {
"subscriptionType": "CellChangeSubscription",
"callbackReference": "http://my.callback.com/rni-cell-change/some-id",
"_links": {
"self": {
"href": "http://meAppServer.example.com/rni/v2/subscriptions/sub123"
}
},
"filterCriteriaAssocHo": {
"appInstanceId": "myApp",
"associateId": [
{
"type": 1,
"value": "10.100.0.1"
}
],
"ecgi": [
{
"plmn": {
"mnc": "01",
"mcc": "001"
},
"cellId": "ACBDEFA"
}
],
"hoStatus": [
1,
2
]
},
"expiryDeadline": {
"seconds": 1977836800,
"nanoSeconds": 0
},
"responses": {
"200": {
"description": "Successful subscription to response to subscription notifications",
"content": {
"application/json": {
"schema": {
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
"oneOf": [
{
"$ref": "#/components/schemas/CellChangeSubscription"
},
{
"$ref": "#/components/schemas/RabEstSubscription"
},
{
"$ref": "#/components/schemas/RabModSubscription"
},
{
"$ref": "#/components/schemas/RabRelSubscription"
},
{
"$ref": "#/components/schemas/MeasRepUeSubscription"
},
{
"$ref": "#/components/schemas/NrMeasRepUeSubscription"
},
{
"$ref": "#/components/schemas/MeasTaSubscription"
},
{
"$ref": "#/components/schemas/CaReconfSubscription"
},
{
"$ref": "#/components/schemas/S1BearerSubscription"
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
],
"contentMediaType": "application/json"
},
"examples": {
"example-of-cell-change-subscription": {
"value": {
"subscriptionType": "CellChangeSubscription",
"callbackReference": "http://my.callback.com/rni-cell-change/some-id",
"_links": {
"self": {
"href": "http://meAppServer.example.com/rni/v2/subscriptions/sub123"
}
},
"filterCriteriaAssocHo": {
"appInstanceId": "myApp",
"associateId": [
{
"type": 1,
"value": "10.100.0.1"
}
],
"ecgi": [
{
"plmn": {
"mnc": "01",
"mcc": "001"
},
"cellId": "ACBDEFA"
}
],
"hoStatus": [
1,
2
]
},
"expiryDeadline": {
"seconds": 1977836800,
"nanoSeconds": 0
"description": "Bad Request : used to indicate that incorrect parameters were passed to the request.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
"description": "Unauthorized : used when the client did not submit credentials.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
"description": "Forbidden : operation is not allowed given the current status of the resource.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
"description": "Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
"description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
"description": "Precondition failed : used when a condition has failed during conditional requests, e.g. when using ETags to avoid write conflicts when using PUT",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
"description": "Unprocessable Entity : used to indicate that the server understands the content type of the request entity and that the syntax of the request entity is correct but that the server is unable to process the contained instructions. This error condition can occur if an JSON request body is syntactically correct but semantically incorrect, for example if the target area for the request is considered too large. This error condition can also occur if the capabilities required by the request are not supported.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
},
"examples": {
"application/problem+json": {
"value": {
"type": "https://meAppServer.example.com/rni/v2/probs/too-many-targets",
"title": "Too many targets",
"status": 422,
"detail": "The target area for the request is considered too large",
"instance": "/meAppClient.example.com/77777/msgs/abc"
}
}
}
}
}