docs/apis/api.rst

   1 DMaaP Bus Controller REST API 1.1.0
   2 ===================================
   3
   4 Description
   5 ~~~~~~~~~~~
   6
   7     Bus Controller provides an API for OpenDCAE components which need to provision
   8     underlying DMaaP technologies (Data Router and Message Router).
   9     Primary clients for this API are anticipated to be the OpenDCAE
  10     Controller, OpenDCAE Orchestrator, OpenDCAE Inventory and the
  11     ECOMP Portal.
  12
  13     Objects managed by DMaaP are deployed in a dcaeLocation which is a
  14     unique identifier for an OpenStack tenant for a dcaeLayer,
  15     opendcae-central (aka ecomp) or opendcae-local-ntc (aka edge).
  16
  17     A dcaeEnvironment (e.g. FTL or prod) has a single DMaaP. A
  18     DMaaP is managed by a one or more stateless DMaaP Bus
  19     Controller(s), though Bus Controller relies on PGaaS for
  20     persistence. Each DMaaP has a single instance of Data Router,
  21     which has 1 or more DR_Nodes deployed at each dcaeLocation. DR
  22     Clients of type DR_Pub generally publish to a DR_Node that is
  23     local to its dcaeLocation. Routing for a Feed is determined by
  24     the dcaelocation of its DR_Sub clients.
  25
  26     A DMaaP may have many Message Router instances. Each instance is
  27     deployed as an MR_Cluster. One MR_Cluster is deployed at each
  28     dcaeLocation. MR_Clients generally communicate to the
  29     MR_Cluster at the same dcaeLocation. Replication of messages
  30     between MR_Clusters is accomplished by MR Bridge, which is
  31     provioned by DMaaP Bus Controller based on Topic attributes.
  32
  33     Therefore, the role of DMaaP Bus Controller is to support other
  34     DCAE infrastructure components to dynamically provision DMaaP
  35     services on behalf of DMaaP clients, and to assist in any
  36     management or discovery activity of its clients.
  37
  38     A convention of this API is to return JSON responses per
  39     OpenStack style.
  40
  41
  42
  43 Contact Information
  44 ~~~~~~~~~~~~~~~~~~~
  45
  46
  47
  48
  49 http://www.onap.org
  50
  51
  52
  53
  54 License
  55 ~~~~~~~
  56
  57
  58 `Licensed under the Apache License, Version 2.0 <http://www.apache.org/licenses/LICENSE-2.0>`_
  59
  60
  61
  62
  63 Base URL
  64 ~~~~~~~~
  65
  66 http://www.[host]:[port]/webapi
  67 https://www.[host]:[port]/webapi
  68
  69 BRIDGE
  70 ~~~~~~
  71
  72
  73 Endpoint for retreiving MR Bridge metrics
  74
  75
  76
  77
  78
  79 GET ``/bridge``
  80 ---------------
  81
  82
  83 Summary
  84 +++++++
  85
  86 return BrTopic details
  87
  88 Description
  89 +++++++++++
  90
  91 .. raw:: html
  92
  93     Returns array of  `BrTopic` objects. If source and target query params are specified, only report on that bridge.  If detail param is true, list topics names, else just a count is returned.
  94
  95 Parameters
  96 ++++++++++
  97
  98 .. csv-table::
  99     :delim: |
 100     :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
 101     :widths: 20, 15, 10, 10, 10, 20, 30
 102
 103         mmagent | query | No | string |  |  |
 104         detail | query | No | boolean |  |  |
 105
 106
 107 Request
 108 +++++++
 109
 110
 111 Responses
 112 +++++++++
 113
 114 **200**
 115 ^^^^^^^
 116
 117 Success
 118
 119
 120 Type: :ref:`BrTopic <d_d71baea9d8e4e59bc395ef51f45dff1b>`
 121
 122 **Example:**
 123
 124 .. code-block:: javascript
 125
 126     {
 127         "brSource": "somestring",
 128         "brTarget": "somestring",
 129         "mmAgentName": "somestring",
 130         "topicCount": 1
 131     }
 132
 133 **400**
 134 ^^^^^^^
 135
 136 Error
 137
 138
 139 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
 140
 141 **Example:**
 142
 143 .. code-block:: javascript
 144
 145     {
 146         "code": 1,
 147         "fields": "somestring",
 148         "is2xx": true,
 149         "message": "somestring"
 150     }
 151
 152
 153
 154
 155
 156 PUT ``/bridge``
 157 ---------------
 158
 159
 160 Summary
 161 +++++++
 162
 163 update MirrorMaker details
 164
 165 Description
 166 +++++++++++
 167
 168 .. raw:: html
 169
 170     replace the topic list for a specific Bridge.  Use JSON Body for value to replace whitelist, but if refreshFlag param is true, simply refresh using existing whitelist.If split param is true, spread whitelist over smaller mmagents.
 171
 172 Parameters
 173 ++++++++++
 174
 175 .. csv-table::
 176     :delim: |
 177     :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
 178     :widths: 20, 15, 10, 10, 10, 20, 30
 179
 180         mmagent | query | No | string |  |  |
 181         refresh | query | No | boolean |  |  |
 182         split | query | No | boolean |  |  |
 183
 184
 185 Request
 186 +++++++
 187
 188
 189 Responses
 190 +++++++++
 191
 192 **200**
 193 ^^^^^^^
 194
 195 Success
 196
 197
 198 Type: :ref:`BrTopic <d_d71baea9d8e4e59bc395ef51f45dff1b>`
 199
 200 **Example:**
 201
 202 .. code-block:: javascript
 203
 204     {
 205         "brSource": "somestring",
 206         "brTarget": "somestring",
 207         "mmAgentName": "somestring",
 208         "topicCount": 1
 209     }
 210
 211 **400**
 212 ^^^^^^^
 213
 214 Error
 215
 216
 217 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
 218
 219 **Example:**
 220
 221 .. code-block:: javascript
 222
 223     {
 224         "code": 1,
 225         "fields": "somestring",
 226         "is2xx": true,
 227         "message": "somestring"
 228     }
 229
 230
 231
 232
 233 DCAELOCATIONS
 234 ~~~~~~~~~~~~~
 235
 236
 237 an OpenStack tenant purposed for OpenDCAE (i.e. where OpenDCAE components might be deployed)
 238
 239
 240
 241
 242
 243 POST ``/dcaeLocations``
 244 -----------------------
 245
 246
 247 Summary
 248 +++++++
 249
 250 return dcaeLocation details
 251
 252 Description
 253 +++++++++++
 254
 255 .. raw:: html
 256
 257     Create some `dcaeLocation` which is a unique identifier for an *OpenStack* tenant purposed for a *dcaeLayer*  (ecomp or edge).
 258
 259
 260 Request
 261 +++++++
 262
 263
 264 Responses
 265 +++++++++
 266
 267 **200**
 268 ^^^^^^^
 269
 270 Success
 271
 272
 273 Type: :ref:`DcaeLocation <d_47d80e451933beb623fcf5257867cbcb>`
 274
 275 **Example:**
 276
 277 .. code-block:: javascript
 278
 279     {
 280         "central": true,
 281         "clli": "somestring",
 282         "dcaeLayer": "somestring",
 283         "dcaeLocationName": "somestring",
 284         "lastMod": "2015-01-01T15:00:00.000Z",
 285         "local": true,
 286         "openStackAvailabilityZone": "somestring",
 287         "status": "EMPTY",
 288         "subnet": "somestring"
 289     }
 290
 291 **400**
 292 ^^^^^^^
 293
 294 Error
 295
 296
 297 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
 298
 299 **Example:**
 300
 301 .. code-block:: javascript
 302
 303     {
 304         "code": 1,
 305         "fields": "somestring",
 306         "is2xx": true,
 307         "message": "somestring"
 308     }
 309
 310
 311
 312
 313
 314 DELETE ``/dcaeLocations/{locationName}``
 315 ----------------------------------------
 316
 317
 318 Summary
 319 +++++++
 320
 321 return dcaeLocation details
 322
 323 Description
 324 +++++++++++
 325
 326 .. raw:: html
 327
 328     delete a dcaeLocation
 329
 330 Parameters
 331 ++++++++++
 332
 333 .. csv-table::
 334     :delim: |
 335     :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
 336     :widths: 20, 15, 10, 10, 10, 20, 30
 337
 338         locationName | path | Yes | string |  |  |
 339
 340
 341 Request
 342 +++++++
 343
 344
 345 Responses
 346 +++++++++
 347
 348 **200**
 349 ^^^^^^^
 350
 351 successful operation
 352
 353
 354 Type: :ref:`DcaeLocation <d_47d80e451933beb623fcf5257867cbcb>`
 355
 356 **Example:**
 357
 358 .. code-block:: javascript
 359
 360     {
 361         "central": true,
 362         "clli": "somestring",
 363         "dcaeLayer": "somestring",
 364         "dcaeLocationName": "somestring",
 365         "lastMod": "2015-01-01T15:00:00.000Z",
 366         "local": true,
 367         "openStackAvailabilityZone": "somestring",
 368         "status": "EMPTY",
 369         "subnet": "somestring"
 370     }
 371
 372 **204**
 373 ^^^^^^^
 374
 375 Success
 376
 377
 378 Type: :ref:`DcaeLocation <d_47d80e451933beb623fcf5257867cbcb>`
 379
 380 **Example:**
 381
 382 .. code-block:: javascript
 383
 384     {
 385         "central": true,
 386         "clli": "somestring",
 387         "dcaeLayer": "somestring",
 388         "dcaeLocationName": "somestring",
 389         "lastMod": "2015-01-01T15:00:00.000Z",
 390         "local": true,
 391         "openStackAvailabilityZone": "somestring",
 392         "status": "EMPTY",
 393         "subnet": "somestring"
 394     }
 395
 396 **400**
 397 ^^^^^^^
 398
 399 Error
 400
 401
 402 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
 403
 404 **Example:**
 405
 406 .. code-block:: javascript
 407
 408     {
 409         "code": 1,
 410         "fields": "somestring",
 411         "is2xx": true,
 412         "message": "somestring"
 413     }
 414
 415
 416
 417
 418
 419 GET ``/dcaeLocations/{locationName}``
 420 -------------------------------------
 421
 422
 423 Summary
 424 +++++++
 425
 426 return dcaeLocation details
 427
 428 Description
 429 +++++++++++
 430
 431 .. raw:: html
 432
 433     Returns a specific `dcaeLocation` object with specified tag
 434
 435 Parameters
 436 ++++++++++
 437
 438 .. csv-table::
 439     :delim: |
 440     :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
 441     :widths: 20, 15, 10, 10, 10, 20, 30
 442
 443         locationName | path | Yes | string |  |  |
 444
 445
 446 Request
 447 +++++++
 448
 449
 450 Responses
 451 +++++++++
 452
 453 **200**
 454 ^^^^^^^
 455
 456 Success
 457
 458
 459 Type: :ref:`DcaeLocation <d_47d80e451933beb623fcf5257867cbcb>`
 460
 461 **Example:**
 462
 463 .. code-block:: javascript
 464
 465     {
 466         "central": true,
 467         "clli": "somestring",
 468         "dcaeLayer": "somestring",
 469         "dcaeLocationName": "somestring",
 470         "lastMod": "2015-01-01T15:00:00.000Z",
 471         "local": true,
 472         "openStackAvailabilityZone": "somestring",
 473         "status": "EMPTY",
 474         "subnet": "somestring"
 475     }
 476
 477 **400**
 478 ^^^^^^^
 479
 480 Error
 481
 482
 483 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
 484
 485 **Example:**
 486
 487 .. code-block:: javascript
 488
 489     {
 490         "code": 1,
 491         "fields": "somestring",
 492         "is2xx": true,
 493         "message": "somestring"
 494     }
 495
 496
 497
 498
 499
 500 GET ``/dcaeLocations``
 501 ----------------------
 502
 503
 504 Summary
 505 +++++++
 506
 507 return dcaeLocation details
 508
 509 Description
 510 +++++++++++
 511
 512 .. raw:: html
 513
 514     Returns array of  `dcaeLocation` objects.  All objects managed by DMaaP are deployed in some `dcaeLocation` which is a unique identifier for an *OpenStack* tenant purposed for a *dcaeLayer*  (ecomp or edge).
 515
 516
 517 Request
 518 +++++++
 519
 520
 521 Responses
 522 +++++++++
 523
 524 **200**
 525 ^^^^^^^
 526
 527 Success
 528
 529
 530 Type: :ref:`DcaeLocation <d_47d80e451933beb623fcf5257867cbcb>`
 531
 532 **Example:**
 533
 534 .. code-block:: javascript
 535
 536     {
 537         "central": true,
 538         "clli": "somestring",
 539         "dcaeLayer": "somestring",
 540         "dcaeLocationName": "somestring",
 541         "lastMod": "2015-01-01T15:00:00.000Z",
 542         "local": true,
 543         "openStackAvailabilityZone": "somestring",
 544         "status": "EMPTY",
 545         "subnet": "somestring"
 546     }
 547
 548 **400**
 549 ^^^^^^^
 550
 551 Error
 552
 553
 554 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
 555
 556 **Example:**
 557
 558 .. code-block:: javascript
 559
 560     {
 561         "code": 1,
 562         "fields": "somestring",
 563         "is2xx": true,
 564         "message": "somestring"
 565     }
 566
 567
 568
 569
 570
 571 PUT ``/dcaeLocations/{locationName}``
 572 -------------------------------------
 573
 574
 575 Summary
 576 +++++++
 577
 578 return dcaeLocation details
 579
 580 Description
 581 +++++++++++
 582
 583 .. raw:: html
 584
 585     update the openStackAvailabilityZone of a dcaeLocation
 586
 587 Parameters
 588 ++++++++++
 589
 590 .. csv-table::
 591     :delim: |
 592     :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
 593     :widths: 20, 15, 10, 10, 10, 20, 30
 594
 595         locationName | path | Yes | string |  |  |
 596
 597
 598 Request
 599 +++++++
 600
 601
 602 Responses
 603 +++++++++
 604
 605 **200**
 606 ^^^^^^^
 607
 608 Success
 609
 610
 611 Type: :ref:`DcaeLocation <d_47d80e451933beb623fcf5257867cbcb>`
 612
 613 **Example:**
 614
 615 .. code-block:: javascript
 616
 617     {
 618         "central": true,
 619         "clli": "somestring",
 620         "dcaeLayer": "somestring",
 621         "dcaeLocationName": "somestring",
 622         "lastMod": "2015-01-01T15:00:00.000Z",
 623         "local": true,
 624         "openStackAvailabilityZone": "somestring",
 625         "status": "EMPTY",
 626         "subnet": "somestring"
 627     }
 628
 629 **400**
 630 ^^^^^^^
 631
 632 Error
 633
 634
 635 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
 636
 637 **Example:**
 638
 639 .. code-block:: javascript
 640
 641     {
 642         "code": 1,
 643         "fields": "somestring",
 644         "is2xx": true,
 645         "message": "somestring"
 646     }
 647
 648
 649
 650
 651 DMAAP
 652 ~~~~~
 653
 654
 655 V2 Endpoint for this instance of DMaaP object containing values for this OpenDCAE deployment
 656
 657
 658
 659
 660
 661 POST ``/dmaap_v2``
 662 ------------------
 663
 664
 665 Summary
 666 +++++++
 667
 668 return dmaap details
 669
 670 Description
 671 +++++++++++
 672
 673 .. raw:: html
 674
 675     Create a new DMaaP set system wide configuration settings for the *dcaeEnvironment*.  Deprecated with introduction of persistence in 1610.
 676
 677
 678 Request
 679 +++++++
 680
 681
 682 Responses
 683 +++++++++
 684
 685 **200**
 686 ^^^^^^^
 687
 688 Success
 689
 690
 691 Type: :ref:`Dmaap <d_4ea0e7758a1f8502222793e4a13b04f7>`
 692
 693 **Example:**
 694
 695 .. code-block:: javascript
 696
 697     {
 698         "accessKeyOwner": "somestring",
 699         "bridgeAdminTopic": "somestring",
 700         "dmaapName": "somestring",
 701         "drProvUrl": "somestring",
 702         "lastMod": "2015-01-01T15:00:00.000Z",
 703         "loggingUrl": "somestring",
 704         "nodeKey": "somestring",
 705         "status": "EMPTY",
 706         "topicNsRoot": "somestring",
 707         "version": "somestring"
 708     }
 709
 710 **400**
 711 ^^^^^^^
 712
 713 Error
 714
 715
 716 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
 717
 718 **Example:**
 719
 720 .. code-block:: javascript
 721
 722     {
 723         "code": 1,
 724         "fields": "somestring",
 725         "is2xx": true,
 726         "message": "somestring"
 727     }
 728
 729
 730
 731
 732
 733 POST ``/dmaap``
 734 ---------------
 735
 736
 737 Summary
 738 +++++++
 739
 740 return dmaap details
 741
 742 Description
 743 +++++++++++
 744
 745 .. raw:: html
 746
 747     Create a new DMaaP set system wide configuration settings for the *dcaeEnvironment*.  Deprecated with introduction of persistence in 1610.
 748
 749
 750 Request
 751 +++++++
 752
 753
 754 Responses
 755 +++++++++
 756
 757 **200**
 758 ^^^^^^^
 759
 760 Success
 761
 762
 763 Type: :ref:`Dmaap <d_4ea0e7758a1f8502222793e4a13b04f7>`
 764
 765 **Example:**
 766
 767 .. code-block:: javascript
 768
 769     {
 770         "accessKeyOwner": "somestring",
 771         "bridgeAdminTopic": "somestring",
 772         "dmaapName": "somestring",
 773         "drProvUrl": "somestring",
 774         "lastMod": "2015-01-01T15:00:00.000Z",
 775         "loggingUrl": "somestring",
 776         "nodeKey": "somestring",
 777         "status": "EMPTY",
 778         "topicNsRoot": "somestring",
 779         "version": "somestring"
 780     }
 781
 782 **400**
 783 ^^^^^^^
 784
 785 Error
 786
 787
 788 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
 789
 790 **Example:**
 791
 792 .. code-block:: javascript
 793
 794     {
 795         "code": 1,
 796         "fields": "somestring",
 797         "is2xx": true,
 798         "message": "somestring"
 799     }
 800
 801
 802
 803
 804
 805 GET ``/dmaap_v2``
 806 -----------------
 807
 808
 809 Summary
 810 +++++++
 811
 812 return dmaap details
 813
 814 Description
 815 +++++++++++
 816
 817 .. raw:: html
 818
 819     returns the `dmaap` object, which contains system wide configuration settings
 820
 821
 822 Request
 823 +++++++
 824
 825
 826 Responses
 827 +++++++++
 828
 829 **200**
 830 ^^^^^^^
 831
 832 Success
 833
 834
 835 Type: :ref:`Dmaap <d_4ea0e7758a1f8502222793e4a13b04f7>`
 836
 837 **Example:**
 838
 839 .. code-block:: javascript
 840
 841     {
 842         "accessKeyOwner": "somestring",
 843         "bridgeAdminTopic": "somestring",
 844         "dmaapName": "somestring",
 845         "drProvUrl": "somestring",
 846         "lastMod": "2015-01-01T15:00:00.000Z",
 847         "loggingUrl": "somestring",
 848         "nodeKey": "somestring",
 849         "status": "EMPTY",
 850         "topicNsRoot": "somestring",
 851         "version": "somestring"
 852     }
 853
 854 **400**
 855 ^^^^^^^
 856
 857 Error
 858
 859
 860 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
 861
 862 **Example:**
 863
 864 .. code-block:: javascript
 865
 866     {
 867         "code": 1,
 868         "fields": "somestring",
 869         "is2xx": true,
 870         "message": "somestring"
 871     }
 872
 873
 874
 875
 876
 877 GET ``/dmaap``
 878 --------------
 879
 880
 881 Summary
 882 +++++++
 883
 884 return dmaap details
 885
 886 Description
 887 +++++++++++
 888
 889 .. raw:: html
 890
 891     returns the `dmaap` object, which contains system wide configuration settings
 892
 893
 894 Request
 895 +++++++
 896
 897
 898 Responses
 899 +++++++++
 900
 901 **200**
 902 ^^^^^^^
 903
 904 Success
 905
 906
 907 Type: :ref:`Dmaap <d_4ea0e7758a1f8502222793e4a13b04f7>`
 908
 909 **Example:**
 910
 911 .. code-block:: javascript
 912
 913     {
 914         "accessKeyOwner": "somestring",
 915         "bridgeAdminTopic": "somestring",
 916         "dmaapName": "somestring",
 917         "drProvUrl": "somestring",
 918         "lastMod": "2015-01-01T15:00:00.000Z",
 919         "loggingUrl": "somestring",
 920         "nodeKey": "somestring",
 921         "status": "EMPTY",
 922         "topicNsRoot": "somestring",
 923         "version": "somestring"
 924     }
 925
 926 **400**
 927 ^^^^^^^
 928
 929 Error
 930
 931
 932 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
 933
 934 **Example:**
 935
 936 .. code-block:: javascript
 937
 938     {
 939         "code": 1,
 940         "fields": "somestring",
 941         "is2xx": true,
 942         "message": "somestring"
 943     }
 944
 945
 946
 947
 948
 949 PUT ``/dmaap_v2``
 950 -----------------
 951
 952
 953 Summary
 954 +++++++
 955
 956 return dmaap details
 957
 958 Description
 959 +++++++++++
 960
 961 .. raw:: html
 962
 963     Update system settings for *dcaeEnvironment*.
 964
 965
 966 Request
 967 +++++++
 968
 969
 970 Responses
 971 +++++++++
 972
 973 **200**
 974 ^^^^^^^
 975
 976 Success
 977
 978
 979 Type: :ref:`Dmaap <d_4ea0e7758a1f8502222793e4a13b04f7>`
 980
 981 **Example:**
 982
 983 .. code-block:: javascript
 984
 985     {
 986         "accessKeyOwner": "somestring",
 987         "bridgeAdminTopic": "somestring",
 988         "dmaapName": "somestring",
 989         "drProvUrl": "somestring",
 990         "lastMod": "2015-01-01T15:00:00.000Z",
 991         "loggingUrl": "somestring",
 992         "nodeKey": "somestring",
 993         "status": "EMPTY",
 994         "topicNsRoot": "somestring",
 995         "version": "somestring"
 996     }
 997
 998 **400**
 999 ^^^^^^^
