docs/apis/api.rst

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