Get the report by category
643 matches
100 actions
BeezUP Merchant API
100 actions
- Create a new contractPOSTv1.0.0
- Create a new storePOSTv1.0.0
- Create or replace a custom columnPUTv1.0.0
- Creates a subscription to the ordersPOSTv1.0.0
- Delete a share of a store to another userDELETEv1.0.0
- Delete a specific channel catalog product value overrideDELETEv1.0.0
- Delete a storeDELETEv1.0.0
- Delete a subscription to the ordersDELETEv1.0.0
- Delete custom columnDELETEv1.0.0
- Delete RuleDELETEv1.0.0
- Delete the channel catalogDELETEv1.0.0
- Delete the report filterDELETEv1.0.0
- Delete your next contractDELETEv1.0.0
- Fetch the publication history for an account, sorted by descending start dateGETv1.0.0
- Get a paginated list of all Orders with all Order and Order Item(s) propertiesPOSTv1.0.0
- Get a paginated list of all Orders without detailsPOSTv1.0.0
- Get a subscription to the ordersGETv1.0.0
- Get all list namesGETv1.0.0
- Get all list namesGETv1.0.0
- Get all standard offersGETv1.0.0
- Get all your invoicesGETv1.0.0
- Get an Order's harvest and change historyGETv1.0.0
- Get billing periods conditionsGETv1.0.0
- Get catalog column listGETv1.0.0
- Get category listGETv1.0.0
- Get channel catalog categoriesGETv1.0.0
- Get channel catalog exclusion filtersGETv1.0.0
- Get channel catalog filter operatorsGETv1.0.0
- Get channel catalog product informationGETv1.0.0
- Get channel catalog product information listPOSTv1.0.0
- Get channel catalog product value override compatibilities statusGETv1.0.0
- Get channel catalog products related to these channel catalogsPOSTv1.0.0
- Get channel catalog products' countersGETv1.0.0
- Get channel categoriesGETv1.0.0
- Get channel columnsPOSTv1.0.0
- Get channel informationGETv1.0.0
- Get contract listGETv1.0.0
- Get credit card informationGETv1.0.0
- Get custom column listGETv1.0.0
- Get friend informationGETv1.0.0
- Get full Order and Order Item(s) propertiesGETv1.0.0
- Get list of configured automatic Order status transitionsGETv1.0.0
- Get offer pricingPOSTv1.0.0
- Get Order Invoice design settingsGETv1.0.0
- Get Order Invoice general settingsGETv1.0.0
- Get product by ProductIdGETv1.0.0
- Get product by SkuGETv1.0.0
- Get product listPOSTv1.0.0
- Get profile picture informationGETv1.0.0
- Get public channel indexGETv1.0.0
- Get random product listGETv1.0.0
- Get report filter list for the given storeGETv1.0.0
- Get shares related to this storeGETv1.0.0
- Get store listGETv1.0.0
- Get store's alertsGETv1.0.0
- Get store's informationGETv1.0.0
- Get store's rightsGETv1.0.0
- Get the Analytics API operation indexGETv1.0.0
- Get the Analytics API operation index for one storeGETv1.0.0
- Get the BeezUP columnsGETv1.0.0
- Get the channel catalog configured to use legacy tracking format informationGETv1.0.0
- Get the channel catalog informationGETv1.0.0
- Get the encrypted custom column expressionGETv1.0.0
- Get the global synchronization status of clicks and ordersGETv1.0.0
- Get the index of the catalog APIGETv1.0.0
- Get the index of the catalog API for this storeGETv1.0.0
- Get the latest tracked clicksGETv1.0.0
- Get the latest tracked external ordersGETv1.0.0
- Get the latest tracked ordersGETv1.0.0
- Get the list of values related to this list nameGETv1.0.0
- Get the list of values related to this list nameGETv1.0.0
- Get the marketplace properties for a channel catalogGETv1.0.0
- Get the marketplace settings for a channel catalogGETv1.0.0
- Get the order change reportingGETv1.0.0
- Get the push reporting related to this subscriptionGETv1.0.0
- Get the report by categoryPOSTv1.0.0
- Get the report by channelPOSTv1.0.0
- Get the report by day for a StoreIdPOSTv1.0.0
- Get the report by day for a StoreIdPOSTv1.0.0
- Get the report by productPOSTv1.0.0
- Get the report filter descriptionGETv1.0.0
- Get the rules execution historyGETv1.0.0
- Get the subscription listGETv1.0.0
- Get the synchronization status of clicks and orders of a storeGETv1.0.0
- Get user account informationGETv1.0.0
- Get your marketplace channel catalog listGETv1.0.0
- GetMarketplaceAccountsSynchronizationV3GETv1.0.0
- GetOrderManagementReadyMarketplaceBusinessCodeGETv1.0.0
- Gets the list of rules for a given storeGETv1.0.0
- Gets the ruleGETv1.0.0
- List all available channel for this storeGETv1.0.0
- List all your current channel catalogsGETv1.0.0
- List all your current channel catalogs configured to use legacy tracking formatGETv1.0.0
- Rule creationPOSTv1.0.0
- The channel list for one countryGETv1.0.0
- The index of all operations and LOVGETv1.0.0
- Update RulePATCHv1.0.0
- Update some store's information.PATCHv1.0.0
- View a preview an Order InvoicePOSTv1.0.0
- View a preview an Order Invoice using custom design settingsPOSTv1.0.0
E-commerce/BeezUP Merchant API
Get the report by category
v1.0.0Input
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
{
"type": "object",
"properties": {
"storeId": {
"type": "string",
"format": "guid"
}
},
"required": [
"storeId"
],
"additionalProperties": false
}Output
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
- 77
- 78
- 79
- 80
- 81
- 82
- 83
- 84
- 85
- 86
- 87
- 88
- 89
- 90
- 91
- 92
- 93
- 94
- 95
- 96
- 97
- 98
- 99
- 100
- 101
- 102
- 103
- 104
- 105
- 106
- 107
- 108
- 109
- 110
- 111
- 112
- 113
- 114
- 115
- 116
- 117
- 118
- 119
- 120
- 121
- 122
- 123
- 124
- 125
- 126
- 127
- 128
- 129
- 130
- 131
- 132
- 133
- 134
- 135
- 136
- 137
- 138
- 139
- 140
- 141
- 142
- 143
- 144
- 145
- 146
- 147
- 148
- 149
- 150
- 151
- 152
- 153
- 154
- 155
- 156
- 157
- 158
- 159
- 160
- 161
- 162
- 163
- 164
- 165
- 166
- 167
- 168
- 169
- 170
- 171
- 172
- 173
- 174
- 175
- 176
- 177
- 178
- 179
- 180
- 181
- 182
- 183
- 184
- 185
- 186
- 187
- 188
- 189
- 190
- 191
- 192
- 193
- 194
- 195
- 196
- 197
- 198
- 199
- 200
- 201
- 202
- 203
- 204
- 205
- 206
- 207
- 208
- 209
- 210
- 211
- 212
- 213
- 214
- 215
- 216
- 217
- 218
- 219
- 220
- 221
- 222
- 223
- 224
- 225
- 226
- 227
- 228
- 229
- 230
- 231
- 232
- 233
- 234
- 235
- 236
- 237
- 238
- 239
- 240
- 241
- 242
- 243
- 244
- 245
- 246
- 247
- 248
- 249
- 250
- 251
- 252
- 253
- 254
- 255
- 256
- 257
- 258
- 259
- 260
- 261
- 262
- 263
- 264
- 265
- 266
- 267
- 268
- 269
- 270
- 271
- 272
- 273
- 274
- 275
- 276
- 277
- 278
- 279
- 280
- 281
- 282
- 283
- 284
- 285
- 286
- 287
- 288
- 289
- 290
- 291
- 292
- 293
- 294
- 295
- 296
- 297
- 298
- 299
- 300
- 301
- 302
- 303
- 304
- 305
- 306
- 307
- 308
- 309
- 310
- 311
- 312
- 313
- 314
- 315
- 316
- 317
- 318
- 319
- 320
- 321
- 322
- 323
- 324
- 325
- 326
- 327
- 328
- 329
- 330
- 331
- 332
- 333
- 334
- 335
- 336
- 337
- 338
- 339
- 340
- 341
- 342
- 343
- 344
- 345
- 346
- 347
- 348
- 349
- 350
- 351
- 352
- 353
- 354
- 355
- 356
- 357
- 358
- 359
- 360
- 361
- 362
- 363
- 364
- 365
- 366
- 367
- 368
- 369
- 370
- 371
- 372
- 373
- 374
- 375
- 376
- 377
- 378
- 379
- 380
- 381
- 382
- 383
- 384
- 385
- 386
- 387
- 388
- 389
- 390
- 391
- 392
- 393
- 394
- 395
- 396
- 397
- 398
- 399
- 400
- 401
- 402
- 403
- 404
- 405
- 406
- 407
- 408
- 409
- 410
- 411
- 412
- 413
- 414
- 415
- 416
- 417
- 418
- 419
- 420
- 421
- 422
- 423
- 424
- 425
- 426
- 427
- 428
- 429
- 430
- 431
- 432
- 433
- 434
- 435
- 436
- 437
- 438
- 439
- 440
- 441
- 442
- 443
- 444
- 445
- 446
- 447
- 448
- 449
- 450
- 451
- 452
- 453
- 454
- 455
- 456
- 457
- 458
- 459
- 460
- 461
- 462
- 463
- 464
- 465
- 466
- 467
- 468
- 469
- 470
- 471
- 472
- 473
- 474
- 475
- 476
- 477
- 478
- 479
- 480
- 481
- 482
- 483
- 484
- 485
- 486
- 487
- 488
- 489
- 490
- 491
- 492
- 493
- 494
- 495
- 496
- 497
- 498
- 499
- 500
- 501
- 502
- 503
- 504
- 505
- 506
- 507
- 508
- 509
- 510
- 511
- 512
- 513
- 514
- 515
- 516
- 517
- 518
- 519
- 520
- 521
- 522
- 523
- 524
- 525
- 526
- 527
- 528
- 529
- 530
- 531
- 532
- 533
- 534
- 535
- 536
- 537
- 538
- 539
- 540
- 541
- 542
- 543
- 544
- 545
- 546
- 547
- 548
- 549
- 550
- 551
- 552
- 553
- 554
- 555
- 556
- 557
- 558
- 559
- 560
- 561
- 562
- 563
- 564
- 565
- 566
- 567
- 568
- 569
- 570
- 571
- 572
- 573
- 574
- 575
- 576
- 577
- 578
- 579
- 580
- 581
- 582
- 583
- 584
- 585
- 586
- 587
- 588
- 589
- 590
- 591
- 592
- 593
- 594
- 595
- 596
- 597
- 598
- 599
- 600
- 601
- 602
- 603
- 604
- 605
- 606
- 607
- 608
- 609
- 610
- 611
- 612
- 613
- 614
- 615
- 616
- 617
- 618
- 619
- 620
- 621
- 622
- 623
- 624
- 625
- 626
- 627
- 628
- 629
- 630
- 631
- 632
- 633
- 634
- 635
- 636
- 637
- 638
- 639
- 640
- 641
- 642
- 643
- 644
- 645
- 646
- 647
- 648
- 649
- 650
- 651
- 652
- 653
- 654
- 655
- 656
- 657
- 658
- 659
- 660
- 661
- 662
- 663
- 664
- 665
- 666
- 667
- 668
- 669
- 670
- 671
- 672
- 673
- 674
- 675
- 676
- 677
- 678
- 679
- 680
- 681
- 682
- 683
- 684
- 685
- 686
- 687
- 688
- 689
- 690
- 691
- 692
- 693
- 694
- 695
- 696
- 697
- 698
- 699
- 700
- 701
- 702
- 703
- 704
- 705
- 706
- 707
- 708
- 709
- 710
- 711
- 712
- 713
- 714
- 715
- 716
- 717
- 718
- 719
- 720
- 721
- 722
- 723
- 724
- 725
- 726
- 727
- 728
- 729
- 730
- 731
- 732
- 733
- 734
- 735
- 736
- 737
- 738
- 739
- 740
- 741
- 742
- 743
- 744
- 745
- 746
- 747
- 748
- 749
- 750
- 751
- 752
- 753
- 754
- 755
- 756
- 757
- 758
- 759
- 760
- 761
- 762
- 763
- 764
- 765
- 766
- 767
- 768
- 769
- 770
- 771
- 772
- 773
- 774
- 775
- 776
- 777
- 778
- 779
- 780
- 781
- 782
- 783
- 784
- 785
- 786
- 787
- 788
- 789
- 790
- 791
- 792
- 793
- 794
- 795
- 796
- 797
- 798
- 799
- 800
- 801
- 802
- 803
- 804
- 805
- 806
- 807
- 808
- 809
- 810
- 811
- 812
- 813
- 814
- 815
- 816
- 817
- 818
- 819
- 820
- 821
- 822
- 823
- 824
- 825
- 826
- 827
- 828
- 829
- 830
- 831
- 832
- 833
- 834
- 835
- 836
- 837
- 838
- 839
- 840
- 841
- 842
- 843
- 844
- 845
- 846
- 847
- 848
- 849
- 850
- 851
- 852
- 853
- 854
- 855
- 856
- 857
- 858
- 859
- 860
- 861
- 862
- 863
- 864
- 865
- 866
- 867
- 868
- 869
- 870
- 871
- 872
- 873
- 874
- 875
- 876
- 877
- 878
- 879
- 880
- 881
- 882
- 883
- 884
- 885
- 886
- 887
- 888
- 889
- 890
- 891
- 892
- 893
- 894
- 895
- 896
- 897
- 898
- 899
- 900
- 901
- 902
- 903
- 904
- 905
- 906
- 907
- 908
- 909
{
"type": "object",
"properties": {
"categories": {
"type": "array",
"items": {
"type": "object",
"required": [
"catalogCategoryId",
"allProductCount",
"catalogProductCount",
"enabledProductCount",
"clickCount",
"cost",
"orderCount",
"performanceIndicator",
"totalSales",
"soldProductCount",
"links"
],
"properties": {
"allProductCount": {
"type": "integer",
"description": "The product count for this category. This includes all the products that have been imported and can still have associated clicks and orders."
},
"catalogCategoryId": {
"type": "string",
"format": "guid",
"description": "The catalog category identifier"
},
"catalogCategoryPath": {
"type": "array",
"description": "The catalog category path",
"items": {
"type": "string"
}
},
"catalogProductCount": {
"type": "integer",
"description": "The catalog product count for this category. This includes all products that are still present in your imported catalog."
},
"clickCount": {
"type": "integer",
"description": "The click count for this category"
},
"cost": {
"type": "number",
"description": "The cost for this category"
},
"enabledProductCount": {
"type": "integer",
"description": "The enabled product count for this category. This includes all products that are still present in your imported catalog and have not been disabled via the optimisation feature."
},
"links": {
"type": "object",
"properties": {
"disableProducts": {
"type": "object"
},
"enableProducts": {
"type": "object"
}
}
},
"margin": {
"type": "number",
"description": "The margin for this category"
},
"orderCount": {
"type": "integer",
"description": "The order count for this category"
},
"performanceIndicator": {
"type": "number",
"description": "The performance indicator based on the performance indicator formula indicated in the request for this category"
},
"roi": {
"type": "number",
"description": "The Return On Investment for this category"
},
"soldProductCount": {
"type": "integer",
"description": "The product sold count count for this category"
},
"totalSales": {
"type": "number",
"description": "The total sales for this category"
}
}
}
},
"currencyCode": {
"type": "string",
"description": "The currency code <a href=\"https://en.wikipedia.org/wiki/ISO_4217\">(ISO 4217)</a>\n"
},
"links": {
"type": "object"
},
"paginationResult": {
"type": "object",
"required": [
"entryCount",
"links",
"pageCount",
"totalEntryCount"
],
"properties": {
"entryCount": {
"type": "integer",
"description": "The entry count currently returned"
},
"links": {
"type": "object",
"description": "The navigation links 'first', 'last', 'next', 'previous'",
"required": [
"first",
"last"
],
"properties": {
"first": {
"type": "object",
"required": [
"href"
],
"properties": {
"allOptionalParamsProvided": {
"type": "boolean",
"description": "indicates whether all optionals params have been provided"
},
"allRequiredParamsProvided": {
"type": "boolean",
"description": "indicates whether all required params have been provided"
},
"description": {
"type": "string",
"description": "The description of the link"
},
"docUrl": {
"type": "string",
"format": "uri",
"description": "The documentation related to this operation."
},
"href": {
"type": "string",
"description": "Indicate the relative uri for this link"
},
"info": {
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"errorArguments": {
"type": "object"
},
"errorCode": {
"type": "string"
},
"errorGuid": {
"type": "string",
"format": "uuid"
},
"errorMessage": {
"type": "string"
},
"exceptionDetail": {
"type": "object",
"properties": {
"helpLink": {
"type": "object",
"additionalProperties": true
},
"message": {
"type": "object",
"additionalProperties": true
},
"stackTrace": {
"type": "object",
"additionalProperties": true
},
"type": {
"type": "object",
"additionalProperties": true
}
}
},
"objectName": {
"type": "string"
},
"propertyName": {
"type": "string"
},
"propertyValue": {
"type": "string"
},
"source": {
"type": "string"
},
"technicalErrorMessage": {
"type": "string"
},
"utcDate": {
"type": "string",
"format": "date-time"
}
}
}
},
"informations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"informationArguments": {
"type": "object"
},
"informationCode": {
"type": "string"
},
"informationMessage": {
"type": "string"
},
"objectName": {
"type": "string"
},
"propertyName": {
"type": "string"
},
"propertyValue": {
"type": "string"
}
}
}
},
"successes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"objectName": {
"type": "string"
},
"propertyName": {
"type": "string"
},
"propertyValue": {
"type": "string"
},
"successArguments": {
"type": "object"
},
"successCode": {
"type": "string"
},
"successMessage": {
"type": "string"
}
}
}
},
"warnings": {
"type": "array",
"items": {
"type": "object",
"properties": {
"technicalErrorMessage": {
"type": "string"
},
"warningArguments": {
"type": "object"
},
"warningCode": {
"type": "string"
},
"warningMessage": {
"type": "string"
}
}
}
}
}
},
"label": {
"type": "string",
"description": "The label corresponding to the link. This label is automatically translated based on the Accept-Language http header."
},
"method": {
"type": "string",
"description": "Indicate the http method to use on this link",
"enum": [
"GET",
"POST",
"PATCH",
"DELETE",
"PUT",
"HEAD"
]
},
"operationId": {
"type": "string",
"description": "The operationId to call."
},
"parameters": {
"type": "object"
},
"urlTemplated": {
"type": "boolean",
"description": "indicates whether the href is templated or not"
}
}
},
"last": {
"type": "object",
"required": [
"href"
],
"properties": {
"allOptionalParamsProvided": {
"type": "boolean",
"description": "indicates whether all optionals params have been provided"
},
"allRequiredParamsProvided": {
"type": "boolean",
"description": "indicates whether all required params have been provided"
},
"description": {
"type": "string",
"description": "The description of the link"
},
"docUrl": {
"type": "string",
"format": "uri",
"description": "The documentation related to this operation."
},
"href": {
"type": "string",
"description": "Indicate the relative uri for this link"
},
"info": {
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"errorArguments": {
"type": "object"
},
"errorCode": {
"type": "string"
},
"errorGuid": {
"type": "string",
"format": "uuid"
},
"errorMessage": {
"type": "string"
},
"exceptionDetail": {
"type": "object",
"properties": {
"helpLink": {
"type": "object",
"additionalProperties": true
},
"message": {
"type": "object",
"additionalProperties": true
},
"stackTrace": {
"type": "object",
"additionalProperties": true
},
"type": {
"type": "object",
"additionalProperties": true
}
}
},
"objectName": {
"type": "string"
},
"propertyName": {
"type": "string"
},
"propertyValue": {
"type": "string"
},
"source": {
"type": "string"
},
"technicalErrorMessage": {
"type": "string"
},
"utcDate": {
"type": "string",
"format": "date-time"
}
}
}
},
"informations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"informationArguments": {
"type": "object"
},
"informationCode": {
"type": "string"
},
"informationMessage": {
"type": "string"
},
"objectName": {
"type": "string"
},
"propertyName": {
"type": "string"
},
"propertyValue": {
"type": "string"
}
}
}
},
"successes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"objectName": {
"type": "string"
},
"propertyName": {
"type": "string"
},
"propertyValue": {
"type": "string"
},
"successArguments": {
"type": "object"
},
"successCode": {
"type": "string"
},
"successMessage": {
"type": "string"
}
}
}
},
"warnings": {
"type": "array",
"items": {
"type": "object",
"properties": {
"technicalErrorMessage": {
"type": "string"
},
"warningArguments": {
"type": "object"
},
"warningCode": {
"type": "string"
},
"warningMessage": {
"type": "string"
}
}
}
}
}
},
"label": {
"type": "string",
"description": "The label corresponding to the link. This label is automatically translated based on the Accept-Language http header."
},
"method": {
"type": "string",
"description": "Indicate the http method to use on this link",
"enum": [
"GET",
"POST",
"PATCH",
"DELETE",
"PUT",
"HEAD"
]
},
"operationId": {
"type": "string",
"description": "The operationId to call."
},
"parameters": {
"type": "object"
},
"urlTemplated": {
"type": "boolean",
"description": "indicates whether the href is templated or not"
}
}
},
"next": {
"type": "object",
"required": [
"href"
],
"properties": {
"allOptionalParamsProvided": {
"type": "boolean",
"description": "indicates whether all optionals params have been provided"
},
"allRequiredParamsProvided": {
"type": "boolean",
"description": "indicates whether all required params have been provided"
},
"description": {
"type": "string",
"description": "The description of the link"
},
"docUrl": {
"type": "string",
"format": "uri",
"description": "The documentation related to this operation."
},
"href": {
"type": "string",
"description": "Indicate the relative uri for this link"
},
"info": {
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"errorArguments": {
"type": "object"
},
"errorCode": {
"type": "string"
},
"errorGuid": {
"type": "string",
"format": "uuid"
},
"errorMessage": {
"type": "string"
},
"exceptionDetail": {
"type": "object",
"properties": {
"helpLink": {
"type": "object",
"additionalProperties": true
},
"message": {
"type": "object",
"additionalProperties": true
},
"stackTrace": {
"type": "object",
"additionalProperties": true
},
"type": {
"type": "object",
"additionalProperties": true
}
}
},
"objectName": {
"type": "string"
},
"propertyName": {
"type": "string"
},
"propertyValue": {
"type": "string"
},
"source": {
"type": "string"
},
"technicalErrorMessage": {
"type": "string"
},
"utcDate": {
"type": "string",
"format": "date-time"
}
}
}
},
"informations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"informationArguments": {
"type": "object"
},
"informationCode": {
"type": "string"
},
"informationMessage": {
"type": "string"
},
"objectName": {
"type": "string"
},
"propertyName": {
"type": "string"
},
"propertyValue": {
"type": "string"
}
}
}
},
"successes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"objectName": {
"type": "string"
},
"propertyName": {
"type": "string"
},
"propertyValue": {
"type": "string"
},
"successArguments": {
"type": "object"
},
"successCode": {
"type": "string"
},
"successMessage": {
"type": "string"
}
}
}
},
"warnings": {
"type": "array",
"items": {
"type": "object",
"properties": {
"technicalErrorMessage": {
"type": "string"
},
"warningArguments": {
"type": "object"
},
"warningCode": {
"type": "string"
},
"warningMessage": {
"type": "string"
}
}
}
}
}
},
"label": {
"type": "string",
"description": "The label corresponding to the link. This label is automatically translated based on the Accept-Language http header."
},
"method": {
"type": "string",
"description": "Indicate the http method to use on this link",
"enum": [
"GET",
"POST",
"PATCH",
"DELETE",
"PUT",
"HEAD"
]
},
"operationId": {
"type": "string",
"description": "The operationId to call."
},
"parameters": {
"type": "object"
},
"urlTemplated": {
"type": "boolean",
"description": "indicates whether the href is templated or not"
}
}
},
"previous": {
"type": "object",
"required": [
"href"
],
"properties": {
"allOptionalParamsProvided": {
"type": "boolean",
"description": "indicates whether all optionals params have been provided"
},
"allRequiredParamsProvided": {
"type": "boolean",
"description": "indicates whether all required params have been provided"
},
"description": {
"type": "string",
"description": "The description of the link"
},
"docUrl": {
"type": "string",
"format": "uri",
"description": "The documentation related to this operation."
},
"href": {
"type": "string",
"description": "Indicate the relative uri for this link"
},
"info": {
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"errorArguments": {
"type": "object"
},
"errorCode": {
"type": "string"
},
"errorGuid": {
"type": "string",
"format": "uuid"
},
"errorMessage": {
"type": "string"
},
"exceptionDetail": {
"type": "object",
"properties": {
"helpLink": {
"type": "object",
"additionalProperties": true
},
"message": {
"type": "object",
"additionalProperties": true
},
"stackTrace": {
"type": "object",
"additionalProperties": true
},
"type": {
"type": "object",
"additionalProperties": true
}
}
},
"objectName": {
"type": "string"
},
"propertyName": {
"type": "string"
},
"propertyValue": {
"type": "string"
},
"source": {
"type": "string"
},
"technicalErrorMessage": {
"type": "string"
},
"utcDate": {
"type": "string",
"format": "date-time"
}
}
}
},
"informations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"informationArguments": {
"type": "object"
},
"informationCode": {
"type": "string"
},
"informationMessage": {
"type": "string"
},
"objectName": {
"type": "string"
},
"propertyName": {
"type": "string"
},
"propertyValue": {
"type": "string"
}
}
}
},
"successes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"objectName": {
"type": "string"
},
"propertyName": {
"type": "string"
},
"propertyValue": {
"type": "string"
},
"successArguments": {
"type": "object"
},
"successCode": {
"type": "string"
},
"successMessage": {
"type": "string"
}
}
}
},
"warnings": {
"type": "array",
"items": {
"type": "object",
"properties": {
"technicalErrorMessage": {
"type": "string"
},
"warningArguments": {
"type": "object"
},
"warningCode": {
"type": "string"
},
"warningMessage": {
"type": "string"
}
}
}
}
}
},
"label": {
"type": "string",
"description": "The label corresponding to the link. This label is automatically translated based on the Accept-Language http header."
},
"method": {
"type": "string",
"description": "Indicate the http method to use on this link",
"enum": [
"GET",
"POST",
"PATCH",
"DELETE",
"PUT",
"HEAD"
]
},
"operationId": {
"type": "string",
"description": "The operationId to call."
},
"parameters": {
"type": "object"
},
"urlTemplated": {
"type": "boolean",
"description": "indicates whether the href is templated or not"
}
}
}
}
},
"pageCount": {
"type": "integer",
"description": "The page count"
},
"totalEntryCount": {
"type": "integer",
"description": "The total entry count"
}
}
}
}
}