docs/api.rst

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