1000
1001 Error
1002
1003
1004 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
1005
1006 **Example:**
1007
1008 .. code-block:: javascript
1009
1010     {
1011         "code": 1,
1012         "fields": "somestring",
1013         "is2xx": true,
1014         "message": "somestring"
1015     }
1016
1017
1018
1019
1020
1021 PUT ``/dmaap``
1022 --------------
1023
1024
1025 Summary
1026 +++++++
1027
1028 return dmaap details
1029
1030 Description
1031 +++++++++++
1032
1033 .. raw:: html
1034
1035     Update system settings for *dcaeEnvironment*.
1036
1037
1038 Request
1039 +++++++
1040
1041
1042 Responses
1043 +++++++++
1044
1045 **200**
1046 ^^^^^^^
1047
1048 Success
1049
1050
1051 Type: :ref:`Dmaap <d_4ea0e7758a1f8502222793e4a13b04f7>`
1052
1053 **Example:**
1054
1055 .. code-block:: javascript
1056
1057     {
1058         "accessKeyOwner": "somestring",
1059         "bridgeAdminTopic": "somestring",
1060         "dmaapName": "somestring",
1061         "drProvUrl": "somestring",
1062         "lastMod": "2015-01-01T15:00:00.000Z",
1063         "loggingUrl": "somestring",
1064         "nodeKey": "somestring",
1065         "status": "EMPTY",
1066         "topicNsRoot": "somestring",
1067         "version": "somestring"
1068     }
1069
1070 **400**
1071 ^^^^^^^
1072
1073 Error
1074
1075
1076 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
1077
1078 **Example:**
1079
1080 .. code-block:: javascript
1081
1082     {
1083         "code": 1,
1084         "fields": "somestring",
1085         "is2xx": true,
1086         "message": "somestring"
1087     }
1088
1089
1090
1091
1092 DR_NODES
1093 ~~~~~~~~
1094
1095
1096 Endpoint for a Data Router Node server
1097
1098
1099
1100
1101
1102 POST ``/dr_nodes``
1103 ------------------
1104
1105
1106 Summary
1107 +++++++
1108
1109 return DR_Node details
1110
1111 Description
1112 +++++++++++
1113
1114 .. raw:: html
1115
1116     create a `DR_Node` in a *dcaeLocation*.  Note that multiple `DR_Node`s may exist in the same `dcaeLocation`.
1117
1118
1119 Request
1120 +++++++
1121
1122
1123 Responses
1124 +++++++++
1125
1126 **200**
1127 ^^^^^^^
1128
1129 Success
1130
1131
1132 Type: :ref:`DR_Node <d_d15e2cee407536866c875375e3f705e0>`
1133
1134 **Example:**
1135
1136 .. code-block:: javascript
1137
1138     {
1139         "dcaeLocationName": "somestring",
1140         "fqdn": "somestring",
1141         "hostName": "somestring",
1142         "lastMod": "2015-01-01T15:00:00.000Z",
1143         "status": "EMPTY",
1144         "version": "somestring"
1145     }
1146
1147 **400**
1148 ^^^^^^^
1149
1150 Error
1151
1152
1153 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
1154
1155 **Example:**
1156
1157 .. code-block:: javascript
1158
1159     {
1160         "code": 1,
1161         "fields": "somestring",
1162         "is2xx": true,
1163         "message": "somestring"
1164     }
1165
1166
1167
1168
1169
1170 DELETE ``/dr_nodes/{fqdn}``
1171 ---------------------------
1172
1173
1174 Summary
1175 +++++++
1176
1177 No Content
1178
1179 Description
1180 +++++++++++
1181
1182 .. raw:: html
1183
1184     Delete a single `DR_Node` object.
1185
1186 Parameters
1187 ++++++++++
1188
1189 .. csv-table::
1190     :delim: |
1191     :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
1192     :widths: 20, 15, 10, 10, 10, 20, 30
1193
1194         fqdn | path | Yes | string |  |  |
1195
1196
1197 Request
1198 +++++++
1199
1200
1201 Responses
1202 +++++++++
1203
1204 **200**
1205 ^^^^^^^
1206
1207 successful operation
1208
1209
1210 Type: :ref:`DR_Node <d_d15e2cee407536866c875375e3f705e0>`
1211
1212 **Example:**
1213
1214 .. code-block:: javascript
1215
1216     {
1217         "dcaeLocationName": "somestring",
1218         "fqdn": "somestring",
1219         "hostName": "somestring",
1220         "lastMod": "2015-01-01T15:00:00.000Z",
1221         "status": "EMPTY",
1222         "version": "somestring"
1223     }
1224
1225 **204**
1226 ^^^^^^^
1227
1228 Success
1229
1230
1231 Type: :ref:`DR_Node <d_d15e2cee407536866c875375e3f705e0>`
1232
1233 **Example:**
1234
1235 .. code-block:: javascript
1236
1237     {
1238         "dcaeLocationName": "somestring",
1239         "fqdn": "somestring",
1240         "hostName": "somestring",
1241         "lastMod": "2015-01-01T15:00:00.000Z",
1242         "status": "EMPTY",
1243         "version": "somestring"
1244     }
1245
1246 **400**
1247 ^^^^^^^
1248
1249 Error
1250
1251
1252 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
1253
1254 **Example:**
1255
1256 .. code-block:: javascript
1257
1258     {
1259         "code": 1,
1260         "fields": "somestring",
1261         "is2xx": true,
1262         "message": "somestring"
1263     }
1264
1265
1266
1267
1268
1269 GET ``/dr_nodes/{fqdn}``
1270 ------------------------
1271
1272
1273 Summary
1274 +++++++
1275
1276 return DR_Node details
1277
1278 Description
1279 +++++++++++
1280
1281 .. raw:: html
1282
1283     Retrieve a single `DR_Node` object.
1284
1285 Parameters
1286 ++++++++++
1287
1288 .. csv-table::
1289     :delim: |
1290     :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
1291     :widths: 20, 15, 10, 10, 10, 20, 30
1292
1293         fqdn | path | Yes | string |  |  |
1294
1295
1296 Request
1297 +++++++
1298
1299
1300 Responses
1301 +++++++++
1302
1303 **200**
1304 ^^^^^^^
1305
1306 Success
1307
1308
1309 Type: :ref:`DR_Node <d_d15e2cee407536866c875375e3f705e0>`
1310
1311 **Example:**
1312
1313 .. code-block:: javascript
1314
1315     {
1316         "dcaeLocationName": "somestring",
1317         "fqdn": "somestring",
1318         "hostName": "somestring",
1319         "lastMod": "2015-01-01T15:00:00.000Z",
1320         "status": "EMPTY",
1321         "version": "somestring"
1322     }
1323
1324 **400**
1325 ^^^^^^^
1326
1327 Error
1328
1329
1330 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
1331
1332 **Example:**
1333
1334 .. code-block:: javascript
1335
1336     {
1337         "code": 1,
1338         "fields": "somestring",
1339         "is2xx": true,
1340         "message": "somestring"
1341     }
1342
1343
1344
1345
1346
1347 GET ``/dr_nodes``
1348 -----------------
1349
1350
1351 Summary
1352 +++++++
1353
1354 return DR_Node details
1355
1356 Description
1357 +++++++++++
1358
1359 .. raw:: html
1360
1361     Returns array of `DR_Node` object array.  Need to add filter by dcaeLocation.
1362
1363
1364 Request
1365 +++++++
1366
1367
1368 Responses
1369 +++++++++
1370
1371 **200**
1372 ^^^^^^^
1373
1374 Success
1375
1376
1377 Type: :ref:`DR_Node <d_d15e2cee407536866c875375e3f705e0>`
1378
1379 **Example:**
1380
1381 .. code-block:: javascript
1382
1383     {
1384         "dcaeLocationName": "somestring",
1385         "fqdn": "somestring",
1386         "hostName": "somestring",
1387         "lastMod": "2015-01-01T15:00:00.000Z",
1388         "status": "EMPTY",
1389         "version": "somestring"
1390     }
1391
1392 **400**
1393 ^^^^^^^
1394
1395 Error
1396
1397
1398 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
1399
1400 **Example:**
1401
1402 .. code-block:: javascript
1403
1404     {
1405         "code": 1,
1406         "fields": "somestring",
1407         "is2xx": true,
1408         "message": "somestring"
1409     }
1410
1411
1412
1413
1414
1415 PUT ``/dr_nodes/{fqdn}``
1416 ------------------------
1417
1418
1419 Summary
1420 +++++++
1421
1422 return DR_Node details
1423
1424 Description
1425 +++++++++++
1426
1427 .. raw:: html
1428
1429     Update a single `DR_Node` object.
1430
1431 Parameters
1432 ++++++++++
1433
1434 .. csv-table::
1435     :delim: |
1436     :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
1437     :widths: 20, 15, 10, 10, 10, 20, 30
1438
1439         fqdn | path | Yes | string |  |  |
1440
1441
1442 Request
1443 +++++++
1444
1445
1446 Responses
1447 +++++++++
1448
1449 **200**
1450 ^^^^^^^
1451
1452 Success
1453
1454
1455 Type: :ref:`DR_Node <d_d15e2cee407536866c875375e3f705e0>`
1456
1457 **Example:**
1458
1459 .. code-block:: javascript
1460
1461     {
1462         "dcaeLocationName": "somestring",
1463         "fqdn": "somestring",
1464         "hostName": "somestring",
1465         "lastMod": "2015-01-01T15:00:00.000Z",
1466         "status": "EMPTY",
1467         "version": "somestring"
1468     }
1469
1470 **400**
1471 ^^^^^^^
1472
1473 Error
1474
1475
1476 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
1477
1478 **Example:**
1479
1480 .. code-block:: javascript
1481
1482     {
1483         "code": 1,
1484         "fields": "somestring",
1485         "is2xx": true,
1486         "message": "somestring"
1487     }
1488
1489
1490
1491
1492 DR_PUBS
1493 ~~~~~~~
1494
1495
1496 Endpoint for a Data Router client that implements a Publisher
1497
1498
1499
1500
1501
1502 POST ``/dr_pubs``
1503 -----------------
1504
1505
1506 Summary
1507 +++++++
1508
1509 return DR_Pub details
1510
1511 Description
1512 +++++++++++
1513
1514 .. raw:: html
1515
1516     create a DR Publisher in the specified environment.
1517
1518
1519 Request
1520 +++++++
1521
1522
1523 Responses
1524 +++++++++
1525
1526 **200**
1527 ^^^^^^^
1528
1529 Success
1530
1531
1532 Type: :ref:`DR_Pub <d_e926d3fa8701e0cc9c8ed1761b3255cd>`
1533
1534 **Example:**
1535
1536 .. code-block:: javascript
1537
1538     {
1539         "dcaeLocationName": "somestring",
1540         "feedId": "somestring",
1541         "lastMod": "2015-01-01T15:00:00.000Z",
1542         "pubId": "somestring",
1543         "status": "EMPTY",
1544         "username": "somestring",
1545         "userpwd": "somestring"
1546     }
1547
1548 **400**
1549 ^^^^^^^
1550
1551 Error
1552
1553
1554 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
1555
1556 **Example:**
1557
1558 .. code-block:: javascript
1559
1560     {
1561         "code": 1,
1562         "fields": "somestring",
1563         "is2xx": true,
1564         "message": "somestring"
1565     }
1566
1567
1568
1569
1570
1571 DELETE ``/dr_pubs/{pubId}``
1572 ---------------------------
1573
1574
1575 Summary
1576 +++++++
1577
1578 return DR_Pub details
1579
1580 Description
1581 +++++++++++
1582
1583 .. raw:: html
1584
1585     delete a DR Publisher in the specified environment. Delete a `DR_Pub` object by pubId
1586
1587 Parameters
1588 ++++++++++
1589
1590 .. csv-table::
1591     :delim: |
1592     :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
1593     :widths: 20, 15, 10, 10, 10, 20, 30
1594
1595         pubId | path | Yes | string |  |  |
1596
1597
1598 Request
1599 +++++++
1600
1601
1602 Responses
1603 +++++++++
1604
1605 **200**
1606 ^^^^^^^
1607
1608 successful operation
1609
1610
1611 Type: :ref:`DR_Pub <d_e926d3fa8701e0cc9c8ed1761b3255cd>`
1612
1613 **Example:**
1614
1615 .. code-block:: javascript
1616
1617     {
1618         "dcaeLocationName": "somestring",
1619         "feedId": "somestring",
1620         "lastMod": "2015-01-01T15:00:00.000Z",
1621         "pubId": "somestring",
1622         "status": "EMPTY",
1623         "username": "somestring",
1624         "userpwd": "somestring"
1625     }
1626
1627 **204**
1628 ^^^^^^^
1629
1630 Success
1631
1632
1633 Type: :ref:`DR_Pub <d_e926d3fa8701e0cc9c8ed1761b3255cd>`
1634
1635 **Example:**
1636
1637 .. code-block:: javascript
1638
1639     {
1640         "dcaeLocationName": "somestring",
1641         "feedId": "somestring",
1642         "lastMod": "2015-01-01T15:00:00.000Z",
1643         "pubId": "somestring",
1644         "status": "EMPTY",
1645         "username": "somestring",
1646         "userpwd": "somestring"
1647     }
1648
1649 **400**
1650 ^^^^^^^
1651
1652 Error
1653
1654
1655 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
1656
1657 **Example:**
1658
1659 .. code-block:: javascript
1660
1661     {
1662         "code": 1,
1663         "fields": "somestring",
1664         "is2xx": true,
1665         "message": "somestring"
1666     }
1667
1668
1669
1670
1671
1672 GET ``/dr_pubs/{pubId}``
1673 ------------------------
1674
1675
1676 Summary
1677 +++++++
1678
1679 return DR_Pub details
1680
1681 Description
1682 +++++++++++
1683
1684 .. raw:: html
1685
1686     returns a DR Publisher in the specified environment. Gets a `DR_Pub` object by pubId
1687
1688 Parameters
1689 ++++++++++
1690
1691 .. csv-table::
1692     :delim: |
1693     :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
1694     :widths: 20, 15, 10, 10, 10, 20, 30
1695
1696         pubId | path | Yes | string |  |  |
1697
1698
1699 Request
1700 +++++++
1701
1702
1703 Responses
1704 +++++++++
1705
1706 **200**
1707 ^^^^^^^
1708
1709 Success
1710
1711
1712 Type: :ref:`DR_Pub <d_e926d3fa8701e0cc9c8ed1761b3255cd>`
1713
1714 **Example:**
1715
1716 .. code-block:: javascript
1717
1718     {
1719         "dcaeLocationName": "somestring",
1720         "feedId": "somestring",
1721         "lastMod": "2015-01-01T15:00:00.000Z",
1722         "pubId": "somestring",
1723         "status": "EMPTY",
1724         "username": "somestring",
1725         "userpwd": "somestring"
1726     }
1727
1728 **400**
1729 ^^^^^^^
1730
1731 Error
1732
1733
1734 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
1735
1736 **Example:**
1737
1738 .. code-block:: javascript
1739
1740     {
1741         "code": 1,
1742         "fields": "somestring",
1743         "is2xx": true,
1744         "message": "somestring"
1745     }
1746
1747
1748
1749
1750
1751 GET ``/dr_pubs``
1752 ----------------
1753
1754
1755 Summary
1756 +++++++
1757
1758 return DR_Pub details
1759
1760 Description
1761 +++++++++++
1762
1763 .. raw:: html
1764
1765     Returns array of  `DR_Pub` objects.  Add filter for feedId.
1766
1767
1768 Request
1769 +++++++
1770
1771
1772 Responses
1773 +++++++++
1774
1775 **200**
1776 ^^^^^^^
1777
1778 Success
1779
1780
1781 Type: :ref:`DR_Pub <d_e926d3fa8701e0cc9c8ed1761b3255cd>`
1782
1783 **Example:**
1784
1785 .. code-block:: javascript
1786
1787     {
1788         "dcaeLocationName": "somestring",
1789         "feedId": "somestring",
1790         "lastMod": "2015-01-01T15:00:00.000Z",
1791         "pubId": "somestring",
1792         "status": "EMPTY",
1793         "username": "somestring",
1794         "userpwd": "somestring"
1795     }
1796
1797 **400**
1798 ^^^^^^^
1799
1800 Error
1801
1802
1803 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
1804
1805 **Example:**
1806
1807 .. code-block:: javascript
1808
1809     {
1810         "code": 1,
1811         "fields": "somestring",
1812         "is2xx": true,
1813         "message": "somestring"
1814     }
1815
1816
1817
1818
1819
1820 PUT ``/dr_pubs/{pubId}``
1821 ------------------------
1822
1823
1824 Summary
1825 +++++++
1826
1827 return DR_Pub details
1828
1829 Description
1830 +++++++++++
1831
1832 .. raw:: html
1833
1834     update a DR Publisher in the specified environment.  Update a `DR_Pub` object by pubId
1835
1836 Parameters
1837 ++++++++++
1838
1839 .. csv-table::
1840     :delim: |
1841     :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
1842     :widths: 20, 15, 10, 10, 10, 20, 30
1843
1844         pubId | path | Yes | string |  |  |
1845
1846
1847 Request
1848 +++++++
1849
1850
1851 Responses
1852 +++++++++
1853
1854 **200**
1855 ^^^^^^^
1856
1857 Success
1858
1859
1860 Type: :ref:`DR_Pub <d_e926d3fa8701e0cc9c8ed1761b3255cd>`
1861
1862 **Example:**
1863
1864 .. code-block:: javascript
1865
1866     {
1867         "dcaeLocationName": "somestring",
1868         "feedId": "somestring",
1869         "lastMod": "2015-01-01T15:00:00.000Z",
1870         "pubId": "somestring",
1871         "status": "EMPTY",
1872         "username": "somestring",
1873         "userpwd": "somestring"
1874     }
1875
1876 **400**
1877 ^^^^^^^
1878
1879 Error
1880
1881
1882 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
1883
1884 **Example:**
1885
1886 .. code-block:: javascript
1887
1888     {
1889         "code": 1,
1890         "fields": "somestring",
1891         "is2xx": true,
1892         "message": "somestring"
1893     }
1894
1895
1896
1897
1898 DR_SUBS
1899 ~~~~~~~
1900
1901
1902 Endpoint for a Data Router client that implements a Subscriber
1903
1904
1905
1906
1907
1908 POST ``/dr_subs``
1909 -----------------
1910
1911
1912 Summary
1913 +++++++
1914
1915 return DR_Sub details
1916
1917 Description
1918 +++++++++++
1919
1920 .. raw:: html
1921
1922     Create a  `DR_Sub` object.
1923
1924
1925 Request
1926 +++++++
1927
1928
1929 Responses
1930 +++++++++
1931
1932 **200**
1933 ^^^^^^^
1934
1935 Success
1936
1937
1938 Type: :ref:`DR_Sub <d_48cf328d246f41e1d11a09251b042f02>`
1939
1940 **Example:**
1941
1942 .. code-block:: javascript
1943
1944     {
1945         "bytes": [
1946             "somestring",
1947             "somestring"
1948         ],
1949         "dcaeLocationName": "somestring",
1950         "deliveryURL": "somestring",
1951         "feedId": "somestring",
1952         "lastMod": "2015-01-01T15:00:00.000Z",
1953         "logURL": "somestring",
1954         "owner": "somestring",
1955         "status": "EMPTY",
1956         "subId": "somestring",
1957         "suspended": true,
1958         "use100": true,
1959         "username": "somestring",
1960         "userpwd": "somestring"
1961     }
1962
1963 **400**
1964 ^^^^^^^
1965
1966 Error
1967
1968
1969 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
1970
1971 **Example:**
1972
1973 .. code-block:: javascript
1974
1975     {
1976         "code": 1,
1977         "fields": "somestring",
1978         "is2xx": true,
1979         "message": "somestring"
1980     }
1981
1982
1983
1984
1985
1986 DELETE ``/dr_subs/{subId}``
1987 ---------------------------
1988
1989
1990 Summary
1991 +++++++
1992
1993 return DR_Sub details
1994
1995 Description
1996 +++++++++++
1997
1998 .. raw:: html
1999
2000     Delete a  `DR_Sub` object, selected by subId
2001
2002 Parameters
2003 ++++++++++
2004
2005 .. csv-table::
2006     :delim: |
2007     :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
2008     :widths: 20, 15, 10, 10, 10, 20, 30
2009
2010         subId | path | Yes | string |  |  |
2011
2012
2013 Request
2014 +++++++
2015
2016
2017 Responses
2018 +++++++++
2019
2020 **200**
2021 ^^^^^^^
2022
2023 Success
2024
2025
2026 Type: :ref:`DR_Sub <d_48cf328d246f41e1d11a09251b042f02>`
2027
2028 **Example:**
2029
2030 .. code-block:: javascript
2031
2032     {
2033         "bytes": [
2034             "somestring",
2035             "somestring"
2036         ],
2037         "dcaeLocationName": "somestring",
2038         "deliveryURL": "somestring",
2039         "feedId": "somestring",
2040         "lastMod": "2015-01-01T15:00:00.000Z",
2041         "logURL": "somestring",
2042         "owner": "somestring",
2043         "status": "EMPTY",
2044         "subId": "somestring",
2045         "suspended": true,
2046         "use100": true,
2047         "username": "somestring",
2048         "userpwd": "somestring"
2049     }
2050
2051 **400**
2052 ^^^^^^^
2053
2054 Error
2055
2056
2057 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
2058
2059 **Example:**
2060
2061 .. code-block:: javascript
2062
2063     {
2064         "code": 1,
2065         "fields": "somestring",
2066         "is2xx": true,
2067         "message": "somestring"
2068     }
2069
2070
2071
2072
2073
2074 GET ``/dr_subs/{subId}``
2075 ------------------------
2076
2077
2078 Summary
2079 +++++++
2080
2081 return DR_Sub details
2082
2083 Description
2084 +++++++++++
2085
2086 .. raw:: html
2087
2088     Retrieve a  `DR_Sub` object, selected by subId
2089
2090 Parameters
2091 ++++++++++
2092
2093 .. csv-table::
2094     :delim: |
2095     :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
2096     :widths: 20, 15, 10, 10, 10, 20, 30
2097
2098         subId | path | Yes | string |  |  |
2099
2100
2101 Request
2102 +++++++
2103
2104
2105 Responses
2106 +++++++++
2107
2108 **200**
2109 ^^^^^^^
2110
2111 Success
2112
2113
2114 Type: :ref:`DR_Sub <d_48cf328d246f41e1d11a09251b042f02>`
2115
2116 **Example:**
2117
2118 .. code-block:: javascript
2119
2120     {
2121         "bytes": [
2122             "somestring",
2123             "somestring"
2124         ],
2125         "dcaeLocationName": "somestring",
2126         "deliveryURL": "somestring",
2127         "feedId": "somestring",
2128         "lastMod": "2015-01-01T15:00:00.000Z",
2129         "logURL": "somestring",
2130         "owner": "somestring",
2131         "status": "EMPTY",
2132         "subId": "somestring",
2133         "suspended": true,
2134         "use100": true,
2135         "username": "somestring",
2136         "userpwd": "somestring"
2137     }
2138
2139 **400**
2140 ^^^^^^^
2141
2142 Error
2143
2144
2145 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
2146
2147 **Example:**
2148
2149 .. code-block:: javascript
2150
2151     {
2152         "code": 1,
2153         "fields": "somestring",
2154         "is2xx": true,
2155         "message": "somestring"
2156     }
2157
2158
2159
2160
2161
2162 GET ``/dr_subs``
2163 ----------------
2164
2165
2166 Summary
2167 +++++++
2168
2169 return DR_Sub details
2170
2171 Description
2172 +++++++++++
2173
2174 .. raw:: html
2175
2176     Returns array of  `DR_Sub` objects.  Add filter for feedId.
2177
2178
2179 Request
2180 +++++++
2181
2182
2183 Responses
2184 +++++++++
2185
2186 **200**
2187 ^^^^^^^
2188
2189 Success
2190
2191
2192 Type: :ref:`DR_Sub <d_48cf328d246f41e1d11a09251b042f02>`
2193
2194 **Example:**
2195
2196 .. code-block:: javascript
2197
2198     {
2199         "bytes": [
2200             "somestring",
2201             "somestring"
2202         ],
2203         "dcaeLocationName": "somestring",
2204         "deliveryURL": "somestring",
2205         "feedId": "somestring",
2206         "lastMod": "2015-01-01T15:00:00.000Z",
2207         "logURL": "somestring",
2208         "owner": "somestring",
2209         "status": "EMPTY",
2210         "subId": "somestring",
2211         "suspended": true,
2212         "use100": true,
2213         "username": "somestring",
2214         "userpwd": "somestring"
2215     }
2216
2217 **400**
2218 ^^^^^^^
2219
2220 Error
2221
2222
2223 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
2224
2225 **Example:**
2226
2227 .. code-block:: javascript
2228
2229     {
2230         "code": 1,
2231         "fields": "somestring",
2232         "is2xx": true,
2233         "message": "somestring"
2234     }
2235
2236
2237
2238
2239
2240 PUT ``/dr_subs/{subId}``
2241 ------------------------
2242
2243
2244 Summary
2245 +++++++
2246
2247 return DR_Sub details
2248
2249 Description
2250 +++++++++++
2251
2252 .. raw:: html
2253
2254     Update a  `DR_Sub` object, selected by subId
2255
2256 Parameters
2257 ++++++++++
2258
2259 .. csv-table::
2260     :delim: |
2261     :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
2262     :widths: 20, 15, 10, 10, 10, 20, 30
2263
2264         subId | path | Yes | string |  |  |
2265
2266
2267 Request
2268 +++++++
2269
2270
2271 Responses
2272 +++++++++
2273
2274 **200**
2275 ^^^^^^^
2276
2277 Success
2278
2279
2280 Type: :ref:`DR_Sub <d_48cf328d246f41e1d11a09251b042f02>`
2281
2282 **Example:**
2283
2284 .. code-block:: javascript
2285
2286     {
2287         "bytes": [
2288             "somestring",
2289             "somestring"
2290         ],
2291         "dcaeLocationName": "somestring",
2292         "deliveryURL": "somestring",
2293         "feedId": "somestring",
2294         "lastMod": "2015-01-01T15:00:00.000Z",
2295         "logURL": "somestring",
2296         "owner": "somestring",
2297         "status": "EMPTY",
2298         "subId": "somestring",
2299         "suspended": true,
2300         "use100": true,
2301         "username": "somestring",
2302         "userpwd": "somestring"
2303     }
2304
2305 **400**
2306 ^^^^^^^
2307
2308 Error
2309
2310
2311 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
2312
2313 **Example:**
2314
2315 .. code-block:: javascript
2316
2317     {
2318         "code": 1,
2319         "fields": "somestring",
2320         "is2xx": true,
2321         "message": "somestring"
2322     }
2323
2324
2325
2326
2327 FEEDS
2328 ~~~~~
2329
2330
2331 Endpoint for a Data Router Feed
2332
2333
2334
2335
2336
2337 POST ``/feeds``
2338 ---------------
2339
2340
2341 Summary
2342 +++++++
2343
2344 return Feed details
2345
2346 Description
2347 +++++++++++
2348
2349 .. raw:: html
2350
2351     Create a of  `Feed` object.
2352
2353 Parameters
2354 ++++++++++
2355
2356 .. csv-table::
2357     :delim: |
2358     :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
2359     :widths: 20, 15, 10, 10, 10, 20, 30
2360
2361         useExisting | query | No | string |  |  |
2362
2363
2364 Request
2365 +++++++
2366
2367
2368 Responses
2369 +++++++++
2370
2371 **200**
2372 ^^^^^^^
2373
2374 Success
2375
2376
2377 Type: :ref:`Feed <d_289ad39619725df26c9ff382d4c97c75>`
2378
2379 **Example:**
2380
2381 .. code-block:: javascript
2382
2383     {
2384         "asprClassification": "somestring",
2385         "bytes": [
2386             "somestring",
2387             "somestring"
2388         ],
2389         "feedDescription": "somestring",
2390         "feedId": "somestring",
2391         "feedName": "somestring",
2392         "feedVersion": "somestring",
2393         "formatUuid": "somestring",
2394         "lastMod": "2015-01-01T15:00:00.000Z",
2395         "logURL": "somestring",
2396         "owner": "somestring",
2397         "publishURL": "somestring",
2398         "pubs": [
2399             {
2400                 "dcaeLocationName": "somestring",
2401                 "feedId": "somestring",
2402                 "lastMod": "2015-01-01T15:00:00.000Z",
2403                 "pubId": "somestring",
2404                 "status": "EMPTY",
2405                 "username": "somestring",
2406                 "userpwd": "somestring"
2407             },
2408             {
2409                 "dcaeLocationName": "somestring",
2410                 "feedId": "somestring",
2411                 "lastMod": "2015-01-01T15:00:00.000Z",
2412                 "pubId": "somestring",
2413                 "status": "EMPTY",
2414                 "username": "somestring",
2415                 "userpwd": "somestring"
2416             }
2417         ],
2418         "status": "EMPTY",
2419         "subs": [
2420             {
2421                 "bytes": [
2422                     "somestring",
2423                     "somestring"
2424                 ],
2425                 "dcaeLocationName": "somestring",
2426                 "deliveryURL": "somestring",
2427                 "feedId": "somestring",
2428                 "lastMod": "2015-01-01T15:00:00.000Z",
2429                 "logURL": "somestring",
2430                 "owner": "somestring",
2431                 "status": "EMPTY",
2432                 "subId": "somestring",
2433                 "suspended": true,
2434                 "use100": true,
2435                 "username": "somestring",
2436                 "userpwd": "somestring"
2437             },
2438             {
2439                 "bytes": [
2440                     "somestring",
2441                     "somestring"
2442                 ],
2443                 "dcaeLocationName": "somestring",
2444                 "deliveryURL": "somestring",
2445                 "feedId": "somestring",
2446                 "lastMod": "2015-01-01T15:00:00.000Z",
2447                 "logURL": "somestring",
2448                 "owner": "somestring",
2449                 "status": "EMPTY",
2450                 "subId": "somestring",
2451                 "suspended": true,
2452                 "use100": true,
2453                 "username": "somestring",
2454                 "userpwd": "somestring"
2455             }
2456         ],
2457         "subscribeURL": "somestring",
2458         "suspended": true
2459     }
2460
2461 **400**
2462 ^^^^^^^
2463
2464 Error
2465
2466
2467 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
2468
2469 **Example:**
2470
2471 .. code-block:: javascript
2472
2473     {
2474         "code": 1,
2475         "fields": "somestring",
2476         "is2xx": true,
2477         "message": "somestring"
2478     }
2479
2480
2481
2482
2483
2484 DELETE ``/feeds/{id}``
2485 ----------------------
2486
2487
2488 Summary
2489 +++++++
2490
2491 return Feed details
2492
2493 Description
2494 +++++++++++
2495
2496 .. raw:: html
2497
2498     Delete a  `Feed` object, specified by id.
2499
2500 Parameters
2501 ++++++++++
2502
2503 .. csv-table::
2504     :delim: |
2505     :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
2506     :widths: 20, 15, 10, 10, 10, 20, 30
2507
2508         id | path | Yes | string |  |  |
2509
2510
2511 Request
2512 +++++++
2513
2514
2515 Responses
2516 +++++++++
2517
2518 **200**
2519 ^^^^^^^
2520
2521 successful operation
2522
2523
2524 Type: :ref:`Feed <d_289ad39619725df26c9ff382d4c97c75>`
2525
2526 **Example:**
2527
2528 .. code-block:: javascript
2529
2530     {
2531         "asprClassification": "somestring",
2532         "bytes": [
2533             "somestring",
2534             "somestring"
2535         ],
2536         "feedDescription": "somestring",
2537         "feedId": "somestring",
2538         "feedName": "somestring",
2539         "feedVersion": "somestring",
2540         "formatUuid": "somestring",
2541         "lastMod": "2015-01-01T15:00:00.000Z",
2542         "logURL": "somestring",
2543         "owner": "somestring",
2544         "publishURL": "somestring",
2545         "pubs": [
2546             {
2547                 "dcaeLocationName": "somestring",
2548                 "feedId": "somestring",
2549                 "lastMod": "2015-01-01T15:00:00.000Z",
2550                 "pubId": "somestring",
2551                 "status": "EMPTY",
2552                 "username": "somestring",
2553                 "userpwd": "somestring"
2554             },
2555             {
2556                 "dcaeLocationName": "somestring",
2557                 "feedId": "somestring",
2558                 "lastMod": "2015-01-01T15:00:00.000Z",
2559                 "pubId": "somestring",
2560                 "status": "EMPTY",
2561                 "username": "somestring",
2562                 "userpwd": "somestring"
2563             }
2564         ],
2565         "status": "EMPTY",
2566         "subs": [
2567             {
2568                 "bytes": [
2569                     "somestring",
2570                     "somestring"
2571                 ],
2572                 "dcaeLocationName": "somestring",
2573                 "deliveryURL": "somestring",
2574                 "feedId": "somestring",
2575                 "lastMod": "2015-01-01T15:00:00.000Z",
2576                 "logURL": "somestring",
2577                 "owner": "somestring",
2578                 "status": "EMPTY",
2579                 "subId": "somestring",
2580                 "suspended": true,
2581                 "use100": true,
2582                 "username": "somestring",
2583                 "userpwd": "somestring"
2584             },
2585             {
2586                 "bytes": [
2587                     "somestring",
2588                     "somestring"
2589                 ],
2590                 "dcaeLocationName": "somestring",
2591                 "deliveryURL": "somestring",
2592                 "feedId": "somestring",
2593                 "lastMod": "2015-01-01T15:00:00.000Z",
2594                 "logURL": "somestring",
2595                 "owner": "somestring",
2596                 "status": "EMPTY",
2597                 "subId": "somestring",
2598                 "suspended": true,
2599                 "use100": true,
2600                 "username": "somestring",
2601                 "userpwd": "somestring"
2602             }
2603         ],
2604         "subscribeURL": "somestring",
2605         "suspended": true
2606     }
2607
2608 **204**
2609 ^^^^^^^
2610
2611 Success
2612
2613
2614 Type: :ref:`Feed <d_289ad39619725df26c9ff382d4c97c75>`
2615
2616 **Example:**
2617
2618 .. code-block:: javascript
2619
2620     {
2621         "asprClassification": "somestring",
2622         "bytes": [
2623             "somestring",
2624             "somestring"
2625         ],
2626         "feedDescription": "somestring",
2627         "feedId": "somestring",
2628         "feedName": "somestring",
2629         "feedVersion": "somestring",
2630         "formatUuid": "somestring",
2631         "lastMod": "2015-01-01T15:00:00.000Z",
2632         "logURL": "somestring",
2633         "owner": "somestring",
2634         "publishURL": "somestring",
2635         "pubs": [
2636             {
2637                 "dcaeLocationName": "somestring",
2638                 "feedId": "somestring",
2639                 "lastMod": "2015-01-01T15:00:00.000Z",
2640                 "pubId": "somestring",
2641                 "status": "EMPTY",
2642                 "username": "somestring",
2643                 "userpwd": "somestring"
2644             },
2645             {
2646                 "dcaeLocationName": "somestring",
2647                 "feedId": "somestring",
2648                 "lastMod": "2015-01-01T15:00:00.000Z",
2649                 "pubId": "somestring",
2650                 "status": "EMPTY",
2651                 "username": "somestring",
2652                 "userpwd": "somestring"
2653             }
2654         ],
2655         "status": "EMPTY",
2656         "subs": [
2657             {
2658                 "bytes": [
2659                     "somestring",
2660                     "somestring"
2661                 ],
2662                 "dcaeLocationName": "somestring",
2663                 "deliveryURL": "somestring",
2664                 "feedId": "somestring",
2665                 "lastMod": "2015-01-01T15:00:00.000Z",
2666                 "logURL": "somestring",
2667                 "owner": "somestring",
2668                 "status": "EMPTY",
2669                 "subId": "somestring",
2670                 "suspended": true,
2671                 "use100": true,
2672                 "username": "somestring",
2673                 "userpwd": "somestring"
2674             },
2675             {
2676                 "bytes": [
2677                     "somestring",
2678                     "somestring"
2679                 ],
2680                 "dcaeLocationName": "somestring",
2681                 "deliveryURL": "somestring",
2682                 "feedId": "somestring",
2683                 "lastMod": "2015-01-01T15:00:00.000Z",
2684                 "logURL": "somestring",
2685                 "owner": "somestring",
2686                 "status": "EMPTY",
2687                 "subId": "somestring",
2688                 "suspended": true,
2689                 "use100": true,
2690                 "username": "somestring",
2691                 "userpwd": "somestring"
2692             }
2693         ],
2694         "subscribeURL": "somestring",
2695         "suspended": true
2696     }
2697
2698 **400**
2699 ^^^^^^^
2700
2701 Error
2702
2703
2704 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
2705
2706 **Example:**
2707
2708 .. code-block:: javascript
2709
2710     {
2711         "code": 1,
2712         "fields": "somestring",
2713         "is2xx": true,
2714         "message": "somestring"
2715     }
2716
2717
2718
2719
2720
2721 GET ``/feeds/{id}``
2722 -------------------
2723
2724
2725 Summary
2726 +++++++
2727
2728 return Feed details
2729
2730 Description
2731 +++++++++++
2732
2733 .. raw:: html
2734
2735     Retrieve a  `Feed` object, specified by id.
2736
2737 Parameters
2738 ++++++++++
2739
2740 .. csv-table::
2741     :delim: |
2742     :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
2743     :widths: 20, 15, 10, 10, 10, 20, 30
2744
2745         id | path | Yes | string |  |  |
2746
2747
2748 Request
2749 +++++++
2750
2751
2752 Responses
2753 +++++++++
2754
2755 **200**
2756 ^^^^^^^
2757
2758 Success
2759
2760
2761 Type: :ref:`DR_Pub <d_e926d3fa8701e0cc9c8ed1761b3255cd>`
2762
2763 **Example:**
2764
2765 .. code-block:: javascript
2766
2767     {
2768         "dcaeLocationName": "somestring",
2769         "feedId": "somestring",
2770         "lastMod": "2015-01-01T15:00:00.000Z",
2771         "pubId": "somestring",
2772         "status": "EMPTY",
2773         "username": "somestring",
2774         "userpwd": "somestring"
2775     }
2776
2777 **400**
2778 ^^^^^^^
2779
2780 Error
2781
2782
2783 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
2784
2785 **Example:**
2786
2787 .. code-block:: javascript
2788
2789     {
2790         "code": 1,
2791         "fields": "somestring",
2792         "is2xx": true,
2793         "message": "somestring"
2794     }
2795
2796
2797
2798
2799
2800 GET ``/feeds``
2801 --------------
2802
2803
2804 Summary
2805 +++++++
2806
2807 return Feed details
2808
2809 Description
2810 +++++++++++
2811
2812 .. raw:: html
2813
2814     Returns array of  `Feed` objects.
2815
2816 Parameters
2817 ++++++++++
2818
2819 .. csv-table::
2820     :delim: |
2821     :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
2822     :widths: 20, 15, 10, 10, 10, 20, 30
2823
2824         feedName | query | No | string |  |  |
2825         version | query | No | string |  |  |
2826         match | query | No | string |  |  |
2827
2828
2829 Request
2830 +++++++
2831
2832
2833 Responses
2834 +++++++++
2835
2836 **200**
2837 ^^^^^^^
2838
2839 Success
2840
2841
2842 Type: :ref:`Feed <d_289ad39619725df26c9ff382d4c97c75>`
2843
2844 **Example:**
2845
2846 .. code-block:: javascript
2847
2848     {
2849         "asprClassification": "somestring",
2850         "bytes": [
2851             "somestring",
2852             "somestring"
2853         ],
2854         "feedDescription": "somestring",
2855         "feedId": "somestring",
2856         "feedName": "somestring",
2857         "feedVersion": "somestring",
2858         "formatUuid": "somestring",
2859         "lastMod": "2015-01-01T15:00:00.000Z",
2860         "logURL": "somestring",
2861         "owner": "somestring",
2862         "publishURL": "somestring",
2863         "pubs": [
2864             {
2865                 "dcaeLocationName": "somestring",
2866                 "feedId": "somestring",
2867                 "lastMod": "2015-01-01T15:00:00.000Z",
2868                 "pubId": "somestring",
2869                 "status": "EMPTY",
2870                 "username": "somestring",
2871                 "userpwd": "somestring"
2872             },
2873             {
2874                 "dcaeLocationName": "somestring",
2875                 "feedId": "somestring",
2876                 "lastMod": "2015-01-01T15:00:00.000Z",
2877                 "pubId": "somestring",
2878                 "status": "EMPTY",
2879                 "username": "somestring",
2880                 "userpwd": "somestring"
2881             }
2882         ],
2883         "status": "EMPTY",
2884         "subs": [
2885             {
2886                 "bytes": [
2887                     "somestring",
2888                     "somestring"
2889                 ],
2890                 "dcaeLocationName": "somestring",
2891                 "deliveryURL": "somestring",
2892                 "feedId": "somestring",
2893                 "lastMod": "2015-01-01T15:00:00.000Z",
2894                 "logURL": "somestring",
2895                 "owner": "somestring",
2896                 "status": "EMPTY",
2897                 "subId": "somestring",
2898                 "suspended": true,
2899                 "use100": true,
2900                 "username": "somestring",
2901                 "userpwd": "somestring"
2902             },
2903             {
2904                 "bytes": [
2905                     "somestring",
2906                     "somestring"
2907                 ],
2908                 "dcaeLocationName": "somestring",
2909                 "deliveryURL": "somestring",
2910                 "feedId": "somestring",
2911                 "lastMod": "2015-01-01T15:00:00.000Z",
2912                 "logURL": "somestring",
2913                 "owner": "somestring",
2914                 "status": "EMPTY",
2915                 "subId": "somestring",
2916                 "suspended": true,
2917                 "use100": true,
2918                 "username": "somestring",
2919                 "userpwd": "somestring"
2920             }
2921         ],
2922         "subscribeURL": "somestring",
2923         "suspended": true
2924     }
2925
2926 **400**
2927 ^^^^^^^
2928
2929 Error
2930
2931
2932 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
2933
2934 **Example:**
2935
2936 .. code-block:: javascript
2937
2938     {
2939         "code": 1,
2940         "fields": "somestring",
2941         "is2xx": true,
2942         "message": "somestring"
2943     }
2944
2945
2946
2947
2948
2949 PUT ``/feeds/{id}``
2950 -------------------
2951
2952
2953 Summary
2954 +++++++
2955
2956 return Feed details
2957
2958 Description
2959 +++++++++++
2960
2961 .. raw:: html
2962
2963     Update a  `Feed` object, specified by id.
2964
2965 Parameters
2966 ++++++++++
2967
2968 .. csv-table::
2969     :delim: |
2970     :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
2971     :widths: 20, 15, 10, 10, 10, 20, 30
2972
2973         id | path | Yes | string |  |  |
2974
2975
2976 Request
2977 +++++++
2978
2979
2980 Responses
2981 +++++++++
2982
2983 **200**
2984 ^^^^^^^
2985
2986 Success
2987
2988
2989 Type: :ref:`Feed <d_289ad39619725df26c9ff382d4c97c75>`
2990
2991 **Example:**
2992
2993 .. code-block:: javascript
2994
2995     {
2996         "asprClassification": "somestring",
2997         "bytes": [
2998             "somestring",
2999             "somestring"
3000         ],
3001         "feedDescription": "somestring",
3002         "feedId": "somestring",
3003         "feedName": "somestring",
3004         "feedVersion": "somestring",
3005         "formatUuid": "somestring",
3006         "lastMod": "2015-01-01T15:00:00.000Z",
3007         "logURL": "somestring",
3008         "owner": "somestring",
3009         "publishURL": "somestring",
3010         "pubs": [
3011             {
3012                 "dcaeLocationName": "somestring",
3013                 "feedId": "somestring",
3014                 "lastMod": "2015-01-01T15:00:00.000Z",
3015                 "pubId": "somestring",
3016                 "status": "EMPTY",
3017                 "username": "somestring",
3018                 "userpwd": "somestring"
3019             },
3020             {
3021                 "dcaeLocationName": "somestring",
3022                 "feedId": "somestring",
3023                 "lastMod": "2015-01-01T15:00:00.000Z",
3024                 "pubId": "somestring",
3025                 "status": "EMPTY",
3026                 "username": "somestring",
3027                 "userpwd": "somestring"
3028             }
3029         ],
3030         "status": "EMPTY",
3031         "subs": [
3032             {
3033                 "bytes": [
3034                     "somestring",
3035                     "somestring"
3036                 ],
3037                 "dcaeLocationName": "somestring",
3038                 "deliveryURL": "somestring",
3039                 "feedId": "somestring",
3040                 "lastMod": "2015-01-01T15:00:00.000Z",
3041                 "logURL": "somestring",
3042                 "owner": "somestring",
3043                 "status": "EMPTY",
3044                 "subId": "somestring",
3045                 "suspended": true,
3046                 "use100": true,
3047                 "username": "somestring",
3048                 "userpwd": "somestring"
3049             },
3050             {
3051                 "bytes": [
3052                     "somestring",
3053                     "somestring"
3054                 ],
3055                 "dcaeLocationName": "somestring",
3056                 "deliveryURL": "somestring",
3057                 "feedId": "somestring",
3058                 "lastMod": "2015-01-01T15:00:00.000Z",
3059                 "logURL": "somestring",
3060                 "owner": "somestring",
3061                 "status": "EMPTY",
3062                 "subId": "somestring",
3063                 "suspended": true,
3064                 "use100": true,
3065                 "username": "somestring",
3066                 "userpwd": "somestring"
3067             }
3068         ],
3069         "subscribeURL": "somestring",
3070         "suspended": true
3071     }
3072
3073 **400**
3074 ^^^^^^^
3075
3076 Error
3077
3078
3079 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
3080
3081 **Example:**
3082
3083 .. code-block:: javascript
3084
3085     {
3086         "code": 1,
3087         "fields": "somestring",
3088         "is2xx": true,
3089         "message": "somestring"
3090     }
3091
3092
3093
3094
3095 INFO
3096 ~~~~
3097
3098
3099 Endpoint for this instance of DBCL.  Returns health info.
3100
3101
3102
3103
3104
3105 GET ``/info``
3106 -------------
3107
3108
3109 Summary
3110 +++++++
3111
3112 return info details
3113
3114 Description
3115 +++++++++++
3116
3117 .. raw:: html
3118
3119     returns the `info` object
3120
3121
3122 Request
3123 +++++++
3124
3125
3126 Responses
3127 +++++++++
3128
3129 **200**
3130 ^^^^^^^
3131
3132 Success
3133
3134
3135 Type: :ref:`Dmaap <d_4ea0e7758a1f8502222793e4a13b04f7>`
3136
3137 **Example:**
3138
3139 .. code-block:: javascript
3140
3141     {
3142         "accessKeyOwner": "somestring",
3143         "bridgeAdminTopic": "somestring",
3144         "dmaapName": "somestring",
3145         "drProvUrl": "somestring",
3146         "lastMod": "2015-01-01T15:00:00.000Z",
3147         "loggingUrl": "somestring",
3148         "nodeKey": "somestring",
3149         "status": "EMPTY",
3150         "topicNsRoot": "somestring",
3151         "version": "somestring"
3152     }
3153
3154 **400**
3155 ^^^^^^^
3156
3157 Error
3158
3159
3160 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
3161
3162 **Example:**
3163
3164 .. code-block:: javascript
3165
3166     {
3167         "code": 1,
3168         "fields": "somestring",
3169         "is2xx": true,
3170         "message": "somestring"
3171     }
3172
3173
3174
3175
3176 MR_CLIENTS
3177 ~~~~~~~~~~
3178
3179
3180 Endpoint for a Message Router Client that implements a Publisher or a Subscriber
3181
3182
3183
3184
3185
3186 POST ``/mr_clients``
3187 --------------------
3188
3189
3190 Summary
3191 +++++++
3192
3193 Associate an MR_Client object to a Topic
3194
3195 Description
3196 +++++++++++
3197
3198 .. raw:: html
3199
3200     Create a  `MR_Client` object.The `dcaeLocation` attribute is used to match an `MR_Cluster` object with the same value, with the intent of localizing message traffic.  In legacy implementation, the `clientRole` is granted appropriate permission in AAF.  Newer implementions may instead specify an AAF Identity, which will be added to the appropriate `Topic` role.
3201
3202
3203 Request
3204 +++++++
3205
3206
3207 Responses
3208 +++++++++
3209
3210 **200**
3211 ^^^^^^^
3212
3213 Success
3214
3215
3216 Type: :ref:`MR_Client <d_56ff81dc98986e27074d9be2731e3f4c>`
3217
3218 **Example:**
3219
3220 .. code-block:: javascript
3221
3222     {
3223         "action": [
3224             "somestring",
3225             "somestring"
3226         ],
3227         "clientIdentity": "somestring",
3228         "clientRole": "somestring",
3229         "dcaeLocationName": "somestring",
3230         "fqtn": "somestring",
3231         "lastMod": "2015-01-01T15:00:00.000Z",
3232         "mrClientId": "somestring",
3233         "status": "EMPTY",
3234         "topicURL": "somestring"
3235     }
3236
3237 **400**
3238 ^^^^^^^
3239
3240 Error
3241
3242
3243 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
3244
3245 **Example:**
3246
3247 .. code-block:: javascript
3248
3249     {
3250         "code": 1,
3251         "fields": "somestring",
3252         "is2xx": true,
3253         "message": "somestring"
3254     }
3255
3256
3257
3258
3259
3260 DELETE ``/mr_clients/{subId}``
3261 ------------------------------
3262
3263
3264 Summary
3265 +++++++
3266
3267 Delete an MR_Client object
3268
3269 Description
3270 +++++++++++
3271
3272 .. raw:: html
3273
3274     Delete a  `MR_Client` object, specified by clientId
3275
3276 Parameters
3277 ++++++++++
3278
3279 .. csv-table::
3280     :delim: |
3281     :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
3282     :widths: 20, 15, 10, 10, 10, 20, 30
3283
3284         subId | path | Yes | string |  |  |
3285
3286
3287 Request
3288 +++++++
3289
3290
3291 Responses
3292 +++++++++
3293
3294 **200**
3295 ^^^^^^^
3296
3297 successful operation
3298
3299
3300 Type: :ref:`MR_Client <d_56ff81dc98986e27074d9be2731e3f4c>`
3301
3302 **Example:**
3303
3304 .. code-block:: javascript
3305
3306     {
3307         "action": [
3308             "somestring",
3309             "somestring"
3310         ],
3311         "clientIdentity": "somestring",
3312         "clientRole": "somestring",
3313         "dcaeLocationName": "somestring",
3314         "fqtn": "somestring",
3315         "lastMod": "2015-01-01T15:00:00.000Z",
3316         "mrClientId": "somestring",
3317         "status": "EMPTY",
3318         "topicURL": "somestring"
3319     }
3320
3321 **204**
3322 ^^^^^^^
3323
3324 Success
3325
3326
3327 Type: :ref:`MR_Client <d_56ff81dc98986e27074d9be2731e3f4c>`
3328
3329 **Example:**
3330
3331 .. code-block:: javascript
3332
3333     {
3334         "action": [
3335             "somestring",
3336             "somestring"
3337         ],
3338         "clientIdentity": "somestring",
3339         "clientRole": "somestring",
3340         "dcaeLocationName": "somestring",
3341         "fqtn": "somestring",
3342         "lastMod": "2015-01-01T15:00:00.000Z",
3343         "mrClientId": "somestring",
3344         "status": "EMPTY",
3345         "topicURL": "somestring"
3346     }
3347
3348 **400**
3349 ^^^^^^^
3350
3351 Error
3352
3353
3354 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
3355
3356 **Example:**
3357
3358 .. code-block:: javascript
3359
3360     {
3361         "code": 1,
3362         "fields": "somestring",
3363         "is2xx": true,
3364         "message": "somestring"
3365     }
3366
3367
3368
3369
3370
3371 GET ``/mr_clients``
3372 -------------------
3373
3374
3375 Summary
3376 +++++++
3377
3378 return MR_Client details
3379
3380 Description
3381 +++++++++++
3382
3383 .. raw:: html
3384
3385     Returns array of  `MR_Client` objects.
3386
3387
3388 Request
3389 +++++++
3390
3391
3392 Responses
3393 +++++++++
3394
3395 **200**
3396 ^^^^^^^
3397
3398 Success
3399
3400
3401 Type: :ref:`MR_Client <d_56ff81dc98986e27074d9be2731e3f4c>`
3402
3403 **Example:**
3404
3405 .. code-block:: javascript
3406
3407     {
3408         "action": [
3409             "somestring",
3410             "somestring"
3411         ],
3412         "clientIdentity": "somestring",
3413         "clientRole": "somestring",
3414         "dcaeLocationName": "somestring",
3415         "fqtn": "somestring",
3416         "lastMod": "2015-01-01T15:00:00.000Z",
3417         "mrClientId": "somestring",
3418         "status": "EMPTY",
3419         "topicURL": "somestring"
3420     }
3421
3422 **400**
3423 ^^^^^^^
3424
3425 Error
3426
3427
3428 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
3429
3430 **Example:**
3431
3432 .. code-block:: javascript
3433
3434     {
3435         "code": 1,
3436         "fields": "somestring",
3437         "is2xx": true,
3438         "message": "somestring"
3439     }
3440
3441
3442
3443
3444
3445 GET ``/mr_clients/{subId}``
3446 ---------------------------
3447
3448
3449 Summary
3450 +++++++
3451
3452 return MR_Client details
3453
3454 Description
3455 +++++++++++
3456
3457 .. raw:: html
3458
3459     Retrieve a  `MR_Client` object, specified by clientId
3460
3461 Parameters
3462 ++++++++++
3463
3464 .. csv-table::
3465     :delim: |
3466     :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
3467     :widths: 20, 15, 10, 10, 10, 20, 30
3468
3469         subId | path | Yes | string |  |  |
3470
3471
3472 Request
3473 +++++++
3474
3475
3476 Responses
3477 +++++++++
3478
3479 **200**
3480 ^^^^^^^
3481
3482 Success
3483
3484
3485 Type: :ref:`MR_Client <d_56ff81dc98986e27074d9be2731e3f4c>`
3486
3487 **Example:**
3488
3489 .. code-block:: javascript
3490
3491     {
3492         "action": [
3493             "somestring",
3494             "somestring"
3495         ],
3496         "clientIdentity": "somestring",
3497         "clientRole": "somestring",
3498         "dcaeLocationName": "somestring",
3499         "fqtn": "somestring",
3500         "lastMod": "2015-01-01T15:00:00.000Z",
3501         "mrClientId": "somestring",
3502         "status": "EMPTY",
3503         "topicURL": "somestring"
3504     }
3505
3506 **400**
3507 ^^^^^^^
3508
3509 Error
3510
3511
3512 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
3513
3514 **Example:**
3515
3516 .. code-block:: javascript
3517
3518     {
3519         "code": 1,
3520         "fields": "somestring",
3521         "is2xx": true,
3522         "message": "somestring"
3523     }
3524
3525
3526
3527
3528
3529 PUT ``/mr_clients/{clientId}``
3530 ------------------------------
3531
3532
3533 Summary
3534 +++++++
3535
3536 Update an MR_Client object
3537
3538 Description
3539 +++++++++++
3540
3541 .. raw:: html
3542
3543     Update a  `MR_Client` object, specified by clientId
3544
3545 Parameters
3546 ++++++++++
3547
3548 .. csv-table::
3549     :delim: |
3550     :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
3551     :widths: 20, 15, 10, 10, 10, 20, 30
3552
3553         clientId | path | Yes | string |  |  |
3554
3555
3556 Request
3557 +++++++
3558
3559
3560 Responses
3561 +++++++++
3562
3563 **200**
3564 ^^^^^^^
3565
3566 Success
3567
3568
3569 Type: :ref:`MR_Client <d_56ff81dc98986e27074d9be2731e3f4c>`
3570
3571 **Example:**
3572
3573 .. code-block:: javascript
3574
3575     {
3576         "action": [
3577             "somestring",
3578             "somestring"
3579         ],
3580         "clientIdentity": "somestring",
3581         "clientRole": "somestring",
3582         "dcaeLocationName": "somestring",
3583         "fqtn": "somestring",
3584         "lastMod": "2015-01-01T15:00:00.000Z",
3585         "mrClientId": "somestring",
3586         "status": "EMPTY",
3587         "topicURL": "somestring"
3588     }
3589
3590 **400**
3591 ^^^^^^^
3592
3593 Error
3594
3595
3596 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
3597
3598 **Example:**
3599
3600 .. code-block:: javascript
3601
3602     {
3603         "code": 1,
3604         "fields": "somestring",
3605         "is2xx": true,
3606         "message": "somestring"
3607     }
3608
3609
3610
3611
3612 MR_CLUSTERS
3613 ~~~~~~~~~~~
3614
3615
3616 Endpoint for a Message Router servers in a Cluster configuration
3617
3618
3619
3620
3621
3622 POST ``/mr_clusters``
3623 ---------------------
3624
3625
3626 Summary
3627 +++++++
3628
3629 return MR_Cluster details
3630
3631 Description
3632 +++++++++++
3633
3634 .. raw:: html
3635
3636     Create an  `MR_Cluster` object.
3637
3638
3639 Request
3640 +++++++
3641
3642
3643 Responses
3644 +++++++++
3645
3646 **200**
3647 ^^^^^^^
3648
3649 Success
3650
3651
3652 Type: :ref:`MR_Cluster <d_eec7176a0080debe1b19c2dad2e97c24>`
3653
3654 **Example:**
3655
3656 .. code-block:: javascript
3657
3658     {
3659         "dcaeLocationName": "somestring",
3660         "fqdn": "somestring",
3661         "lastMod": "2015-01-01T15:00:00.000Z",
3662         "replicationGroup": "somestring",
3663         "sourceReplicationPort": "somestring",
3664         "status": "EMPTY",
3665         "targetReplicationPort": "somestring",
3666         "topicPort": "somestring",
3667         "topicProtocol": "somestring"
3668     }
3669
3670 **400**
3671 ^^^^^^^
3672
3673 Error
3674
3675
3676 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
3677
3678 **Example:**
3679
3680 .. code-block:: javascript
3681
3682     {
3683         "code": 1,
3684         "fields": "somestring",
3685         "is2xx": true,
3686         "message": "somestring"
3687     }
3688
3689
3690
3691
3692
3693 DELETE ``/mr_clusters/{clusterId}``
3694 -----------------------------------
3695
3696
3697 Summary
3698 +++++++
3699
3700 return MR_Cluster details
3701
3702 Description
3703 +++++++++++
3704
3705 .. raw:: html
3706
3707     Delete an  `MR_Cluster` object, specified by clusterId.
3708
3709 Parameters
3710 ++++++++++
3711
3712 .. csv-table::
3713     :delim: |
3714     :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
3715     :widths: 20, 15, 10, 10, 10, 20, 30
3716
3717         clusterId | path | Yes | string |  |  |
3718
3719
3720 Request
3721 +++++++
3722
3723
3724 Responses
3725 +++++++++
3726
3727 **200**
3728 ^^^^^^^
3729
3730 successful operation
3731
3732
3733 Type: :ref:`MR_Cluster <d_eec7176a0080debe1b19c2dad2e97c24>`
3734
3735 **Example:**
3736
3737 .. code-block:: javascript
3738
3739     {
3740         "dcaeLocationName": "somestring",
3741         "fqdn": "somestring",
3742         "lastMod": "2015-01-01T15:00:00.000Z",
3743         "replicationGroup": "somestring",
3744         "sourceReplicationPort": "somestring",
3745         "status": "EMPTY",
3746         "targetReplicationPort": "somestring",
3747         "topicPort": "somestring",
3748         "topicProtocol": "somestring"
3749     }
3750
3751 **204**
3752 ^^^^^^^
3753
3754 Success
3755
3756
3757 Type: :ref:`MR_Cluster <d_eec7176a0080debe1b19c2dad2e97c24>`
3758
3759 **Example:**
3760
3761 .. code-block:: javascript
3762
3763     {
3764         "dcaeLocationName": "somestring",
3765         "fqdn": "somestring",
3766         "lastMod": "2015-01-01T15:00:00.000Z",
3767         "replicationGroup": "somestring",
3768         "sourceReplicationPort": "somestring",
3769         "status": "EMPTY",
3770         "targetReplicationPort": "somestring",
3771         "topicPort": "somestring",
3772         "topicProtocol": "somestring"
3773     }
3774
3775 **400**
3776 ^^^^^^^
3777
3778 Error
3779
3780
3781 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
3782
3783 **Example:**
3784
3785 .. code-block:: javascript
3786
3787     {
3788         "code": 1,
3789         "fields": "somestring",
3790         "is2xx": true,
3791         "message": "somestring"
3792     }
3793
3794
3795
3796
3797
3798 GET ``/mr_clusters/{clusterId}``
3799 --------------------------------
3800
3801
3802 Summary
3803 +++++++
3804
3805 return MR_Cluster details
3806
3807 Description
3808 +++++++++++
3809
3810 .. raw:: html
3811
3812     Retrieve an  `MR_Cluster` object, specified by clusterId.
3813
3814 Parameters
3815 ++++++++++
3816
3817 .. csv-table::
3818     :delim: |
3819     :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
3820     :widths: 20, 15, 10, 10, 10, 20, 30
3821
3822         clusterId | path | Yes | string |  |  |
3823
3824
3825 Request
3826 +++++++
3827
3828
3829 Responses
3830 +++++++++
3831
3832 **200**
3833 ^^^^^^^
3834
3835 Success
3836
3837
3838 Type: :ref:`MR_Cluster <d_eec7176a0080debe1b19c2dad2e97c24>`
3839
3840 **Example:**
3841
3842 .. code-block:: javascript
3843
3844     {
3845         "dcaeLocationName": "somestring",
3846         "fqdn": "somestring",
3847         "lastMod": "2015-01-01T15:00:00.000Z",
3848         "replicationGroup": "somestring",
3849         "sourceReplicationPort": "somestring",
3850         "status": "EMPTY",
3851         "targetReplicationPort": "somestring",
3852         "topicPort": "somestring",
3853         "topicProtocol": "somestring"
3854     }
3855
3856 **400**
3857 ^^^^^^^
3858
3859 Error
3860
3861
3862 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
3863
3864 **Example:**
3865
3866 .. code-block:: javascript
3867
3868     {
3869         "code": 1,
3870         "fields": "somestring",
3871         "is2xx": true,
3872         "message": "somestring"
3873     }
3874
3875
3876
3877
3878
3879 GET ``/mr_clusters``
3880 --------------------
3881
3882
3883 Summary
3884 +++++++
3885
3886 return MR_Cluster details
3887
3888 Description
3889 +++++++++++
3890
3891 .. raw:: html
3892
3893     Returns array of  `MR_Cluster` objects.
3894
3895
3896 Request
3897 +++++++
3898
3899
3900 Responses
3901 +++++++++
3902
3903 **200**
3904 ^^^^^^^
3905
3906 Success
3907
3908
3909 Type: :ref:`MR_Cluster <d_eec7176a0080debe1b19c2dad2e97c24>`
3910
3911 **Example:**
3912
3913 .. code-block:: javascript
3914
3915     {
3916         "dcaeLocationName": "somestring",
3917         "fqdn": "somestring",
3918         "lastMod": "2015-01-01T15:00:00.000Z",
3919         "replicationGroup": "somestring",
3920         "sourceReplicationPort": "somestring",
3921         "status": "EMPTY",
3922         "targetReplicationPort": "somestring",
3923         "topicPort": "somestring",
3924         "topicProtocol": "somestring"
3925     }
3926
3927 **400**
3928 ^^^^^^^
3929
3930 Error
3931
3932
3933 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
3934
3935 **Example:**
3936
3937 .. code-block:: javascript
3938
3939     {
3940         "code": 1,
3941         "fields": "somestring",
3942         "is2xx": true,
3943         "message": "somestring"
3944     }
3945
3946
3947
3948
3949
3950 PUT ``/mr_clusters/{clusterId}``
3951 --------------------------------
3952
3953
3954 Summary
3955 +++++++
3956
3957 return MR_Cluster details
3958
3959 Description
3960 +++++++++++
3961
3962 .. raw:: html
3963
3964     Update an  `MR_Cluster` object, specified by clusterId.
3965
3966 Parameters
3967 ++++++++++
3968
3969 .. csv-table::
3970     :delim: |
3971     :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
3972     :widths: 20, 15, 10, 10, 10, 20, 30
3973
3974         clusterId | path | Yes | string |  |  |
3975
3976
3977 Request
3978 +++++++
3979
3980
3981 Responses
3982 +++++++++
3983
3984 **200**
3985 ^^^^^^^
3986
3987 Success
3988
3989
3990 Type: :ref:`MR_Cluster <d_eec7176a0080debe1b19c2dad2e97c24>`
3991
3992 **Example:**
3993
3994 .. code-block:: javascript
3995
3996     {
3997         "dcaeLocationName": "somestring",
3998         "fqdn": "somestring",
3999         "lastMod": "2015-01-01T15:00:00.000Z",
4000         "replicationGroup": "somestring",
4001         "sourceReplicationPort": "somestring",
4002         "status": "EMPTY",
4003         "targetReplicationPort": "somestring",
4004         "topicPort": "somestring",
4005         "topicProtocol": "somestring"
4006     }
4007
4008 **400**
4009 ^^^^^^^
4010
4011 Error
4012
4013
4014 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
4015
4016 **Example:**
4017
4018 .. code-block:: javascript
4019
4020     {
4021         "code": 1,
4022         "fields": "somestring",
4023         "is2xx": true,
4024         "message": "somestring"
4025     }
4026
4027
4028
4029
4030 TOPICS
4031 ~~~~~~
4032
4033
4034 Endpoint for retreiving MR Topics
4035
4036
4037
4038
4039
4040 POST ``/topics``
4041 ----------------
4042
4043
4044 Summary
4045 +++++++
4046
4047 Create a Topic object
4048
4049 Description
4050 +++++++++++
4051
4052 .. raw:: html
4053
4054     Create  `Topic` object.For convenience, the message body may populate the `clients` array, in which case each entry will be added as an `MR_Client`.  Beginning in ONAP Dublin Release, dbcapi will create two AAF Roles by default, one each for the publisher and subscriber per topic.  MR_Clients can then specify an AAF Identity to be added to the appropriate default Role, avoiding the need to create Role(s) in advance.
4055
4056 Parameters
4057 ++++++++++
4058
4059 .. csv-table::
4060     :delim: |
4061     :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
4062     :widths: 20, 15, 10, 10, 10, 20, 30
4063
4064         useExisting | query | No | string |  |  |
4065
4066
4067 Request
4068 +++++++
4069
4070
4071 Responses
4072 +++++++++
4073
4074 **200**
4075 ^^^^^^^
4076
4077 Success
4078
4079
4080 Type: :ref:`Topic <d_2e99841971da81b9d240071b86bf168d>`
4081
4082 **Example:**
4083
4084 .. code-block:: javascript
4085
4086     {
4087         "clients": [
4088             {
4089                 "action": [
4090                     "somestring",
4091                     "somestring"
4092                 ],
4093                 "clientIdentity": "somestring",
4094                 "clientRole": "somestring",
4095                 "dcaeLocationName": "somestring",
4096                 "fqtn": "somestring",
4097                 "lastMod": "2015-01-01T15:00:00.000Z",
4098                 "mrClientId": "somestring",
4099                 "status": "EMPTY",
4100                 "topicURL": "somestring"
4101             },
4102             {
4103                 "action": [
4104                     "somestring",
4105                     "somestring"
4106                 ],
4107                 "clientIdentity": "somestring",
4108                 "clientRole": "somestring",
4109                 "dcaeLocationName": "somestring",
4110                 "fqtn": "somestring",
4111                 "lastMod": "2015-01-01T15:00:00.000Z",
4112                 "mrClientId": "somestring",
4113                 "status": "EMPTY",
4114                 "topicURL": "somestring"
4115             }
4116         ],
4117         "formatUuid": "somestring",
4118         "fqtn": "somestring",
4119         "fqtnStyle": "FQTN_NOT_SPECIFIED",
4120         "globalMrURL": "somestring",
4121         "lastMod": "2015-01-01T15:00:00.000Z",
4122         "owner": "somestring",
4123         "partitionCount": "somestring",
4124         "publisherRole": "somestring",
4125         "replicationCase": "REPLICATION_NOT_SPECIFIED",
4126         "replicationCount": "somestring",
4127         "status": "EMPTY",
4128         "subscriberRole": "somestring",
4129         "tnxEnabled": "somestring",
4130         "topicDescription": "somestring",
4131         "topicName": "somestring",
4132         "version": "somestring"
4133     }
4134
4135 **400**
4136 ^^^^^^^
4137
4138 Error
4139
4140
4141 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
4142
4143 **Example:**
4144
4145 .. code-block:: javascript
4146
4147     {
4148         "code": 1,
4149         "fields": "somestring",
4150         "is2xx": true,
4151         "message": "somestring"
4152     }
4153
4154
4155
4156
4157
4158 DELETE ``/topics/{topicId}``
4159 ----------------------------
4160
4161
4162 Summary
4163 +++++++
4164
4165 return Topic details
4166
4167 Description
4168 +++++++++++
4169
4170 .. raw:: html
4171
4172     Delete a  `Topic` object, identified by topicId
4173
4174 Parameters
4175 ++++++++++
4176
4177 .. csv-table::
4178     :delim: |
4179     :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
4180     :widths: 20, 15, 10, 10, 10, 20, 30
4181
4182         topicId | path | Yes | string |  |  |
4183
4184
4185 Request
4186 +++++++
4187
4188
4189 Responses
4190 +++++++++
4191
4192 **200**
4193 ^^^^^^^
4194
4195 successful operation
4196
4197
4198 Type: :ref:`Topic <d_2e99841971da81b9d240071b86bf168d>`
4199
4200 **Example:**
4201
4202 .. code-block:: javascript
4203
4204     {
4205         "clients": [
4206             {
4207                 "action": [
4208                     "somestring",
4209                     "somestring"
4210                 ],
4211                 "clientIdentity": "somestring",
4212                 "clientRole": "somestring",
4213                 "dcaeLocationName": "somestring",
4214                 "fqtn": "somestring",
4215                 "lastMod": "2015-01-01T15:00:00.000Z",
4216                 "mrClientId": "somestring",
4217                 "status": "EMPTY",
4218                 "topicURL": "somestring"
4219             },
4220             {
4221                 "action": [
4222                     "somestring",
4223                     "somestring"
4224                 ],
4225                 "clientIdentity": "somestring",
4226                 "clientRole": "somestring",
4227                 "dcaeLocationName": "somestring",
4228                 "fqtn": "somestring",
4229                 "lastMod": "2015-01-01T15:00:00.000Z",
4230                 "mrClientId": "somestring",
4231                 "status": "EMPTY",
4232                 "topicURL": "somestring"
4233             }
4234         ],
4235         "formatUuid": "somestring",
4236         "fqtn": "somestring",
4237         "fqtnStyle": "FQTN_NOT_SPECIFIED",
4238         "globalMrURL": "somestring",
4239         "lastMod": "2015-01-01T15:00:00.000Z",
4240         "owner": "somestring",
4241         "partitionCount": "somestring",
4242         "publisherRole": "somestring",
4243         "replicationCase": "REPLICATION_NOT_SPECIFIED",
4244         "replicationCount": "somestring",
4245         "status": "EMPTY",
4246         "subscriberRole": "somestring",
4247         "tnxEnabled": "somestring",
4248         "topicDescription": "somestring",
4249         "topicName": "somestring",
4250         "version": "somestring"
4251     }
4252
4253 **204**
4254 ^^^^^^^
4255
4256 Success
4257
4258
4259 Type: :ref:`Topic <d_2e99841971da81b9d240071b86bf168d>`
4260
4261 **Example:**
4262
4263 .. code-block:: javascript
4264
4265     {
4266         "clients": [
4267             {
4268                 "action": [
4269                     "somestring",
4270                     "somestring"
4271                 ],
4272                 "clientIdentity": "somestring",
4273                 "clientRole": "somestring",
4274                 "dcaeLocationName": "somestring",
4275                 "fqtn": "somestring",
4276                 "lastMod": "2015-01-01T15:00:00.000Z",
4277                 "mrClientId": "somestring",
4278                 "status": "EMPTY",
4279                 "topicURL": "somestring"
4280             },
4281             {
4282                 "action": [
4283                     "somestring",
4284                     "somestring"
4285                 ],
4286                 "clientIdentity": "somestring",
4287                 "clientRole": "somestring",
4288                 "dcaeLocationName": "somestring",
4289                 "fqtn": "somestring",
4290                 "lastMod": "2015-01-01T15:00:00.000Z",
4291                 "mrClientId": "somestring",
4292                 "status": "EMPTY",
4293                 "topicURL": "somestring"
4294             }
4295         ],
4296         "formatUuid": "somestring",
4297         "fqtn": "somestring",
4298         "fqtnStyle": "FQTN_NOT_SPECIFIED",
4299         "globalMrURL": "somestring",
4300         "lastMod": "2015-01-01T15:00:00.000Z",
4301         "owner": "somestring",
4302         "partitionCount": "somestring",
4303         "publisherRole": "somestring",
4304         "replicationCase": "REPLICATION_NOT_SPECIFIED",
4305         "replicationCount": "somestring",
4306         "status": "EMPTY",
4307         "subscriberRole": "somestring",
4308         "tnxEnabled": "somestring",
4309         "topicDescription": "somestring",
4310         "topicName": "somestring",
4311         "version": "somestring"
4312     }
4313
4314 **400**
4315 ^^^^^^^
4316
4317 Error
4318
4319
4320 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
4321
4322 **Example:**
4323
4324 .. code-block:: javascript
4325
4326     {
4327         "code": 1,
4328         "fields": "somestring",
4329         "is2xx": true,
4330         "message": "somestring"
4331     }
4332
4333
4334
4335
4336
4337 GET ``/topics/{topicId}``
4338 -------------------------
4339
4340
4341 Summary
4342 +++++++
4343
4344 return Topic details
4345
4346 Description
4347 +++++++++++
4348
4349 .. raw:: html
4350
4351     Retrieve a  `Topic` object, identified by topicId
4352
4353 Parameters
4354 ++++++++++
4355
4356 .. csv-table::
4357     :delim: |
4358     :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
4359     :widths: 20, 15, 10, 10, 10, 20, 30
4360
4361         topicId | path | Yes | string |  |  |
4362
4363
4364 Request
4365 +++++++
4366
4367
4368 Responses
4369 +++++++++
4370
4371 **200**
4372 ^^^^^^^
4373
4374 Success
4375
4376
4377 Type: :ref:`Topic <d_2e99841971da81b9d240071b86bf168d>`
4378
4379 **Example:**
4380
4381 .. code-block:: javascript
4382
4383     {
4384         "clients": [
4385             {
4386                 "action": [
4387                     "somestring",
4388                     "somestring"
4389                 ],
4390                 "clientIdentity": "somestring",
4391                 "clientRole": "somestring",
4392                 "dcaeLocationName": "somestring",
4393                 "fqtn": "somestring",
4394                 "lastMod": "2015-01-01T15:00:00.000Z",
4395                 "mrClientId": "somestring",
4396                 "status": "EMPTY",
4397                 "topicURL": "somestring"
4398             },
4399             {
4400                 "action": [
4401                     "somestring",
4402                     "somestring"
4403                 ],
4404                 "clientIdentity": "somestring",
4405                 "clientRole": "somestring",
4406                 "dcaeLocationName": "somestring",
4407                 "fqtn": "somestring",
4408                 "lastMod": "2015-01-01T15:00:00.000Z",
4409                 "mrClientId": "somestring",
4410                 "status": "EMPTY",
4411                 "topicURL": "somestring"
4412             }
4413         ],
4414         "formatUuid": "somestring",
4415         "fqtn": "somestring",
4416         "fqtnStyle": "FQTN_NOT_SPECIFIED",
4417         "globalMrURL": "somestring",
4418         "lastMod": "2015-01-01T15:00:00.000Z",
4419         "owner": "somestring",
4420         "partitionCount": "somestring",
4421         "publisherRole": "somestring",
4422         "replicationCase": "REPLICATION_NOT_SPECIFIED",
4423         "replicationCount": "somestring",
4424         "status": "EMPTY",
4425         "subscriberRole": "somestring",
4426         "tnxEnabled": "somestring",
4427         "topicDescription": "somestring",
4428         "topicName": "somestring",
4429         "version": "somestring"
4430     }
4431
4432 **400**
4433 ^^^^^^^
4434
4435 Error
4436
4437
4438 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
4439
4440 **Example:**
4441
4442 .. code-block:: javascript
4443
4444     {
4445         "code": 1,
4446         "fields": "somestring",
4447         "is2xx": true,
4448         "message": "somestring"
4449     }
4450
4451
4452
4453
4454
4455 GET ``/topics``
4456 ---------------
4457
4458
4459 Summary
4460 +++++++
4461
4462 return Topic details
4463
4464 Description
4465 +++++++++++
4466
4467 .. raw:: html
4468
4469     Returns array of  `Topic` objects.
4470
4471
4472 Request
4473 +++++++
4474
4475
4476 Responses
4477 +++++++++
4478
4479 **200**
4480 ^^^^^^^
4481
4482 Success
4483
4484
4485 Type: :ref:`Topic <d_2e99841971da81b9d240071b86bf168d>`
4486
4487 **Example:**
4488
4489 .. code-block:: javascript
4490
4491     {
4492         "clients": [
4493             {
4494                 "action": [
4495                     "somestring",
4496                     "somestring"
4497                 ],
4498                 "clientIdentity": "somestring",
4499                 "clientRole": "somestring",
4500                 "dcaeLocationName": "somestring",
4501                 "fqtn": "somestring",
4502                 "lastMod": "2015-01-01T15:00:00.000Z",
4503                 "mrClientId": "somestring",
4504                 "status": "EMPTY",
4505                 "topicURL": "somestring"
4506             },
4507             {
4508                 "action": [
4509                     "somestring",
4510                     "somestring"
4511                 ],
4512                 "clientIdentity": "somestring",
4513                 "clientRole": "somestring",
4514                 "dcaeLocationName": "somestring",
4515                 "fqtn": "somestring",
4516                 "lastMod": "2015-01-01T15:00:00.000Z",
4517                 "mrClientId": "somestring",
4518                 "status": "EMPTY",
4519                 "topicURL": "somestring"
4520             }
4521         ],
4522         "formatUuid": "somestring",
4523         "fqtn": "somestring",
4524         "fqtnStyle": "FQTN_NOT_SPECIFIED",
4525         "globalMrURL": "somestring",
4526         "lastMod": "2015-01-01T15:00:00.000Z",
4527         "owner": "somestring",
4528         "partitionCount": "somestring",
4529         "publisherRole": "somestring",
4530         "replicationCase": "REPLICATION_NOT_SPECIFIED",
4531         "replicationCount": "somestring",
4532         "status": "EMPTY",
4533         "subscriberRole": "somestring",
4534         "tnxEnabled": "somestring",
4535         "topicDescription": "somestring",
4536         "topicName": "somestring",
4537         "version": "somestring"
4538     }
4539
4540 **400**
4541 ^^^^^^^
4542
4543 Error
4544
4545
4546 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
4547
4548 **Example:**
4549
4550 .. code-block:: javascript
4551
4552     {
4553         "code": 1,
4554         "fields": "somestring",
4555         "is2xx": true,
4556         "message": "somestring"
4557     }
4558
4559
4560
4561
4562
4563 PUT ``/topics/{topicId}``
4564 -------------------------
4565
4566
4567 Summary
4568 +++++++
4569
4570 return Topic details
4571
4572 Description
4573 +++++++++++
4574
4575 .. raw:: html
4576
4577     Update a  `Topic` object, identified by topicId
4578
4579 Parameters
4580 ++++++++++
4581
4582 .. csv-table::
4583     :delim: |
4584     :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
4585     :widths: 20, 15, 10, 10, 10, 20, 30
4586
4587         topicId | path | Yes | string |  |  |
4588
4589
4590 Request
4591 +++++++
4592
4593
4594 Responses
4595 +++++++++
4596
4597 **200**
4598 ^^^^^^^
4599
4600 Success
4601
4602
4603 Type: :ref:`Topic <d_2e99841971da81b9d240071b86bf168d>`
4604
4605 **Example:**
4606
4607 .. code-block:: javascript
4608
4609     {
4610         "clients": [
4611             {
4612                 "action": [
4613                     "somestring",
4614                     "somestring"
4615                 ],
4616                 "clientIdentity": "somestring",
4617                 "clientRole": "somestring",
4618                 "dcaeLocationName": "somestring",
4619                 "fqtn": "somestring",
4620                 "lastMod": "2015-01-01T15:00:00.000Z",
4621                 "mrClientId": "somestring",
4622                 "status": "EMPTY",
4623                 "topicURL": "somestring"
4624             },
4625             {
4626                 "action": [
4627                     "somestring",
4628                     "somestring"
4629                 ],
4630                 "clientIdentity": "somestring",
4631                 "clientRole": "somestring",
4632                 "dcaeLocationName": "somestring",
4633                 "fqtn": "somestring",
4634                 "lastMod": "2015-01-01T15:00:00.000Z",
4635                 "mrClientId": "somestring",
4636                 "status": "EMPTY",
4637                 "topicURL": "somestring"
4638             }
4639         ],
4640         "formatUuid": "somestring",
4641         "fqtn": "somestring",
4642         "fqtnStyle": "FQTN_NOT_SPECIFIED",
4643         "globalMrURL": "somestring",
4644         "lastMod": "2015-01-01T15:00:00.000Z",
4645         "owner": "somestring",
4646         "partitionCount": "somestring",
4647         "publisherRole": "somestring",
4648         "replicationCase": "REPLICATION_NOT_SPECIFIED",
4649         "replicationCount": "somestring",
4650         "status": "EMPTY",
4651         "subscriberRole": "somestring",
4652         "tnxEnabled": "somestring",
4653         "topicDescription": "somestring",
4654         "topicName": "somestring",
4655         "version": "somestring"
4656     }
4657
4658 **400**
4659 ^^^^^^^
4660
4661 Error
4662
4663
4664 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
4665
4666 **Example:**
4667
4668 .. code-block:: javascript
4669
4670     {
4671         "code": 1,
4672         "fields": "somestring",
4673         "is2xx": true,
4674         "message": "somestring"
4675     }
4676
4677
4678
4679
4680 Data Structures
4681 ~~~~~~~~~~~~~~~
4682
4683 .. _d_a3a7580ce9d87225d7f62e6b67b4d036:
4684
4685 ApiError Model Structure
4686 ------------------------
4687
4688 .. csv-table::
4689     :delim: |
4690     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
4691     :widths: 20, 10, 15, 15, 30, 25
4692
4693         code | No | integer | int32 |  |
4694         fields | No | string |  |  |
4695         is2xx | No | boolean |  |  |
4696         message | No | string |  |  |
4697
4698 .. _d_d71baea9d8e4e59bc395ef51f45dff1b:
4699
4700 BrTopic Model Structure
4701 -----------------------
4702
4703 .. csv-table::
4704     :delim: |
4705     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
4706     :widths: 20, 10, 15, 15, 30, 25
4707
4708         brSource | No | string |  |  |
4709         brTarget | No | string |  |  |
4710         mmAgentName | No | string |  |  |
4711         topicCount | No | integer | int32 |  |
4712
4713 .. _d_d15e2cee407536866c875375e3f705e0:
4714
4715 DR_Node Model Structure
4716 -----------------------
4717
4718 .. csv-table::
4719     :delim: |
4720     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
4721     :widths: 20, 10, 15, 15, 30, 25
4722
4723         dcaeLocationName | No | string |  |  |
4724         fqdn | No | string |  |  |
4725         hostName | No | string |  |  |
4726         lastMod | No | string | date-time |  | datestamp for last update to this object
4727         status | No | string |  | {'enum': ['EMPTY', 'NEW', 'STAGED', 'VALID', 'INVALID', 'DELETED']} |
4728         version | No | string |  |  |
4729
4730 .. _d_e926d3fa8701e0cc9c8ed1761b3255cd:
4731
4732 DR_Pub Model Structure
4733 ----------------------
4734
4735 .. csv-table::
4736     :delim: |
4737     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
4738     :widths: 20, 10, 15, 15, 30, 25
4739
4740         dcaeLocationName | No | string |  |  |
4741         feedId | No | string |  |  |
4742         lastMod | No | string | date-time |  | datestamp for last update to this object
4743         pubId | No | string |  |  |
4744         status | No | string |  | {'enum': ['EMPTY', 'NEW', 'STAGED', 'VALID', 'INVALID', 'DELETED']} |
4745         username | No | string |  |  |
4746         userpwd | No | string |  |  |
4747
4748 .. _d_48cf328d246f41e1d11a09251b042f02:
4749
4750 DR_Sub Model Structure
4751 ----------------------
4752
4753 .. csv-table::
4754     :delim: |
4755     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
4756     :widths: 20, 10, 15, 15, 30, 25
4757
4758         bytes | No | array of string |  |  |
4759         dcaeLocationName | No | string |  |  |
4760         deliveryURL | No | string |  |  |
4761         feedId | No | string |  |  |
4762         lastMod | No | string | date-time |  | datestamp for last update to this object
4763         logURL | No | string |  |  |
4764         owner | No | string |  |  |
4765         status | No | string |  | {'enum': ['EMPTY', 'NEW', 'STAGED', 'VALID', 'INVALID', 'DELETED']} |
4766         subId | No | string |  |  |
4767         suspended | No | boolean |  |  |
4768         use100 | No | boolean |  |  |
4769         username | No | string |  |  |
4770         userpwd | No | string |  |  |
4771
4772 .. _d_47d80e451933beb623fcf5257867cbcb:
4773
4774 DcaeLocation Model Structure
4775 ----------------------------
4776
4777 .. csv-table::
4778     :delim: |
4779     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
4780     :widths: 20, 10, 15, 15, 30, 25
4781
4782         central | No | boolean |  |  |
4783         clli | No | string |  |  |
4784         dcaeLayer | No | string |  |  |
4785         dcaeLocationName | No | string |  |  |
4786         lastMod | No | string | date-time |  | datestamp for last update to this object
4787         local | No | boolean |  |  |
4788         openStackAvailabilityZone | No | string |  |  |
4789         status | No | string |  | {'enum': ['EMPTY', 'NEW', 'STAGED', 'VALID', 'INVALID', 'DELETED']} |
4790         subnet | No | string |  |  |
4791
4792 .. _d_4ea0e7758a1f8502222793e4a13b04f7:
4793
4794 Dmaap Model Structure
4795 ---------------------
4796
4797 .. csv-table::
4798     :delim: |
4799     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
4800     :widths: 20, 10, 15, 15, 30, 25
4801
4802         accessKeyOwner | No | string |  |  |
4803         bridgeAdminTopic | No | string |  |  |
4804         dmaapName | No | string |  |  |
4805         drProvUrl | No | string |  |  |
4806         lastMod | No | string | date-time |  | datestamp for last update to this object
4807         loggingUrl | No | string |  |  |
4808         nodeKey | No | string |  |  |
4809         status | No | string |  | {'enum': ['EMPTY', 'NEW', 'STAGED', 'VALID', 'INVALID', 'DELETED']} |
4810         topicNsRoot | No | string |  |  |
4811         version | No | string |  |  |
4812
4813 .. _d_289ad39619725df26c9ff382d4c97c75:
4814
4815 Feed Model Structure
4816 --------------------
4817
4818 .. csv-table::
4819     :delim: |
4820     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
4821     :widths: 20, 10, 15, 15, 30, 25
4822
4823         asprClassification | No | string |  |  |
4824         bytes | No | array of string |  |  |
4825         feedDescription | No | string |  |  |
4826         feedId | No | string |  |  |
4827         feedName | No | string |  |  |
4828         feedVersion | No | string |  |  |
4829         formatUuid | No | string |  |  |
4830         lastMod | No | string | date-time |  | datestamp for last update to this object
4831         logURL | No | string |  |  |
4832         owner | No | string |  |  |
4833         publishURL | No | string |  |  |
4834         pubs | No | array of :ref:`DR_Pub <d_e926d3fa8701e0cc9c8ed1761b3255cd>` |  |  |
4835         status | No | string |  | {'enum': ['EMPTY', 'NEW', 'STAGED', 'VALID', 'INVALID', 'DELETED']} |
4836         subs | No | array of :ref:`DR_Sub <d_48cf328d246f41e1d11a09251b042f02>` |  |  |
4837         subscribeURL | No | string |  |  |
4838         suspended | No | boolean |  |  |
4839
4840 .. _d_56ff81dc98986e27074d9be2731e3f4c:
4841
4842 MR_Client Model Structure
4843 -------------------------
4844
4845 .. csv-table::
4846     :delim: |
4847     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
4848     :widths: 20, 10, 15, 15, 30, 25
4849
4850         action | No | array of string |  |  | one or more actions from the set ('pub', 'sub', 'view') for which this client needs Permission
4851         clientIdentity | No | string |  |  | an AAF identity to be associated to an appropriate topic Role
4852         clientRole | No | string |  |  | an AAF Role to be granted an appropriate Permission.  If specified, takes precedence over clientIdentity, for backwards compatibility.
4853         dcaeLocationName | No | string |  |  | a tag indicating a logical deployment site
4854         fqtn | No | string |  |  | Fully Qualified Topic Name constructed by dbcapi
4855         lastMod | No | string | date-time |  | datestamp for last update to this object
4856         mrClientId | No | string |  |  | a unique identifier generated by dbcapi for this client
4857         status | No | string |  | {'enum': ['EMPTY', 'NEW', 'STAGED', 'VALID', 'INVALID', 'DELETED']} |
4858         topicURL | No | string |  |  | the URL for a MR instance - typically in the same dcaeLocation - that this client should use to access the topic
4859
4860 .. _d_eec7176a0080debe1b19c2dad2e97c24:
4861
4862 MR_Cluster Model Structure
4863 --------------------------
4864
4865 .. csv-table::
4866     :delim: |
4867     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
4868     :widths: 20, 10, 15, 15, 30, 25
4869
4870         dcaeLocationName | No | string |  |  |
4871         fqdn | No | string |  |  |
4872         lastMod | No | string | date-time |  |
4873         replicationGroup | No | string |  |  |
4874         sourceReplicationPort | No | string |  |  |
4875         status | No | string |  | {'enum': ['EMPTY', 'NEW', 'STAGED', 'VALID', 'INVALID', 'DELETED']} |
4876         targetReplicationPort | No | string |  |  |
4877         topicPort | No | string |  |  |
4878         topicProtocol | No | string |  |  |
4879
4880 .. _d_08fb211d40d6deb9b6e04b000fd988e4:
4881
4882 MirrorMaker Model Structure
4883 ---------------------------
4884
4885 .. csv-table::
4886     :delim: |
4887     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
4888     :widths: 20, 10, 15, 15, 30, 25
4889
4890         lastMod | No | string | date-time |  | datestamp for last update to this object
4891         mmName | No | string |  |  |
4892         sourceCluster | No | string |  |  |
4893         status | No | string |  | {'enum': ['EMPTY', 'NEW', 'STAGED', 'VALID', 'INVALID', 'DELETED']} |
4894         targetCluster | No | string |  |  |
4895         topicCount | No | integer | int32 |  |
4896         topics | No | array of string |  |  |
4897         whitelistUpdateJSON | No | string |  |  |
4898
4899 .. _d_2e99841971da81b9d240071b86bf168d:
4900
4901 Topic Model Structure
4902 ---------------------
4903
4904 .. csv-table::
4905     :delim: |
4906     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
4907     :widths: 20, 10, 15, 15, 30, 25
4908
4909         clients | No | array of :ref:`MR_Client <d_56ff81dc98986e27074d9be2731e3f4c>` |  |  | an array of `MR_Client` objects associated to this `Topic`
4910         formatUuid | No | string |  |  | a reference to an identifier that describes a data format used for this `Topic`
4911         fqtn | No | string |  |  | Fully Qualified Topic Name constructed by dbcapi, following the rules for `fqtnStyle`
4912         fqtnStyle | No | string |  | {'enum': ['FQTN_NOT_SPECIFIED', 'FQTN_LEGACY_FORMAT', 'FQTN_PROJECTID_FORMAT', 'FQTN_PROJECTID_VERSION_FORMAT']} | the construction rule for the `fqtn` field
4913         globalMrURL | No | string |  |  | the URL of an outside MR instance
4914         lastMod | No | string | date-time |  | datestamp for last update to this object
4915         owner | No | string |  |  | a label used to identify who requested this `Topic` to be provisioned.  In the future this may be an AAF Identity.
4916         partitionCount | No | string |  |  | the kafka attribute for specifying the number of partitions
4917         publisherRole | No | string |  |  | a value generated by dbcapi, this AAF Role has permission to publish to this `Topic`
4918         replicationCase | No | string |  | {'enum': ['REPLICATION_NOT_SPECIFIED', 'REPLICATION_NONE', 'REPLICATION_EDGE_TO_CENTRAL', 'REPLICATION_EDGE_TO_CENTRAL_TO_GLOBAL', 'REPLICATION_CENTRAL_TO_EDGE', 'REPLICATION_CENTRAL_TO_GLOBAL', 'REPLICATION_GLOBAL_TO_CENTRAL', 'REPLICATION_GLOBAL_TO_CENTRAL_TO_EDGE', 'REPLICATION_EDGE_TO_FQDN', 'REPLICATION_FQDN_TO_EDGE', 'REPLICATION_FQDN_TO_GLOBAL', 'REPLICATION_GLOBAL_TO_FQDN', 'REPLICATION_EDGE_TO_FQDN_TO_GLOBAL', 'REPLICATION_GLOBAL_TO_FQDN_TO_EDGE']} | An indicator for how this `Topic` should be replicated when there are more than one `MR_Cluster` instances
4919         replicationCount | No | string |  |  | the kafka attribute for specifying replication within an `MR_Cluster` instance
4920         status | No | string |  | {'enum': ['EMPTY', 'NEW', 'STAGED', 'VALID', 'INVALID', 'DELETED']} |
4921         subscriberRole | No | string |  |  | a value generated by dbcapi, this AAF Role has permission to subscribe to this `Topic`
4922         tnxEnabled | No | string |  |  |
4923         topicDescription | No | string |  |  | a description of what this Topic is used for
4924         topicName | No | string |  |  | the short name used by humans, and utilized to construct the `FQTN`
4925         version | No | string |  |  | a hook for any versioning needed for managing a `Topic` over time
4926