RniAPI.yaml 139 KB
Newer Older
1
2
swagger: '2.0'
info:
3
  description: The ETSI MEC ISG MEC012 Radio Network Information API described using OpenAPI
4
  version: 1.1.1
5
  title: RNI API
6
7
8
9
  license:
    name: ETSI Forge copyright notice
    url: 'https://forge.etsi.org/etsi-forge-copyright-notice.txt'
externalDocs:
10
  description: ETSI GS MEC012 Radio Network Information API, V1.1.1
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
  url: 'http://www.etsi.org/deliver/etsi_gs/MEC/001_099/012/01.01.01_60/gs_mec012v010101p.pdf'
host: '127.0.0.1:8081'
basePath: /rni/v1
schemes:
  - http
  - https
consumes:
  - application/json
produces:
  - application/json
security:
  - OauthSecurity:
      - all
securityDefinitions:
  OauthSecurity:
    type: oauth2
    flow: application
    tokenUrl: 'https://oauth.exampleAPI/token'
    scopes:
      all: Single oauth2 scope for API
parameters:
  Body.CellChangeSubscriptionPost:
    name: CellChangeSubscriptionPost
    in: body
    description: >-
      Use to creates a subscription to cell change notifications based on the
         filter criteria
    required: true
    schema:
      type: object
      properties:
        CellChangeSubscription:
          $ref: '#/definitions/CellChangeSubscriptionPost'
  Body.CellChangeSubscription:
    name: CellChangeSubscription
    in: body
    description: >-
      Use to creates a subscription to cell change notifications based on the
      filter criteria
    required: true
    schema:
      type: object
      properties:
        CellChangeSubscription:
          $ref: '#/definitions/CellChangeSubscription'
  Body.S1BearerSubscriptionPost:
    name: S1BearerSubscriptionPost
    in: body
    description: >-
      Use to creates a subscription to S1 Bearer notifications based on the
      filter criteria
    required: true
    schema:
      type: object
      properties:
        S1BearerSubscription:
          $ref: '#/definitions/S1BearerSubscriptionPost'
  Body.S1BearerSubscription:
    name: S1BearerSubscription
    in: body
    description: >-
      Use to creates a subscription to S1 Bearer notifications based on the
      filter criteria
    required: true
    schema:
      type: object
      properties:
        S1BearerSubscription:
          $ref: '#/definitions/S1BearerSubscription'
  Body.MeasTaSubscriptionPost:
    name: MeasTaSubscriptionPost
    in: body
    description: >-
      Use to creates a subscription to UE Timing Advance notifications based on
      the filter criteria
    required: true
    schema:
      type: object
      properties:
        MeasTaSubscription:
          $ref: '#/definitions/MeasTaSubscriptionPost'
  Body.MeasTaSubscription:
    name: MeasTaSubscription
    in: body
    description: >-
      Use to creates a subscription to UE Timing Advance notifications based on
      the filter criteria
    required: true
    schema:
      type: object
      properties:
        MeasTaSubscription:
          $ref: '#/definitions/MeasTaSubscription'
  Body.MeasRepUeSubscriptionPost:
    name: MeasRepUeSubscriptionPost
    in: body
    description: >-
      Use to creates a subscription to UE measurement report notifications based
      on the filter criteria
    required: true
    schema:
      type: object
      properties:
        MeasRepUeSubscription:
          $ref: '#/definitions/MeasRepUeSubscriptionPost'
  Body.MeasRepUeSubscription:
    name: MeasRepUeSubscription
    in: body
    description: >-
      Use to creates a subscription to UE measurement report notifications based
      on the filter criteria
    required: true
    schema:
      type: object
      properties:
        MeasRepUeSubscription:
          $ref: '#/definitions/MeasRepUeSubscription'
  Body.RabEstSubscriptionPost:
    name: RabEstSubscriptionPost
    in: body
    description: >-
      Use to creates a subscription to RAB establishment notifications based on
      the filter criteria
    required: true
    schema:
      type: object
      properties:
        RabEstSubscription:
          $ref: '#/definitions/RabEstSubscriptionPost'
  Body.RabEstSubscription:
    name: RabEstSubscription
    in: body
    description: >-
      Use to creates a subscription to RAB establishment notifications based on
      the filter criteria
    required: true
    schema:
      type: object
      properties:
        RabEstSubscription:
          $ref: '#/definitions/RabEstSubscription'
  Body.RabModSubscriptionPost:
