-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathformatted.json
24105 lines (24105 loc) · 705 KB
/
formatted.json
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
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"swagger": "2.0",
"info": {
"description": "The REST API for Oracle Essbase enables you to automate management of Essbase resources and operations. All requests and responses are communicated over secured HTTP.",
"version": "1.0",
"title": ""
},
"basePath": "/essbase/rest/v1",
"tags": [
{
"name": "Roles"
},
{
"name": "Files"
},
{
"name": "Application Configuration"
},
{
"name": "Application Connections"
},
{
"name": "Global Connections"
},
{
"name": "Application Datasources"
},
{
"name": "Global Datasources"
},
{
"name": "Drill Through Reports"
},
{
"name": "Email"
},
{
"name": "Workbook Utilities"
},
{
"name": "Filters"
},
{
"name": "Groups"
},
{
"name": "Jobs"
},
{
"name": "Location Aliases"
},
{
"name": "Locks"
},
{
"name": "Application Logs"
},
{
"name": "About Essbase"
},
{
"name": "Applications"
},
{
"name": "Audit Trail"
},
{
"name": "Batch Outline Editing"
},
{
"name": "Database Size Statistics"
},
{
"name": "Dimensions"
},
{
"name": "URLs"
},
{
"name": "File Scanner"
},
{
"name": "User Session"
},
{
"name": "Templates and Utilities"
},
{
"name": "Aggregate Storage Load Buffers"
},
{
"name": "Grid Preferences"
},
{
"name": "Grid"
},
{
"name": "Performance Analyzer"
},
{
"name": "Layouts"
},
{
"name": "Execute MDX"
},
{
"name": "Named Queries"
},
{
"name": "Database Settings and Statistics"
},
{
"name": "Application Settings and Statistics"
},
{
"name": "Outline Viewer"
},
{
"name": "Partitions"
},
{
"name": "Preferences"
},
{
"name": "Properties"
},
{
"name": "Group Provisioning Report"
},
{
"name": "Application Role Provisioning"
},
{
"name": "Service Role Provisioning"
},
{
"name": "User Provisioning Report"
},
{
"name": "Rules"
},
{
"name": "Sandbox Dimension"
},
{
"name": "Scenarios"
},
{
"name": "Scripts"
},
{
"name": "Sessions"
},
{
"name": "Streaming Data Load"
},
{
"name": "Streaming Dimension Build"
},
{
"name": "Users"
},
{
"name": "Server Variables"
},
{
"name": "Variables"
},
{
"name": "Platform Service Settings"
}
],
"paths": {
"/roles": {
"get": {
"tags": [
"Roles"
],
"summary": "Get Essbase Roles",
"description": "<p>Returns the roles available in Essbase. Valid type values are <code>application</code> and <code>server</code>. If type is empty, then both <code>application</code> and <code>server</code> roles are returned.</p> <p>If you are using EPM Shared Services security mode, this operation is not available. Instead, manage users, groups, and permissions in the Shared Services Console.</p>",
"operationId": "Roles.getRoles",
"produces": [
"application/json",
"application/xml"
],
"parameters": [
{
"name": "type",
"in": "query",
"description": "<p>Valid type values are <code>application</code> and <code>server</code>.</p>",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "<p><Strong>OK</strong><p>Returns roles for the specified type.</p>",
"schema": {
"$ref": "#/definitions/Roles"
}
}
}
}
},
"/files/abort/{path}": {
"delete": {
"tags": [
"Files"
],
"summary": "Abort Multipart File Upload",
"description": "<p>Terminate the multipart upload operation of a file and delete all the uploaded parts.</p>",
"operationId": "Files.abortUpload",
"produces": [
"application/json",
"application/xml"
],
"parameters": [
{
"name": "path",
"in": "path",
"description": "<p>File Path to abort</p>",
"required": true,
"type": "string",
"pattern": ".+"
},
{
"name": "uploadId",
"in": "query",
"description": "<p>Upload ID of partial file upload initiation.</p>",
"required": true,
"type": "string"
}
],
"responses": {
"204": {
"description": "<p><strong>No Content</strong></p><p>The file upload operation was terminated successfully.</p>"
},
"500": {
"description": "<p>Internal Server Error.</p>"
}
}
}
},
"/files/upload-create/{path}": {
"post": {
"tags": [
"Files"
],
"summary": "Create Multipart File Upload",
"description": "<p>Initialize a file upload in parts. This operation registers the file object and returns a unique upload ID, which must be included in any request related to this file-part upload.</p><p>Multipart file upload can improve performance of uploads by parallelizing them into threads. Multipart upload also protects against needing to restart large uploads in case of network failures.</p>",
"operationId": "Files.createUpload",
"consumes": [
"application/json",
"application/xml"
],
"produces": [
"application/json",
"application/xml"
],
"parameters": [
{
"name": "path",
"in": "path",
"description": "<p>Catalog path of the folder to which you want to upload the file.</p>",
"required": true,
"type": "string",
"pattern": ".+"
},
{
"name": "overwrite",
"in": "query",
"description": "<p>Overwrite if file exists?</p>",
"required": true,
"type": "boolean",
"default": false
},
{
"name": "append",
"in": "header",
"description": "<p>Append to an existing file?</p>",
"required": true,
"type": "boolean",
"default": false
}
],
"responses": {
"200": {
"description": "<p><strong>OK</strong></p><p>File registered successfully. Returns unique ID.</p>",
"schema": {
"$ref": "#/definitions/CreateFilePartUploadResponse"
}
},
"400": {
"description": "<p><strong>Bad Request</strong></p><p>Logged in user may not have appropriate permissions, or the file may already exist.</p>"
},
"500": {
"description": "<p>Internal Server Error.</p>"
}
}
}
},
"/files/upload-part/{path}": {
"put": {
"tags": [
"Files"
],
"summary": "Upload File Part",
"description": "<p>Upload part of a file in a multipart file upload. You must have already initiated a multipart file upload. Provide the upload path, a part number (integer), and the unique upload ID that was returned from the Create Multipart File Upload operation.</p>",
"operationId": "Files.uploadPart",
"consumes": [
"application/octet-stream"
],
"produces": [
"application/json",
"application/xml"
],
"parameters": [
{
"name": "path",
"in": "path",
"description": "<p>Catalog path of the folder to which you want to upload the file.</p>",
"required": true,
"type": "string",
"pattern": ".+"
},
{
"name": "partNum",
"in": "query",
"description": "<p>Part number for partial file upload.</p>",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "uploadId",
"in": "query",
"description": "<p>Upload ID of partial file upload initiation.</p>",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "<p><strong>OK</strong></p><p>Returns a unique ETag(entity tag). Both the part number and corresponding ETag value for each part when commit the uploaded.</p>",
"schema": {
"$ref": "#/definitions/UploadFilePartResponse"
}
},
"400": {
"description": "<p><strong>Bad Request</strong></p><p>If any issue while uploading parts, it returns error and all parts get clean.</p>"
},
"500": {
"description": "<p>Internal Server Error.</p>"
}
}
}
},
"/files/upload-commit/{path}": {
"post": {
"tags": [
"Files"
],
"summary": "Commit Partial File Upload",
"description": "<p>Commit the upload. Include the part number and corresponding ETag (entity tag) value for each part.</p>",
"operationId": "Files.uploadCommit",
"consumes": [
"application/json",
"application/xml"
],
"produces": [
"application/json",
"application/xml"
],
"parameters": [
{
"name": "path",
"in": "path",
"required": true,
"type": "string",
"pattern": ".+"
},
{
"name": "uploadId",
"in": "query",
"required": false,
"type": "string"
},
{
"in": "body",
"name": "body",
"required": false,
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "<p><strong>OK</strong></p><p>Returns ETag for the file.</p> ",
"schema": {
"$ref": "#/definitions/CommitFilePartUploadResponse"
}
},
"400": {
"description": "<p><strong>Bad Request</strong></p><p>Error occurred while merging all the parts.</p>"
},
"500": {
"description": "<p>Internal Server Error.</p>"
}
}
}
},
"/files/uploadconfig": {
"get": {
"tags": [
"Files"
],
"operationId": "getUploadConfig",
"produces": [
"application/json",
"application/xml"
],
"parameters": [],
"responses": {
"default": {
"description": "successful operation"
}
}
}
},
"/files": {
"get": {
"tags": [
"Files"
],
"summary": "List Root Folders",
"description": "<p>List catalog root folders.</p>",
"operationId": "Files.listRootFolders",
"produces": [
"application/json",
"application/xml"
],
"parameters": [
{
"name": "filter",
"in": "query",
"description": "<p>Filter the list of files.</p>",
"required": false,
"type": "string"
},
{
"name": "recursive",
"in": "query",
"description": "<p>Return search results recursively.</p>",
"required": false,
"type": "boolean",
"default": false
}
],
"responses": {
"200": {
"description": "<p><strong>OK</strong></p><p>Folder list.</p>",
"schema": {
"$ref": "#/definitions/CollectionResponse"
}
},
"400": {
"description": "<p><strong>Bad Request</strong></p><p>Invalid path.</p>"
},
"500": {
"description": "<p>Internal Server Error.</p>"
}
}
}
},
"/files/homepath": {
"get": {
"tags": [
"Files"
],
"summary": "Get Home Path",
"description": "<p>Get user home path.</p>",
"operationId": "Files.getUserHomePath",
"produces": [
"application/json",
"application/xml"
],
"parameters": [],
"responses": {
"200": {
"description": "<p><strong>OK</strong></p><p>User home path.</p>",
"schema": {
"type": "string"
}
},
"400": {
"description": "<p><strong>Bad Request</strong></p><p>Logged in user may not have appropriate permissions.</p>"
},
"500": {
"description": "<p>Internal Server Error.</p>"
}
}
}
},
"/files/sharedpath": {
"get": {
"tags": [
"Files"
],
"summary": "Get Shared Path",
"description": "<p>Get user shared path.</p>",
"operationId": "Files.getSharedPath",
"produces": [
"application/json",
"application/xml"
],
"parameters": [],
"responses": {
"200": {
"description": "<p><strong>OK</strong></p><p>The shared path was returned successfully.</p>",
"schema": {
"type": "string"
}
},
"400": {
"description": "<p><strong>Bad Request</strong></p><p>Logged in user may not have appropriate permissions.</p>"
},
"500": {
"description": "<p>Internal Server Error.</p>"
}
}
}
},
"/files/actions/move": {
"post": {
"tags": [
"Files"
],
"summary": "Move or Rename File",
"description": "<p>Either moves a file from source to destination, or renames a file or folder. Moving a folder is not supported. Renaming a folder is supported only if the folder is not in the applications directory.</p>",
"operationId": "Files.moveResource",
"consumes": [
"application/json",
"application/xml"
],
"produces": [
"application/json",
"application/xml"
],
"parameters": [
{
"in": "body",
"name": "body",
"description": "<p>File path details.</p>",
"required": true,
"schema": {
"$ref": "#/definitions/FilePathDetail"
}
},
{
"name": "overwrite",
"in": "query",
"description": "<p>Overwrite existing file. Only applicable for moving or renaming a file.</p>",
"required": false,
"type": "boolean",
"default": false
}
],
"responses": {
"200": {
"description": "<p><strong>OK</strong></p><p>The file operation completed successfully.</p>"
},
"400": {
"description": "<p><strong>Bad Request</strong></p><p>Logged in user may not have appropriate permissions.</p>"
},
"500": {
"description": "<p>Internal Server Error.</p>"
}
}
}
},
"/files/actions/extract": {
"post": {
"tags": [
"Files"
],
"summary": "Extract Zip File",
"description": "<p>Extract a zip file on same location. Supported for applications, users and shared folders.</p>",
"operationId": "Files.extract",
"consumes": [
"application/json",
"application/xml"
],
"produces": [
"application/json",
"application/xml"
],
"parameters": [
{
"in": "body",
"name": "body",
"description": "<p>Zip file path details.</p>",
"required": true,
"schema": {
"$ref": "#/definitions/ZipFileDetails"
}
},
{
"name": "overwrite",
"in": "query",
"description": "<p>Overwrite existing file. Not applicable for folder.</p>",
"required": false,
"type": "boolean",
"default": false
}
],
"responses": {
"200": {
"description": "<p><strong>OK</strong></p><p>The file operation completed successfully.</p>"
},
"400": {
"description": "<p><strong>Bad Request</strong></p><p>Contains an invalid special character.</p>"
},
"500": {
"description": "<p>Internal Server Error.</p>"
}
}
}
},
"/files/actions/copy": {
"post": {
"tags": [
"Files"
],
"summary": "Copy File",
"description": "Copy a file from source to destination.",
"operationId": "Files.copyResource",
"consumes": [
"application/json",
"application/xml"
],
"produces": [
"application/json",
"application/xml"
],
"parameters": [
{
"in": "body",
"name": "body",
"description": "<p>File path details.</p>",
"required": true,
"schema": {
"$ref": "#/definitions/FilePathDetail"
}
},
{
"name": "overwrite",
"in": "query",
"description": "<p>Overwrite existing file.</p>",
"required": false,
"type": "boolean",
"default": false
}
],
"responses": {
"200": {
"description": "<p><strong>OK</strong></p><p>File copied successfully.</p>"
},
"400": {
"description": "<p><strong>Bad Request</strong></p><p>Logged in user may not have appropriate permissions.</p>"
},
"500": {
"description": "<p>Internal Server Error.</p>"
}
}
}
},
"/files/{path}": {
"get": {
"tags": [
"Files"
],
"summary": "List or Download Files",
"description": "<p>Returns a list of files, or downloads the specified file. To list files, use <code>Accept='application/json'</code> for the Accept header. To download, use <code>Accept='application/octet-stream'</code> for the Accept header.</p>",
"operationId": "Files.listFiles",
"produces": [
"application/json",
"application/xml"
],
"parameters": [
{
"name": "path",
"in": "path",
"description": "<p>Catalog path, starting with <code>applications</code>, <code>shared</code>, or <code>users</code>. If listing files, this is the folder path. If downloading files, this is the file path.</p><p>Examples:</p><ul><li><code>applications/sample</code></li><li><code>shared</code></li><li><code>users/ksmith</code></li></ul>",
"required": true,
"type": "string",
"pattern": ".+"
},
{
"name": "offset",
"in": "query",
"description": "<p>Number of items to omit from the start of the result set. Default value is 0. Applicable only for listing files.</p>",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "limit",
"in": "query",
"description": "<p>Maximum number of files to return. Applicable only for listing files.</p>",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "type",
"in": "query",
"description": "<p>List files by type. If type is not specified, returns all files. Applicable only for listing files.</p>",
"required": false,
"type": "string"
},
{
"name": "overwrite",
"in": "query",
"description": "<p>If true, overwrite files. If false, any existing file is validated but not overwritten. Applicable only with query parameters <code>action=validateUpload</code> and <code>Accept='application/json'</code> or <code>Accept='application/xml'</code> . Default value is false.</p>",
"required": false,
"type": "boolean",
"default": false
},
{
"name": "action",
"in": "query",
"description": "<p>Validates the upload. Supported action values are <code>validateUpload</code> and <code>'Accept=application/json'</code> or <code>'Accept=application/xml'</code>.</p>",
"required": false,
"type": "string"
},
{
"name": "fileSize",
"in": "query",
"description": "<p>Validates whether enough free space is available. Applicable only with query parameters <code>action='validateUpload'</code> and <code>Accept='application/json'</code> or <code>Accept='application/xml'</code>.</p>",
"required": false,
"type": "integer",
"format": "int64"
},
{
"name": "filter",
"in": "query",
"description": "<p>Filter the list of files.</p>",
"required": false,
"type": "string"
},
{
"name": "recursive",
"in": "query",
"description": "<p>Recursive param to get search result as recursive.</p>",
"required": false,
"type": "boolean",
"default": false
}
],
"responses": {
"200": {
"description": "<p><strong>OK</strong></p><p> Response type can be either JSON/XML or stream, depending on the Accept header. If <code>Accept=application/json</code> or <code>Accept=application/xml</code>, the response lists files and current folder details. If <code>Accept=application/octet-stream</code>, the response is returned as a stream. If query parameters include <code>action=validateUpload</code> and <code>Accept='application/json'</code> or <code>Accept='application/xml'</code>, the response is empty.</p>",
"schema": {
"$ref": "#/definitions/CollectionResponse"
}
},
"400": {
"description": "<p><strong>Bad Request</strong></p><p>Logged in user may not have appropriate permissions, or the file may already exist when query parameters include <code>action=validateUpload</code> and <code>Accept='application/json'</code> or <code>Accept='application/xml'</code>.</p>"
},
"500": {
"description": "<p>Internal Server Error.</p>"
}
}
},
"put": {
"tags": [
"Files"
],
"summary": "Upload File or Create Folder",
"description": "<p>Uploads a file to Essbase.</p><p>Supported file types include text files, rules files, calculation script files, and MaxL script files.</p> <p>If there is no content type, and a folder name is specified in the URL, a folder is created.</p>",
"operationId": "Files.addFile",
"consumes": [
"application/octet-stream"
],
"produces": [
"application/json",
"application/xml"
],
"parameters": [
{
"name": "path",
"in": "path",
"description": "<p>Catalog path. If <code>Content-Type=application/octet-stream</code>, this is a file name. Otherwise, it is a folder name.</p>",
"required": true,
"type": "string",
"pattern": ".+"
},
{
"name": "overwrite",
"in": "query",
"description": "<p>Applicable only for adding a file. Overwriting folders is not supported.</p>",
"required": true,
"type": "boolean",
"default": false
},
{
"name": "append",
"in": "header",
"description": "append",
"required": false,
"type": "boolean",
"default": false
}
],
"responses": {
"200": {
"description": "<p><strong>OK</strong></p><p>The file uploaded successfully (if Content-Type is <code>application/octet-stream</code>), or the folder was created successfully (if there is no Content-Type).",
"schema": {
"$ref": "#/definitions/GenericEntity"
}
},
"400": {
"description": "<p><strong>Bad Request</strong></p><p>Logged in user may not have appropriate permissions, or the file or folder may already exist.</p>"
},
"500": {
"description": "<p>Internal Server Error.</p>"
}
}
},
"delete": {
"tags": [
"Files"
],
"summary": "Delete File or Folder",
"description": "<p>Delete the file or folder specified in the path.</p>",
"operationId": "Files.deleteFile",
"produces": [
"application/json",
"application/xml"
],
"parameters": [
{
"name": "path",
"in": "path",
"description": "Path of file/folder to delete",
"required": true,
"type": "string",
"pattern": ".+"
}
],
"responses": {
"204": {
"description": "<p><strong>No Content</strong></p><p>The file or folder was removed successfully.</p>"
},
"400": {
"description": "<p><strong>Bad Request</strong></p><p>Logged in user may not have appropriate permissions.</p>"
},
"500": {
"description": "<p>Internal Server Error.</p>"
}
}
}
},
"/applications/{applicationName}/configurations": {
"get": {
"tags": [
"Application Configuration"
],
"summary": "Get Application Configuration",
"description": "<p>Returns all the configuration properties currently set for the specified application.</p>",
"operationId": "ApplicationConfiguration.getConfigurations",
"produces": [
"application/json",
"application/xml"
],
"parameters": [
{
"name": "applicationName",
"in": "path",
"description": "<p>Application name.</p>",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "<p><strong>OK</strong></p><p>Configuration properties retrieved successfully. Returns all the configuration properties which are set for the application, and the links to get, edit, or delete each property.</p>",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/ApplicationConfigList"
}
}
},
"400": {
"description": "<p><strong>Bad Request</strong></p><p>Failed to get the configuration properties. The application name may be incorrect.</p>"
},
"500": {
"description": "<p>Internal Server Error.</p>"
}
}
},
"post": {
"tags": [
"Application Configuration"
],
"summary": "Add Application Configuration",
"description": "<p>Adds the configuration property to the application and returns the added configuration property name.</p>",
"operationId": "ApplicationConfiguration.addConfiguration",
"consumes": [
"application/json",
"application/xml"
],
"produces": [
"application/json",
"application/xml"
],
"parameters": [
{
"name": "applicationName",
"in": "path",
"description": "<p>Application name.</p>",
"required": true,
"type": "string"
},
{
"in": "body",
"name": "body",
"description": "<p>Configuration property entry.</p>",
"required": true,
"schema": {
"$ref": "#/definitions/ApplicationConfigEntry"
}
}
],
"responses": {
"200": {
"description": "<p><strong>OK</strong></p><p>Configuration property added successfully. Returns the configuration details and the links to get, edit, or delete the configuration.</p>",
"schema": {
"$ref": "#/definitions/ApplicationConfigEntry"
}
},
"400": {
"description": "<p><strong>Bad Request</strong></p><p>Failed to add the configuration property. The application name or the configuration property JSON could be incorrect, or the configuration property might already have been added to the application.</p>"
},
"415": {
"description": "<p><strong>Not Acceptable</strong></p><p>The media type isn't supported or wasn't specified.</p>"
},
"500": {
"description": "<p>Internal Server Error.</p>"
}
}
},
"put": {
"tags": [
"Application Configuration"
],
"summary": "Updates Application Configurations",
"description": "<p>Updates the application configurations and returns the updated configuration details.</p>",
"operationId": "ApplicationConfiguration.setConfigurations",
"consumes": [
"application/json",
"application/xml"
],
"produces": [
"application/json",
"application/xml"
],
"parameters": [
{
"name": "applicationName",
"in": "path",
"description": "<p>Application name.</p>",
"required": true,
"type": "string"
},
{
"in": "body",
"name": "body",
"description": "<p>Configuration property value entries.</p>",
"required": true,
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/ApplicationConfigEntry"
}
}
}
],
"responses": {
"200": {
"description": "<p><strong>OK</strong></p><p>Configurations were updated successfully. Returns the configuration details and the links to get, edit, or delete the configurations.</p>",
"schema": {
"$ref": "#/definitions/ApplicationConfigList"
}
},