docs/api.rst

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