153
    name: RabModSubscriptionPost
154
155
156
157
158
159
160
161
162
163
164
    in: body
    description: >-
      Use to creates a subscription to RAB Modification notifications based on
      the filter criteria
    required: true
    schema:
      type: object
      properties:
        RabModSubscription:
          $ref: '#/definitions/RabModSubscriptionPost'
  Body.RabModSubscription:
165
    name: RabModSubscription
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
    in: body
    description: >-
      Use to creates a subscription to RAB Modification notifications based on
      the filter criteria
    required: true
    schema:
      type: object
      properties:
        RabModSubscription:
          $ref: '#/definitions/RabModSubscription'
  Body.RabRelSubscriptionPost:
    name: RabRelSubscriptionPost
    in: body
    description: >-
      Use to creates a subscription to RAB Release notifications based on the
      filter criteria
    required: true
    schema:
      type: object
      properties:
        RabRelSubscription:
          $ref: '#/definitions/RabRelSubscriptionPost'
  Body.RabRelSubscription:
    name: RabRelSubscription
    in: body
    description: >-
      Use to creates a subscription to RAB Release notifications based on the
      filter criteria
    required: true
    schema:
      type: object
      properties:
        RabRelSubscription:
          $ref: '#/definitions/RabRelSubscription'
  Body.CaReConfSubscriptionPost:
    name: CaReConfSubscriptionPost
    in: body
    description: >-
      Use to creates a subscription to Carrier Aggregation Reconfiguration
      notifications based on the filter criteria
    required: true
    schema:
      type: object
      properties:
        CaReConfSubscription:
          $ref: '#/definitions/CaReConfSubscriptionPost'
  Body.CaReConfSubscription:
    name: CaReConfSubscription
    in: body
    description: >-
      Use to creates a subscription to Carrier Aggregation Reconfiguration
      notifications based on the filter criteria
    required: true
    schema:
      type: object
      properties:
        CaReConfSubscription:
          $ref: '#/definitions/CaReConfSubscription'
  Path.subscrId:
    name: subscriptionId
    in: path
    description: >-
      Subscription Id, specifically the "self" returned in the subscription
      request
    required: true
    type: string
    format: uri
  Query.AppInsId:
    name: app_ins_id
    in: query
    description: Application instance identifier
    required: false
    type: string
  Query.AppInsIdArr:
    name: app_ins_id
    in: query
    description: Application instance identifier
    required: true
    type: array
    items:
      type: string
  Query.UeIpv4Address:
    name: ue_ipv4_address
    in: query
    description: Comma separated list of IE IPv4 addresses as defined for the type for AssociateId
    required: false
    type: array
    items:
      type: string
  Query.UeIpv6Address:
    name: ue_ipv6_address
    in: query
    description: Comma separated list of IE IPv6 addresses as defined for the type for AssociateId
    required: false
    type: array
    items:
      type: string
  Query.NatedIpAddress:
    name: nated_ip_address
    in: query
    description: Comma separated list of IE NATed IP addresses as defined for the type for AssociateId
    required: false
    type: array
    items:
      type: string
  Query.GtpTeId:
    name: gtp_teid
    in: query
    description: Comma separated list of GTP TEID addresses as defined for the type for AssociateId
    required: false
    type: array
    items:
      type: string
  Query.CellId:
    name: cell_id
    in: query
    description: >-
      E-UTRAN Cell Identity as a bit string (size (28)), as defined in ETSI TS
      136 413
    required: false
    type: array
    items:
      type: string
  Query.ErabGbrDl:
    name: erab_gbr_dl
    in: query
    description: Guaranteed downlink E-RAB Bit Rate as defined in ETSI TS 123 401
    required: false
    type: integer
    format: uint32
  Query.ErabGbrUl:
    name: erab_gbr_ul
    in: query
    description: Guaranteed uplink E-RAB Bit Rate as defined in ETSI TS 123 401
    required: false
    type: integer
    format: uint32
  Query.ErabId:
    name: erab_id
    in: query
    description: E-RAB identifier
    required: false
    type: integer
    format: uint32
  Query.ErabIdArr:
    name: erab_id
    in: query
    description: E-RAB identifier
    required: false
    type: array
    items:
      type: integer
      format: uint32
  Query.ErabMbrDl:
    name: erab_mbr_dl
    in: query
    description: Maximum downlink E-RAB Bit Rate as defined in ETSI TS 123 401
    required: false
    type: integer
    format: uint32
  Query.ErabMbrUl:
    name: erab_mbr_ul
    in: query
    description: Maximum uplink E-RAB Bit Rate as defined in ETSI TS 123 401
    required: false
    type: integer
    format: uint32
  Query.Qci:
    name: qci
    in: query
    description: QoS Class Identifier as defined in ETSI TS 123 401
    required: false
    type: integer
    format: uint32
  Query.TempUeId:
    name: temp_ue_id
    in: query
    description: >-
      The temporary identifier allocated for the specific UE as defined in ETSI
      TS 136 413
    required: false
    type: array
    items:
      type: string
