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