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