paths:
351
  /queries/rab_info:
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
    get:
      description: >-
        Gets information on existing E-RABs that are associated with a specific
        mobile edge application instance
      operationId: rab_infoGET
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/Query.AppInsId'
        - $ref: '#/parameters/Query.CellId'
        - $ref: '#/parameters/Query.UeIpv4Address'
        - $ref: '#/parameters/Query.UeIpv6Address'
        - $ref: '#/parameters/Query.NatedIpAddress'
        - $ref: '#/parameters/Query.GtpTeId'
        - $ref: '#/parameters/Query.ErabId'
        - $ref: '#/parameters/Query.Qci'
        - $ref: '#/parameters/Query.ErabMbrDl'
        - $ref: '#/parameters/Query.ErabMbrUl'
        - $ref: '#/parameters/Query.ErabGbrDl'
        - $ref: '#/parameters/Query.ErabGbrUl'
      responses:
        '200':
          description: Successful response to rab_info request
          schema:
            type: object
377
378
            required:
              - RabInfo
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
            properties:
              RabInfo:
                $ref: '#/definitions/RabInfo'
          examples:
            application/json:
              RabInfo:
                timeStamp:
                  seconds: 1577836800
                  nanoSeconds: 0
                appInId: '01'
                requestId: '01'
                cellUserInfo:
                  ecgi:
                    plmn:
                      mcc: '001'
                      mnc: '01'
                    cellId: '0x800000A'
                  ueInfo:
                    associateId: null
                    type: '1'
                    value: 192.0.2.0
                    erabInfo:
                      erabId: 10
                    erabQosParameters:
                      qci: 7
                      qosInformation:
                        erabMbrDl: 10
                        erabMbrUl: 10
                        erabGbrDl: 10
                        erabGbrUl: 10
        '400':
          description: Bad Request
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '401':
          description: Unauthorized
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '403':
          description: Forbidden
          schema:
            type: object
427
428
            required:
              - ProblemDetails
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '404':
          description: Not Found
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '406':
          description: Not Acceptable
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '429':
          description: Too Many Requests
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
      x-swagger-router-controller: Default
454
  /queries/plmn_info:
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
    get:
      description: >-
        Gets the information on Mobile Network(s) that are associated with a
        specific mobile edge application instance
      operationId: plmn_infoGET
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/Query.AppInsIdArr'
      responses:
        '200':
          description: Successful response to rab_info request
          schema:
            type: object
            properties:
              PlmnInfo:
                $ref: '#/definitions/PlmnInfo'
          examples:
            application/json:
              PlmnInfo:
                timeStamp:
                  seconds: 1577836800
                  nanoSeconds: 0
                appInId: '01'
                ecgi:
                  plmn:
                    mcc: '001'
                    mnc: '01'
                  cellId: '0x800000A'
        '400':
          description: Bad Request
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '401':
          description: Unauthorized
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '403':
          description: Forbidden
          schema:
            type: object
502
503
            required:
              - ProblemDetails
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '404':
          description: Not Found
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '406':
          description: Not Acceptable
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '429':
          description: Too Many Requests
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
      x-swagger-router-controller: Default
529
  /queries/s1_bearer_info:
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
    get:
      description: >-
        Gets information on existing E-RABs that are associated with a specific
        mobile edge application instance
      operationId: s1_bearer_infoGET
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/Query.TempUeId'
        - $ref: '#/parameters/Query.UeIpv4Address'
        - $ref: '#/parameters/Query.UeIpv6Address'
        - $ref: '#/parameters/Query.NatedIpAddress'
        - $ref: '#/parameters/Query.GtpTeId'
        - $ref: '#/parameters/Query.CellId'
        - $ref: '#/parameters/Query.ErabIdArr'
      responses:
        '200':
          description: Successful response to s1_bearer_info request
          schema:
            type: object
550
551
            required:
              - S1BearerInfo
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
            properties:
              S1BearerInfo:
                $ref: '#/definitions/S1BearerInfo'
          examples:
            application/json:
              S1BearerInfo:
                timeStamp:
                  seconds: 1577836800
                  nanoSeconds: 0
                s1UeInfo:
                  - tempUeId:
                      mmec: '0'
                      mtmsi: '1234'
                    associateId:
                      - type: '1'
                        value: 192.0.2.0
                      - type: '3'
                        value: 198.51.100.0
                    ecgi:
                      plmn:
                        mcc: '001'
                        mnc: '01'
574
                      cellId: '0x800000A'
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
                    s1BearerInfoDetailed:
                      - erabId: 1
                        s1EnbInfo:
                          ipAddress: 192.0.2.0
                          tunnelId: '1111'
                        sGwInfo:
                          ipAddress: 192.0.2.1
                          tunnelId: '2222'
                  - tempUeId:
                      mmec: '0'
                      mtmsi: '1234'
                    associateId:
                      type: '1'
                      value: 192.0.2.0
                    ecgi:
                      plmn:
                        mcc: '001'
                        mnc: '01'
593
                      cellId: '0x800000B'
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
                    s1BearerInfoDetailed:
                      - erabId: 2
                        s1EnbInfo:
                          ipAddress: 192.0.2.0
                          tunnelId: '3333'
                        sGwInfo:
                          ipAddress: 192.0.2.1
                          tunnelId: '4444'
        '400':
          description: Bad Request
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '401':
          description: Unauthorized
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '403':
          description: Forbidden
          schema:
            type: object
620
621
            required:
              - ProblemDetails
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '404':
          description: Not Found
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '406':
          description: Not Acceptable
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '429':
          description: Too Many Requests
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
      x-swagger-router-controller: Default
  /subscriptions/:
    get:
      description: >-
        The GET method can be used to request information about the
        subscriptions for this requestor
652
      operationId: SubscriptionLinkList_subscriptionsGET
653
654
655
656
657
658
659
660
661
662
      produces:
        - application/json
        - application/problem+json
      responses:
        '200':
          description: >-
            Response body contains the list of links to requestors
            subscriptions.
          schema:
            type: object
663
664
            required:
              - SubscriptionLinkList
665
            properties:
666
667
              SubscriptionLinkList:
                $ref: '#/definitions/SubscriptionLinkList'
668
669
670
671
672
          examples:
            application/json:
              SubscriptionLinkList:
                _links:
                  self: 'http://meAppServer.example.com/rni/v1/subscriptions'
673
                  subscription:
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
                    - href: >-
                        http://meAppClient.example.com/rni/v1/notifications/cell_change/77777
                      subscriptionType: CELL_CHANGE
                    - href: >-
                        http://meAppClient.example.com/rni/v1/notifications/MeasTa/77777
                      subscriptionType: MEAS_TIMING_ADVANCE
        '400':
          description: Bad Request
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '401':
          description: Unauthorized
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '403':
          description: Forbidden
          schema:
            type: object
698
699
            required:
              - ProblemDetails
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '404':
          description: Not Found
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '406':
          description: Not Acceptable
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '429':
          description: Too Many Requests
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
      x-swagger-router-controller: Default
  /subscriptions/cell_change:
    get:
      description: >-
        The GET method can be used to request information about the
        cell_change subscriptions for this requestor
730
      operationId: SubscriptionLinkList_subscriptions_cc_GET
731
732
733
734
735
736
737
738
739
740
      produces:
        - application/json
        - application/problem+json
      responses:
        '200':
          description: >-
            Response body contains the list of links to requestors
            cell_change subscriptions.
          schema:
            type: object
741
742
            required:
              - SubscriptionLinkList
743
744
            properties:
              SubscriptionLinkList:
745
                $ref: '#/definitions/SubscriptionLinkList'
746
747
748
749
750
          examples:
            application/json:
              SubscriptionLinkList:
                _links:
                  self: 'http://meAppServer.example.com/rni/v1/subscriptions/cell_change'
751
                  subscription:
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
                    - href: >-
                        http://meAppClient.example.com/rni/v1/notifications/cell_change/77777
                      subscriptionType: CELL_CHANGE
                    - href: >-
                        http://meAppClient.example.com/rni/v1/notifications/cell_change/77778
                      subscriptionType: CELL_CHANGE
        '400':
          description: Bad Request
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '401':
          description: Unauthorized
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '403':
          description: Forbidden
          schema:
            type: object
776
777
            required:
              - ProblemDetails
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '404':
          description: Not Found
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '406':
          description: Not Acceptable
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '429':
          description: Too Many Requests
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
      x-swagger-router-controller: Default
    post:
      description: >-
        Creates a subscription to cell change notifications from Radio Network
        Information Service
      operationId: CellChange_subscriptionsPOST
      produces:
        - application/json
        - application/problem+json
      parameters:
        - $ref: '#/parameters/Body.CellChangeSubscriptionPost'
      responses:
        '201':
          description: Successful subscription to response to UE cell change notifications
          schema:
            type: object
            properties:
              CellChangeSubscription:
                $ref: '#/definitions/CellChangeSubscription'
          examples:
            application/json:
              CellChangeSubscription:
                callbackReference: >-
                  http://meAppClient.example.com/rni/v1/notifications/cell_change/77777
                _links:
                  self: >-
                    http://meAppServer.example.com/rni/v1/subscriptions/cell_change/sub123
                filterCriteria:
                  associateId:
                    type: '1'
                    value: 192.0.2.0
                  plmn:
                    mnc: '01'
                    mcc: '001'
                  appInsId: '01'
                  trigger: 6
                  cellId: '0x800000B'
                expiryDeadline:
                  seconds: 1577836800
                  nanoSeconds: 0
        '400':
          description: Bad Request
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '401':
          description: Unauthorized
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '403':
          description: Forbidden
          schema:
            type: object
860
861
            required:
              - ProblemDetails
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '404':
          description: Not Found
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '406':
          description: Not Acceptable
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '415':
          description: Unsupported Media Type
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '422':
          description: Unprocessable Entity
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
893
          examples:
894
895
896
            'application/problem+json':
              ProblemDetails:
                type: 'https://meAppServer.example.com/rni/v1/probs/too-many-targets'
897
                title: Too many targets
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
                status: '422'
                detail: The target area for the request is considered too large
                instance: '/meAppClient.example.com/77777/msgs/abc'
        '429':
          description: Too Many Requests
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
      x-swagger-router-controller: Default
  '/subscriptions/cell_change/{subscriptionId}':
    get:
      description: Get cell change subscription information
      operationId: CellChange_subscriptionsGET
      produces:
        - application/json
        - application/problem+json
      parameters:
        - $ref: '#/parameters/Path.subscrId'
      responses:
        '200':
          description: Subscription information regarding cell change notifications
          schema:
            type: object
923
924
            required:
              - CellChangeSubscription
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
            properties:
              CellChangeSubscription:
                $ref: '#/definitions/CellChangeSubscription'
          examples:
            application/json:
              CellChangeSubscription:
                callbackReference: >-
                  http://meAppClient.example.com/rni/v1/notifications/cell_change/77777
                _links:
                  self: >-
                    http://meAppServer.example.com/rni/v1/subscriptions/cell_change/sub123
                filterCriteria:
                  appInsId: '01'
                  associateId:
                    type: '1'
                    value: 192.0.2.0
                  plmn:
                    mnc: '01'
                    mcc: '001'
                  cellId: '0x800000B'
                  hoStatus: 3
                expiryDeadline:
                  seconds: 1577836800
                  nanoSeconds: 0
        '400':
          description: Bad Request
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '401':
          description: Unauthorized
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '403':
          description: Forbidden
          schema:
            type: object
967
968
            required:
              - ProblemDetails
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '404':
          description: Not Found
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '406':
          description: Not Acceptable
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '429':
          description: Too Many Requests
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
    put:
      description: >-
        Updates a subscription to cell change notifications from Radio Network
        Information Service
      operationId: CellChange_subscriptionsPUT
      produces:
        - application/json
        - application/problem+json
For faster browsing, not all history is shown. View entire blame