@datocms/cma-client 1.3.5 → 2.0.0-alpha.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/generated/Client.js +1 -1
- package/dist/cjs/generated/Client.js.map +1 -1
- package/dist/cjs/generated/resources/Item.js +51 -6
- package/dist/cjs/generated/resources/Item.js.map +1 -1
- package/dist/cjs/generated/resources/Plugin.js +2 -2
- package/dist/cjs/generated/resources/ScheduledPublication.js +1 -1
- package/dist/cjs/generated/resources/ScheduledPublication.js.map +1 -1
- package/dist/cjs/generated/resources/ScheduledUnpublishing.js +1 -1
- package/dist/cjs/generated/resources/ScheduledUnpublishing.js.map +1 -1
- package/dist/esm/generated/Client.js +1 -1
- package/dist/esm/generated/Client.js.map +1 -1
- package/dist/esm/generated/SchemaTypes.d.ts +600 -422
- package/dist/esm/generated/SimpleSchemaTypes.d.ts +248 -83
- package/dist/esm/generated/resources/Item.d.ts +26 -4
- package/dist/esm/generated/resources/Item.js +51 -6
- package/dist/esm/generated/resources/Item.js.map +1 -1
- package/dist/esm/generated/resources/Plugin.d.ts +2 -2
- package/dist/esm/generated/resources/Plugin.js +2 -2
- package/dist/esm/generated/resources/ScheduledPublication.js +1 -1
- package/dist/esm/generated/resources/ScheduledPublication.js.map +1 -1
- package/dist/esm/generated/resources/ScheduledUnpublishing.js +1 -1
- package/dist/esm/generated/resources/ScheduledUnpublishing.js.map +1 -1
- package/dist/types/generated/SchemaTypes.d.ts +600 -422
- package/dist/types/generated/SimpleSchemaTypes.d.ts +248 -83
- package/dist/types/generated/resources/Item.d.ts +26 -4
- package/dist/types/generated/resources/Plugin.d.ts +2 -2
- package/package.json +3 -3
- package/resources.json +226 -3
- package/src/generated/Client.ts +1 -1
- package/src/generated/SchemaTypes.ts +626 -443
- package/src/generated/SimpleSchemaTypes.ts +255 -86
- package/src/generated/resources/Item.ts +67 -2
- package/src/generated/resources/Plugin.ts +2 -2
- package/src/generated/resources/ScheduledPublication.ts +1 -1
- package/src/generated/resources/ScheduledUnpublishing.ts +1 -1
package/resources.json
CHANGED
|
@@ -10,6 +10,7 @@
|
|
|
10
10
|
"method": "POST",
|
|
11
11
|
"comment": "Create a new role",
|
|
12
12
|
"requestBodyType": "RoleCreateSchema",
|
|
13
|
+
"optionalRequestBody": false,
|
|
13
14
|
"requestStructure": {
|
|
14
15
|
"type": "role",
|
|
15
16
|
"attributes": [
|
|
@@ -61,8 +62,10 @@
|
|
|
61
62
|
"relType": "RoleData"
|
|
62
63
|
},
|
|
63
64
|
"requestBodyType": "RoleUpdateSchema",
|
|
65
|
+
"optionalRequestBody": false,
|
|
64
66
|
"requestStructure": {
|
|
65
67
|
"type": "role",
|
|
68
|
+
"idRequired": true,
|
|
66
69
|
"attributes": [
|
|
67
70
|
"name",
|
|
68
71
|
"can_edit_favicon",
|
|
@@ -106,6 +109,7 @@
|
|
|
106
109
|
"urlTemplate": "/roles",
|
|
107
110
|
"method": "GET",
|
|
108
111
|
"comment": "List all roles",
|
|
112
|
+
"optionalRequestBody": false,
|
|
109
113
|
"queryParamsRequired": false,
|
|
110
114
|
"responseType": "RoleInstancesTargetSchema",
|
|
111
115
|
"name": "list",
|
|
@@ -123,6 +127,7 @@
|
|
|
123
127
|
"isEntityId": true,
|
|
124
128
|
"relType": "RoleData"
|
|
125
129
|
},
|
|
130
|
+
"optionalRequestBody": false,
|
|
126
131
|
"queryParamsRequired": false,
|
|
127
132
|
"responseType": "RoleSelfTargetSchema",
|
|
128
133
|
"name": "find",
|
|
@@ -140,6 +145,7 @@
|
|
|
140
145
|
"isEntityId": true,
|
|
141
146
|
"relType": "RoleData"
|
|
142
147
|
},
|
|
148
|
+
"optionalRequestBody": false,
|
|
143
149
|
"queryParamsRequired": false,
|
|
144
150
|
"responseType": "RoleDestroyTargetSchema",
|
|
145
151
|
"name": "destroy",
|
|
@@ -165,8 +171,10 @@
|
|
|
165
171
|
"relType": "UserData"
|
|
166
172
|
},
|
|
167
173
|
"requestBodyType": "UserUpdateSchema",
|
|
174
|
+
"optionalRequestBody": false,
|
|
168
175
|
"requestStructure": {
|
|
169
176
|
"type": "user",
|
|
177
|
+
"idRequired": true,
|
|
170
178
|
"attributes": [
|
|
171
179
|
"is_active"
|
|
172
180
|
],
|
|
@@ -186,6 +194,7 @@
|
|
|
186
194
|
"urlTemplate": "/users",
|
|
187
195
|
"method": "GET",
|
|
188
196
|
"comment": "List all collaborators",
|
|
197
|
+
"optionalRequestBody": false,
|
|
189
198
|
"queryParamsRequired": false,
|
|
190
199
|
"responseType": "UserInstancesTargetSchema",
|
|
191
200
|
"name": "list",
|
|
@@ -203,6 +212,7 @@
|
|
|
203
212
|
"isEntityId": true,
|
|
204
213
|
"relType": "UserData"
|
|
205
214
|
},
|
|
215
|
+
"optionalRequestBody": false,
|
|
206
216
|
"queryParamsType": "UserSelfHrefSchema",
|
|
207
217
|
"queryParamsRequired": false,
|
|
208
218
|
"responseType": "UserSelfTargetSchema",
|
|
@@ -216,6 +226,7 @@
|
|
|
216
226
|
"urlTemplate": "/users/me",
|
|
217
227
|
"method": "GET",
|
|
218
228
|
"comment": "Retrieve current signed-in user",
|
|
229
|
+
"optionalRequestBody": false,
|
|
219
230
|
"queryParamsType": "UserMeHrefSchema",
|
|
220
231
|
"queryParamsRequired": false,
|
|
221
232
|
"responseType": "UserMeTargetSchema",
|
|
@@ -234,6 +245,7 @@
|
|
|
234
245
|
"isEntityId": true,
|
|
235
246
|
"relType": "UserData"
|
|
236
247
|
},
|
|
248
|
+
"optionalRequestBody": false,
|
|
237
249
|
"queryParamsType": "UserDestroyHrefSchema",
|
|
238
250
|
"queryParamsRequired": false,
|
|
239
251
|
"responseType": "UserDestroyTargetSchema",
|
|
@@ -254,6 +266,7 @@
|
|
|
254
266
|
"urlTemplate": "/sso-users",
|
|
255
267
|
"method": "GET",
|
|
256
268
|
"comment": "List all users",
|
|
269
|
+
"optionalRequestBody": false,
|
|
257
270
|
"queryParamsRequired": false,
|
|
258
271
|
"responseType": "SsoUserInstancesTargetSchema",
|
|
259
272
|
"name": "list",
|
|
@@ -271,6 +284,7 @@
|
|
|
271
284
|
"isEntityId": false,
|
|
272
285
|
"relType": "UserData"
|
|
273
286
|
},
|
|
287
|
+
"optionalRequestBody": false,
|
|
274
288
|
"queryParamsRequired": false,
|
|
275
289
|
"responseType": "SsoUserSelfTargetSchema",
|
|
276
290
|
"name": "find",
|
|
@@ -283,6 +297,7 @@
|
|
|
283
297
|
"urlTemplate": "/sso-users/copy-users",
|
|
284
298
|
"method": "POST",
|
|
285
299
|
"comment": "Copy editors as SSO users",
|
|
300
|
+
"optionalRequestBody": false,
|
|
286
301
|
"queryParamsRequired": false,
|
|
287
302
|
"responseType": "SsoUserCopyUsersTargetSchema",
|
|
288
303
|
"name": "copyUsers",
|
|
@@ -300,6 +315,7 @@
|
|
|
300
315
|
"isEntityId": false,
|
|
301
316
|
"relType": "UserData"
|
|
302
317
|
},
|
|
318
|
+
"optionalRequestBody": false,
|
|
303
319
|
"queryParamsType": "SsoUserDestroyHrefSchema",
|
|
304
320
|
"queryParamsRequired": false,
|
|
305
321
|
"responseType": "SsoUserDestroyTargetSchema",
|
|
@@ -321,6 +337,7 @@
|
|
|
321
337
|
"method": "POST",
|
|
322
338
|
"comment": "List Audit Log events",
|
|
323
339
|
"requestBodyType": "AuditLogEventQuerySchema",
|
|
340
|
+
"optionalRequestBody": false,
|
|
324
341
|
"requestStructure": {
|
|
325
342
|
"type": "audit_log_query",
|
|
326
343
|
"attributes": [
|
|
@@ -350,6 +367,7 @@
|
|
|
350
367
|
"method": "POST",
|
|
351
368
|
"comment": "Create a new menu item",
|
|
352
369
|
"requestBodyType": "MenuItemCreateSchema",
|
|
370
|
+
"optionalRequestBody": false,
|
|
353
371
|
"requestStructure": {
|
|
354
372
|
"type": "menu_item",
|
|
355
373
|
"attributes": [
|
|
@@ -382,8 +400,10 @@
|
|
|
382
400
|
"relType": "MenuItemData"
|
|
383
401
|
},
|
|
384
402
|
"requestBodyType": "MenuItemUpdateSchema",
|
|
403
|
+
"optionalRequestBody": false,
|
|
385
404
|
"requestStructure": {
|
|
386
405
|
"type": "menu_item",
|
|
406
|
+
"idRequired": true,
|
|
387
407
|
"attributes": [
|
|
388
408
|
"label",
|
|
389
409
|
"external_url",
|
|
@@ -408,6 +428,7 @@
|
|
|
408
428
|
"urlTemplate": "/menu-items",
|
|
409
429
|
"method": "GET",
|
|
410
430
|
"comment": "List all menu items",
|
|
431
|
+
"optionalRequestBody": false,
|
|
411
432
|
"queryParamsType": "MenuItemInstancesHrefSchema",
|
|
412
433
|
"queryParamsRequired": false,
|
|
413
434
|
"responseType": "MenuItemInstancesTargetSchema",
|
|
@@ -426,6 +447,7 @@
|
|
|
426
447
|
"isEntityId": true,
|
|
427
448
|
"relType": "MenuItemData"
|
|
428
449
|
},
|
|
450
|
+
"optionalRequestBody": false,
|
|
429
451
|
"queryParamsRequired": false,
|
|
430
452
|
"responseType": "MenuItemSelfTargetSchema",
|
|
431
453
|
"name": "find",
|
|
@@ -443,6 +465,7 @@
|
|
|
443
465
|
"isEntityId": true,
|
|
444
466
|
"relType": "MenuItemData"
|
|
445
467
|
},
|
|
468
|
+
"optionalRequestBody": false,
|
|
446
469
|
"queryParamsRequired": false,
|
|
447
470
|
"responseType": "MenuItemDestroyTargetSchema",
|
|
448
471
|
"name": "destroy",
|
|
@@ -463,6 +486,7 @@
|
|
|
463
486
|
"method": "POST",
|
|
464
487
|
"comment": "Create a new model",
|
|
465
488
|
"requestBodyType": "ItemTypeCreateSchema",
|
|
489
|
+
"optionalRequestBody": false,
|
|
466
490
|
"requestStructure": {
|
|
467
491
|
"type": "item_type",
|
|
468
492
|
"attributes": [
|
|
@@ -508,8 +532,10 @@
|
|
|
508
532
|
"relType": "ItemTypeData"
|
|
509
533
|
},
|
|
510
534
|
"requestBodyType": "ItemTypeUpdateSchema",
|
|
535
|
+
"optionalRequestBody": false,
|
|
511
536
|
"requestStructure": {
|
|
512
537
|
"type": "item_type",
|
|
538
|
+
"idRequired": true,
|
|
513
539
|
"attributes": [
|
|
514
540
|
"name",
|
|
515
541
|
"api_key",
|
|
@@ -547,6 +573,7 @@
|
|
|
547
573
|
"urlTemplate": "/item-types",
|
|
548
574
|
"method": "GET",
|
|
549
575
|
"comment": "List all models",
|
|
576
|
+
"optionalRequestBody": false,
|
|
550
577
|
"queryParamsRequired": false,
|
|
551
578
|
"responseType": "ItemTypeInstancesTargetSchema",
|
|
552
579
|
"name": "list",
|
|
@@ -564,6 +591,7 @@
|
|
|
564
591
|
"isEntityId": true,
|
|
565
592
|
"relType": "ItemTypeData"
|
|
566
593
|
},
|
|
594
|
+
"optionalRequestBody": false,
|
|
567
595
|
"queryParamsRequired": false,
|
|
568
596
|
"responseType": "ItemTypeSelfTargetSchema",
|
|
569
597
|
"name": "find",
|
|
@@ -581,6 +609,7 @@
|
|
|
581
609
|
"isEntityId": true,
|
|
582
610
|
"relType": "ItemTypeData"
|
|
583
611
|
},
|
|
612
|
+
"optionalRequestBody": false,
|
|
584
613
|
"queryParamsRequired": false,
|
|
585
614
|
"responseType": "ItemTypeDuplicateTargetSchema",
|
|
586
615
|
"name": "duplicate",
|
|
@@ -598,6 +627,7 @@
|
|
|
598
627
|
"isEntityId": true,
|
|
599
628
|
"relType": "ItemTypeData"
|
|
600
629
|
},
|
|
630
|
+
"optionalRequestBody": false,
|
|
601
631
|
"queryParamsType": "ItemTypeDestroyHrefSchema",
|
|
602
632
|
"queryParamsRequired": false,
|
|
603
633
|
"responseType": "ItemTypeDestroyJobSchema",
|
|
@@ -624,6 +654,7 @@
|
|
|
624
654
|
"relType": "ItemTypeData"
|
|
625
655
|
},
|
|
626
656
|
"requestBodyType": "FieldCreateSchema",
|
|
657
|
+
"optionalRequestBody": false,
|
|
627
658
|
"requestStructure": {
|
|
628
659
|
"type": "field",
|
|
629
660
|
"attributes": [
|
|
@@ -660,8 +691,10 @@
|
|
|
660
691
|
"relType": "FieldData"
|
|
661
692
|
},
|
|
662
693
|
"requestBodyType": "FieldUpdateSchema",
|
|
694
|
+
"optionalRequestBody": false,
|
|
663
695
|
"requestStructure": {
|
|
664
696
|
"type": "field",
|
|
697
|
+
"idRequired": true,
|
|
665
698
|
"attributes": [
|
|
666
699
|
"default_value",
|
|
667
700
|
"label",
|
|
@@ -695,6 +728,7 @@
|
|
|
695
728
|
"isEntityId": false,
|
|
696
729
|
"relType": "ItemTypeData"
|
|
697
730
|
},
|
|
731
|
+
"optionalRequestBody": false,
|
|
698
732
|
"queryParamsRequired": false,
|
|
699
733
|
"responseType": "FieldInstancesTargetSchema",
|
|
700
734
|
"name": "list",
|
|
@@ -712,6 +746,7 @@
|
|
|
712
746
|
"isEntityId": false,
|
|
713
747
|
"relType": "ItemTypeData"
|
|
714
748
|
},
|
|
749
|
+
"optionalRequestBody": false,
|
|
715
750
|
"queryParamsRequired": false,
|
|
716
751
|
"responseType": "FieldReferencingTargetSchema",
|
|
717
752
|
"deprecated": "This API call is to be considered private and might change without notice",
|
|
@@ -730,6 +765,7 @@
|
|
|
730
765
|
"isEntityId": false,
|
|
731
766
|
"relType": "ItemTypeData"
|
|
732
767
|
},
|
|
768
|
+
"optionalRequestBody": false,
|
|
733
769
|
"queryParamsRequired": false,
|
|
734
770
|
"responseType": "FieldRelatedTargetSchema",
|
|
735
771
|
"deprecated": "This API call is to be considered private and might change without notice",
|
|
@@ -748,6 +784,7 @@
|
|
|
748
784
|
"isEntityId": true,
|
|
749
785
|
"relType": "FieldData"
|
|
750
786
|
},
|
|
787
|
+
"optionalRequestBody": false,
|
|
751
788
|
"queryParamsRequired": false,
|
|
752
789
|
"responseType": "FieldSelfTargetSchema",
|
|
753
790
|
"name": "find",
|
|
@@ -765,6 +802,7 @@
|
|
|
765
802
|
"isEntityId": true,
|
|
766
803
|
"relType": "FieldData"
|
|
767
804
|
},
|
|
805
|
+
"optionalRequestBody": false,
|
|
768
806
|
"queryParamsRequired": false,
|
|
769
807
|
"responseType": "FieldDestroyJobSchema",
|
|
770
808
|
"name": "destroy",
|
|
@@ -782,6 +820,7 @@
|
|
|
782
820
|
"isEntityId": true,
|
|
783
821
|
"relType": "FieldData"
|
|
784
822
|
},
|
|
823
|
+
"optionalRequestBody": false,
|
|
785
824
|
"queryParamsRequired": false,
|
|
786
825
|
"responseType": "FieldDuplicateJobSchema",
|
|
787
826
|
"name": "duplicate",
|
|
@@ -807,6 +846,7 @@
|
|
|
807
846
|
"relType": "ItemTypeData"
|
|
808
847
|
},
|
|
809
848
|
"requestBodyType": "FieldsetCreateSchema",
|
|
849
|
+
"optionalRequestBody": false,
|
|
810
850
|
"requestStructure": {
|
|
811
851
|
"type": "fieldset",
|
|
812
852
|
"attributes": [
|
|
@@ -836,8 +876,10 @@
|
|
|
836
876
|
"relType": "FieldsetData"
|
|
837
877
|
},
|
|
838
878
|
"requestBodyType": "FieldsetUpdateSchema",
|
|
879
|
+
"optionalRequestBody": false,
|
|
839
880
|
"requestStructure": {
|
|
840
881
|
"type": "fieldset",
|
|
882
|
+
"idRequired": true,
|
|
841
883
|
"attributes": [
|
|
842
884
|
"title",
|
|
843
885
|
"hint",
|
|
@@ -864,6 +906,7 @@
|
|
|
864
906
|
"isEntityId": false,
|
|
865
907
|
"relType": "ItemTypeData"
|
|
866
908
|
},
|
|
909
|
+
"optionalRequestBody": false,
|
|
867
910
|
"queryParamsRequired": false,
|
|
868
911
|
"responseType": "FieldsetInstancesTargetSchema",
|
|
869
912
|
"name": "list",
|
|
@@ -881,6 +924,7 @@
|
|
|
881
924
|
"isEntityId": true,
|
|
882
925
|
"relType": "FieldsetData"
|
|
883
926
|
},
|
|
927
|
+
"optionalRequestBody": false,
|
|
884
928
|
"queryParamsRequired": false,
|
|
885
929
|
"responseType": "FieldsetSelfTargetSchema",
|
|
886
930
|
"name": "find",
|
|
@@ -898,6 +942,7 @@
|
|
|
898
942
|
"isEntityId": true,
|
|
899
943
|
"relType": "FieldsetData"
|
|
900
944
|
},
|
|
945
|
+
"optionalRequestBody": false,
|
|
901
946
|
"queryParamsRequired": false,
|
|
902
947
|
"responseType": "FieldsetDestroyTargetSchema",
|
|
903
948
|
"name": "destroy",
|
|
@@ -918,6 +963,7 @@
|
|
|
918
963
|
"method": "POST",
|
|
919
964
|
"comment": "Create a new session",
|
|
920
965
|
"requestBodyType": "SessionCreateSchema",
|
|
966
|
+
"optionalRequestBody": false,
|
|
921
967
|
"requestStructure": {
|
|
922
968
|
"type": "email_credentials",
|
|
923
969
|
"attributes": [
|
|
@@ -948,6 +994,7 @@
|
|
|
948
994
|
"method": "POST",
|
|
949
995
|
"comment": "Create a new API token",
|
|
950
996
|
"requestBodyType": "AccessTokenCreateSchema",
|
|
997
|
+
"optionalRequestBody": false,
|
|
951
998
|
"requestStructure": {
|
|
952
999
|
"type": "access_token",
|
|
953
1000
|
"attributes": [
|
|
@@ -978,8 +1025,10 @@
|
|
|
978
1025
|
"relType": "AccessTokenData"
|
|
979
1026
|
},
|
|
980
1027
|
"requestBodyType": "AccessTokenUpdateSchema",
|
|
1028
|
+
"optionalRequestBody": false,
|
|
981
1029
|
"requestStructure": {
|
|
982
1030
|
"type": "access_token",
|
|
1031
|
+
"idRequired": true,
|
|
983
1032
|
"attributes": [
|
|
984
1033
|
"name",
|
|
985
1034
|
"can_access_cda",
|
|
@@ -1002,6 +1051,7 @@
|
|
|
1002
1051
|
"urlTemplate": "/access_tokens",
|
|
1003
1052
|
"method": "GET",
|
|
1004
1053
|
"comment": "List all API tokens",
|
|
1054
|
+
"optionalRequestBody": false,
|
|
1005
1055
|
"queryParamsRequired": false,
|
|
1006
1056
|
"responseType": "AccessTokenInstancesTargetSchema",
|
|
1007
1057
|
"name": "list",
|
|
@@ -1019,6 +1069,7 @@
|
|
|
1019
1069
|
"isEntityId": true,
|
|
1020
1070
|
"relType": "AccessTokenData"
|
|
1021
1071
|
},
|
|
1072
|
+
"optionalRequestBody": false,
|
|
1022
1073
|
"queryParamsRequired": false,
|
|
1023
1074
|
"responseType": "AccessTokenSelfTargetSchema",
|
|
1024
1075
|
"name": "find",
|
|
@@ -1036,6 +1087,7 @@
|
|
|
1036
1087
|
"isEntityId": true,
|
|
1037
1088
|
"relType": "AccessTokenData"
|
|
1038
1089
|
},
|
|
1090
|
+
"optionalRequestBody": false,
|
|
1039
1091
|
"queryParamsRequired": false,
|
|
1040
1092
|
"responseType": "AccessTokenRegenerateTokenTargetSchema",
|
|
1041
1093
|
"name": "regenerateToken",
|
|
@@ -1053,6 +1105,7 @@
|
|
|
1053
1105
|
"isEntityId": true,
|
|
1054
1106
|
"relType": "AccessTokenData"
|
|
1055
1107
|
},
|
|
1108
|
+
"optionalRequestBody": false,
|
|
1056
1109
|
"queryParamsType": "AccessTokenDestroyHrefSchema",
|
|
1057
1110
|
"queryParamsRequired": false,
|
|
1058
1111
|
"responseType": "AccessTokenDestroyTargetSchema",
|
|
@@ -1074,6 +1127,7 @@
|
|
|
1074
1127
|
"method": "POST",
|
|
1075
1128
|
"comment": "Create a new plugin",
|
|
1076
1129
|
"requestBodyType": "PluginCreateSchema",
|
|
1130
|
+
"optionalRequestBody": false,
|
|
1077
1131
|
"requestStructure": {
|
|
1078
1132
|
"type": "plugin",
|
|
1079
1133
|
"attributes": [
|
|
@@ -1107,8 +1161,10 @@
|
|
|
1107
1161
|
"relType": "PluginData"
|
|
1108
1162
|
},
|
|
1109
1163
|
"requestBodyType": "PluginUpdateSchema",
|
|
1164
|
+
"optionalRequestBody": false,
|
|
1110
1165
|
"requestStructure": {
|
|
1111
1166
|
"type": "plugin",
|
|
1167
|
+
"idRequired": true,
|
|
1112
1168
|
"attributes": [
|
|
1113
1169
|
"name",
|
|
1114
1170
|
"description",
|
|
@@ -1131,6 +1187,7 @@
|
|
|
1131
1187
|
"urlTemplate": "/plugins",
|
|
1132
1188
|
"method": "GET",
|
|
1133
1189
|
"comment": "List all plugins",
|
|
1190
|
+
"optionalRequestBody": false,
|
|
1134
1191
|
"queryParamsRequired": false,
|
|
1135
1192
|
"responseType": "PluginInstancesTargetSchema",
|
|
1136
1193
|
"name": "list",
|
|
@@ -1142,12 +1199,13 @@
|
|
|
1142
1199
|
"rel": "self",
|
|
1143
1200
|
"urlTemplate": "/plugins/${pluginId}",
|
|
1144
1201
|
"method": "GET",
|
|
1145
|
-
"comment": "Retrieve a
|
|
1202
|
+
"comment": "Retrieve a plugin",
|
|
1146
1203
|
"urlPlaceholder": {
|
|
1147
1204
|
"variableName": "pluginId",
|
|
1148
1205
|
"isEntityId": true,
|
|
1149
1206
|
"relType": "PluginData"
|
|
1150
1207
|
},
|
|
1208
|
+
"optionalRequestBody": false,
|
|
1151
1209
|
"queryParamsRequired": false,
|
|
1152
1210
|
"responseType": "PluginSelfTargetSchema",
|
|
1153
1211
|
"name": "find",
|
|
@@ -1165,6 +1223,7 @@
|
|
|
1165
1223
|
"isEntityId": true,
|
|
1166
1224
|
"relType": "PluginData"
|
|
1167
1225
|
},
|
|
1226
|
+
"optionalRequestBody": false,
|
|
1168
1227
|
"queryParamsRequired": false,
|
|
1169
1228
|
"responseType": "PluginDestroyTargetSchema",
|
|
1170
1229
|
"name": "destroy",
|
|
@@ -1182,6 +1241,7 @@
|
|
|
1182
1241
|
"isEntityId": true,
|
|
1183
1242
|
"relType": "PluginData"
|
|
1184
1243
|
},
|
|
1244
|
+
"optionalRequestBody": false,
|
|
1185
1245
|
"queryParamsRequired": false,
|
|
1186
1246
|
"responseType": "PluginFieldsTargetSchema",
|
|
1187
1247
|
"name": "fields",
|
|
@@ -1206,6 +1266,7 @@
|
|
|
1206
1266
|
"isEntityId": true,
|
|
1207
1267
|
"relType": "JobResultData"
|
|
1208
1268
|
},
|
|
1269
|
+
"optionalRequestBody": false,
|
|
1209
1270
|
"queryParamsRequired": false,
|
|
1210
1271
|
"responseType": "JobResultSelfTargetSchema",
|
|
1211
1272
|
"name": "find",
|
|
@@ -1225,6 +1286,7 @@
|
|
|
1225
1286
|
"urlTemplate": "/subscription-limits",
|
|
1226
1287
|
"method": "GET",
|
|
1227
1288
|
"comment": "Get all the subscription limits",
|
|
1289
|
+
"optionalRequestBody": false,
|
|
1228
1290
|
"queryParamsRequired": false,
|
|
1229
1291
|
"responseType": "SubscriptionLimitInstancesTargetSchema",
|
|
1230
1292
|
"name": "list",
|
|
@@ -1242,6 +1304,7 @@
|
|
|
1242
1304
|
"isEntityId": true,
|
|
1243
1305
|
"relType": "SubscriptionLimitData"
|
|
1244
1306
|
},
|
|
1307
|
+
"optionalRequestBody": false,
|
|
1245
1308
|
"queryParamsRequired": false,
|
|
1246
1309
|
"responseType": "SubscriptionLimitSelfTargetSchema",
|
|
1247
1310
|
"name": "find",
|
|
@@ -1261,6 +1324,7 @@
|
|
|
1261
1324
|
"urlTemplate": "/subscription-features",
|
|
1262
1325
|
"method": "GET",
|
|
1263
1326
|
"comment": "Get all the subscription features",
|
|
1327
|
+
"optionalRequestBody": false,
|
|
1264
1328
|
"queryParamsRequired": false,
|
|
1265
1329
|
"responseType": "SubscriptionFeatureInstancesTargetSchema",
|
|
1266
1330
|
"name": "list",
|
|
@@ -1280,6 +1344,7 @@
|
|
|
1280
1344
|
"urlTemplate": "/build-events",
|
|
1281
1345
|
"method": "GET",
|
|
1282
1346
|
"comment": "List all deploy events",
|
|
1347
|
+
"optionalRequestBody": false,
|
|
1283
1348
|
"queryParamsRequired": false,
|
|
1284
1349
|
"responseType": "BuildEventInstancesTargetSchema",
|
|
1285
1350
|
"name": "list",
|
|
@@ -1297,6 +1362,7 @@
|
|
|
1297
1362
|
"isEntityId": true,
|
|
1298
1363
|
"relType": "BuildEventData"
|
|
1299
1364
|
},
|
|
1365
|
+
"optionalRequestBody": false,
|
|
1300
1366
|
"queryParamsRequired": false,
|
|
1301
1367
|
"responseType": "BuildEventSelfTargetSchema",
|
|
1302
1368
|
"name": "find",
|
|
@@ -1316,6 +1382,7 @@
|
|
|
1316
1382
|
"urlTemplate": "/items",
|
|
1317
1383
|
"method": "GET",
|
|
1318
1384
|
"comment": "List all records",
|
|
1385
|
+
"optionalRequestBody": false,
|
|
1319
1386
|
"queryParamsType": "ItemInstancesHrefSchema",
|
|
1320
1387
|
"queryParamsRequired": false,
|
|
1321
1388
|
"responseType": "ItemInstancesTargetSchema",
|
|
@@ -1339,8 +1406,10 @@
|
|
|
1339
1406
|
"relType": "ItemData"
|
|
1340
1407
|
},
|
|
1341
1408
|
"requestBodyType": "ItemValidateExistingSchema",
|
|
1409
|
+
"optionalRequestBody": false,
|
|
1342
1410
|
"requestStructure": {
|
|
1343
1411
|
"type": "item",
|
|
1412
|
+
"idRequired": true,
|
|
1344
1413
|
"attributes": "*",
|
|
1345
1414
|
"relationships": [
|
|
1346
1415
|
"item_type",
|
|
@@ -1360,6 +1429,7 @@
|
|
|
1360
1429
|
"method": "POST",
|
|
1361
1430
|
"comment": "Validates a record field",
|
|
1362
1431
|
"requestBodyType": "ItemValidateNewSchema",
|
|
1432
|
+
"optionalRequestBody": false,
|
|
1363
1433
|
"requestStructure": {
|
|
1364
1434
|
"type": "item",
|
|
1365
1435
|
"attributes": "*",
|
|
@@ -1381,6 +1451,7 @@
|
|
|
1381
1451
|
"method": "POST",
|
|
1382
1452
|
"comment": "Create a new record",
|
|
1383
1453
|
"requestBodyType": "ItemCreateSchema",
|
|
1454
|
+
"optionalRequestBody": false,
|
|
1384
1455
|
"requestStructure": {
|
|
1385
1456
|
"type": "item",
|
|
1386
1457
|
"attributes": "*",
|
|
@@ -1406,6 +1477,7 @@
|
|
|
1406
1477
|
"isEntityId": true,
|
|
1407
1478
|
"relType": "ItemData"
|
|
1408
1479
|
},
|
|
1480
|
+
"optionalRequestBody": false,
|
|
1409
1481
|
"queryParamsRequired": false,
|
|
1410
1482
|
"responseType": "ItemDuplicateJobSchema",
|
|
1411
1483
|
"name": "duplicate",
|
|
@@ -1424,8 +1496,10 @@
|
|
|
1424
1496
|
"relType": "ItemData"
|
|
1425
1497
|
},
|
|
1426
1498
|
"requestBodyType": "ItemUpdateSchema",
|
|
1499
|
+
"optionalRequestBody": false,
|
|
1427
1500
|
"requestStructure": {
|
|
1428
1501
|
"type": "item",
|
|
1502
|
+
"idRequired": true,
|
|
1429
1503
|
"attributes": "*",
|
|
1430
1504
|
"relationships": [
|
|
1431
1505
|
"item_type",
|
|
@@ -1449,6 +1523,7 @@
|
|
|
1449
1523
|
"isEntityId": true,
|
|
1450
1524
|
"relType": "ItemData"
|
|
1451
1525
|
},
|
|
1526
|
+
"optionalRequestBody": false,
|
|
1452
1527
|
"queryParamsType": "ItemReferencesHrefSchema",
|
|
1453
1528
|
"queryParamsRequired": false,
|
|
1454
1529
|
"responseType": "ItemReferencesTargetSchema",
|
|
@@ -1467,12 +1542,32 @@
|
|
|
1467
1542
|
"isEntityId": true,
|
|
1468
1543
|
"relType": "ItemData"
|
|
1469
1544
|
},
|
|
1545
|
+
"optionalRequestBody": false,
|
|
1470
1546
|
"queryParamsType": "ItemSelfHrefSchema",
|
|
1471
1547
|
"queryParamsRequired": false,
|
|
1472
1548
|
"responseType": "ItemSelfTargetSchema",
|
|
1473
1549
|
"name": "find",
|
|
1474
1550
|
"rawName": "rawFind"
|
|
1475
1551
|
},
|
|
1552
|
+
{
|
|
1553
|
+
"returnsCollection": false,
|
|
1554
|
+
"docUrl": "https://www.datocms.com/docs/content-management-api/resources/item/current_vs_published_state",
|
|
1555
|
+
"rel": "current_vs_published_state",
|
|
1556
|
+
"urlTemplate": "/items/${itemId}/current-vs-published-state",
|
|
1557
|
+
"method": "GET",
|
|
1558
|
+
"comment": "Retrieve information regarding changes between current and published versions of the record",
|
|
1559
|
+
"urlPlaceholder": {
|
|
1560
|
+
"variableName": "itemId",
|
|
1561
|
+
"isEntityId": true,
|
|
1562
|
+
"relType": "ItemData"
|
|
1563
|
+
},
|
|
1564
|
+
"optionalRequestBody": false,
|
|
1565
|
+
"queryParamsRequired": false,
|
|
1566
|
+
"responseType": "ItemCurrentVsPublishedStateTargetSchema",
|
|
1567
|
+
"deprecated": "This API call is to be considered private and might change without notice",
|
|
1568
|
+
"name": "currentVsPublishedState",
|
|
1569
|
+
"rawName": "rawCurrentVsPublishedState"
|
|
1570
|
+
},
|
|
1476
1571
|
{
|
|
1477
1572
|
"returnsCollection": false,
|
|
1478
1573
|
"docUrl": "https://www.datocms.com/docs/content-management-api/resources/item/destroy",
|
|
@@ -1485,6 +1580,7 @@
|
|
|
1485
1580
|
"isEntityId": true,
|
|
1486
1581
|
"relType": "ItemData"
|
|
1487
1582
|
},
|
|
1583
|
+
"optionalRequestBody": false,
|
|
1488
1584
|
"queryParamsRequired": false,
|
|
1489
1585
|
"responseType": "ItemDestroyJobSchema",
|
|
1490
1586
|
"name": "destroy",
|
|
@@ -1497,6 +1593,7 @@
|
|
|
1497
1593
|
"urlTemplate": "/items",
|
|
1498
1594
|
"method": "DELETE",
|
|
1499
1595
|
"comment": "Delete multiple records",
|
|
1596
|
+
"optionalRequestBody": false,
|
|
1500
1597
|
"queryParamsType": "ItemBatchDestroyHrefSchema",
|
|
1501
1598
|
"queryParamsRequired": true,
|
|
1502
1599
|
"responseType": "ItemBatchDestroyJobSchema",
|
|
@@ -1511,6 +1608,7 @@
|
|
|
1511
1608
|
"urlTemplate": "/items/publish",
|
|
1512
1609
|
"method": "PUT",
|
|
1513
1610
|
"comment": "Publish multiple records",
|
|
1611
|
+
"optionalRequestBody": false,
|
|
1514
1612
|
"queryParamsType": "ItemBatchPublishHrefSchema",
|
|
1515
1613
|
"queryParamsRequired": true,
|
|
1516
1614
|
"responseType": "ItemBatchPublishJobSchema",
|
|
@@ -1525,6 +1623,7 @@
|
|
|
1525
1623
|
"urlTemplate": "/items/unpublish",
|
|
1526
1624
|
"method": "PUT",
|
|
1527
1625
|
"comment": "Unpublish multiple records",
|
|
1626
|
+
"optionalRequestBody": false,
|
|
1528
1627
|
"queryParamsType": "ItemBatchUnpublishHrefSchema",
|
|
1529
1628
|
"queryParamsRequired": true,
|
|
1530
1629
|
"responseType": "ItemBatchUnpublishJobSchema",
|
|
@@ -1544,6 +1643,16 @@
|
|
|
1544
1643
|
"isEntityId": true,
|
|
1545
1644
|
"relType": "ItemData"
|
|
1546
1645
|
},
|
|
1646
|
+
"requestBodyType": "ItemPublishSchema",
|
|
1647
|
+
"optionalRequestBody": true,
|
|
1648
|
+
"requestStructure": {
|
|
1649
|
+
"type": "selective_publish_operation",
|
|
1650
|
+
"attributes": [
|
|
1651
|
+
"content_in_locales",
|
|
1652
|
+
"non_localized_content"
|
|
1653
|
+
],
|
|
1654
|
+
"relationships": []
|
|
1655
|
+
},
|
|
1547
1656
|
"queryParamsType": "ItemPublishHrefSchema",
|
|
1548
1657
|
"queryParamsRequired": false,
|
|
1549
1658
|
"responseType": "ItemPublishTargetSchema",
|
|
@@ -1562,6 +1671,15 @@
|
|
|
1562
1671
|
"isEntityId": true,
|
|
1563
1672
|
"relType": "ItemData"
|
|
1564
1673
|
},
|
|
1674
|
+
"requestBodyType": "ItemUnpublishSchema",
|
|
1675
|
+
"optionalRequestBody": true,
|
|
1676
|
+
"requestStructure": {
|
|
1677
|
+
"type": "selective_unpublish_operation",
|
|
1678
|
+
"attributes": [
|
|
1679
|
+
"content_in_locales"
|
|
1680
|
+
],
|
|
1681
|
+
"relationships": []
|
|
1682
|
+
},
|
|
1565
1683
|
"queryParamsType": "ItemUnpublishHrefSchema",
|
|
1566
1684
|
"queryParamsRequired": false,
|
|
1567
1685
|
"responseType": "ItemUnpublishTargetSchema",
|
|
@@ -1576,6 +1694,7 @@
|
|
|
1576
1694
|
"method": "POST",
|
|
1577
1695
|
"comment": "Publish items in bulk",
|
|
1578
1696
|
"requestBodyType": "ItemBulkPublishSchema",
|
|
1697
|
+
"optionalRequestBody": false,
|
|
1579
1698
|
"requestStructure": {
|
|
1580
1699
|
"type": "item_bulk_publish_operation",
|
|
1581
1700
|
"attributes": [],
|
|
@@ -1596,6 +1715,7 @@
|
|
|
1596
1715
|
"method": "POST",
|
|
1597
1716
|
"comment": "Unpublish items in bulk",
|
|
1598
1717
|
"requestBodyType": "ItemBulkUnpublishSchema",
|
|
1718
|
+
"optionalRequestBody": false,
|
|
1599
1719
|
"requestStructure": {
|
|
1600
1720
|
"type": "item_bulk_unpublish_operation",
|
|
1601
1721
|
"attributes": [],
|
|
@@ -1616,6 +1736,7 @@
|
|
|
1616
1736
|
"method": "POST",
|
|
1617
1737
|
"comment": "Destroy items in bulk",
|
|
1618
1738
|
"requestBodyType": "ItemBulkDestroySchema",
|
|
1739
|
+
"optionalRequestBody": false,
|
|
1619
1740
|
"requestStructure": {
|
|
1620
1741
|
"type": "item_bulk_destroy_operation",
|
|
1621
1742
|
"attributes": [],
|
|
@@ -1636,6 +1757,7 @@
|
|
|
1636
1757
|
"method": "POST",
|
|
1637
1758
|
"comment": "Move items to stage in bulk",
|
|
1638
1759
|
"requestBodyType": "ItemBulkMoveToStageSchema",
|
|
1760
|
+
"optionalRequestBody": false,
|
|
1639
1761
|
"requestStructure": {
|
|
1640
1762
|
"type": "item_bulk_move_to_stage_operation",
|
|
1641
1763
|
"attributes": [
|
|
@@ -1669,6 +1791,7 @@
|
|
|
1669
1791
|
"isEntityId": true,
|
|
1670
1792
|
"relType": "ItemVersionData"
|
|
1671
1793
|
},
|
|
1794
|
+
"optionalRequestBody": false,
|
|
1672
1795
|
"queryParamsRequired": false,
|
|
1673
1796
|
"responseType": "ItemVersionRestoreJobSchema",
|
|
1674
1797
|
"name": "restore",
|
|
@@ -1686,6 +1809,7 @@
|
|
|
1686
1809
|
"isEntityId": false,
|
|
1687
1810
|
"relType": "ItemData"
|
|
1688
1811
|
},
|
|
1812
|
+
"optionalRequestBody": false,
|
|
1689
1813
|
"queryParamsType": "ItemVersionInstancesHrefSchema",
|
|
1690
1814
|
"queryParamsRequired": false,
|
|
1691
1815
|
"responseType": "ItemVersionInstancesTargetSchema",
|
|
@@ -1708,6 +1832,7 @@
|
|
|
1708
1832
|
"isEntityId": true,
|
|
1709
1833
|
"relType": "ItemVersionData"
|
|
1710
1834
|
},
|
|
1835
|
+
"optionalRequestBody": false,
|
|
1711
1836
|
"queryParamsRequired": false,
|
|
1712
1837
|
"responseType": "ItemVersionSelfTargetSchema",
|
|
1713
1838
|
"name": "find",
|
|
@@ -1728,6 +1853,7 @@
|
|
|
1728
1853
|
"method": "POST",
|
|
1729
1854
|
"comment": "Create a new upload",
|
|
1730
1855
|
"requestBodyType": "UploadCreateSchema",
|
|
1856
|
+
"optionalRequestBody": false,
|
|
1731
1857
|
"requestStructure": {
|
|
1732
1858
|
"type": "upload",
|
|
1733
1859
|
"attributes": [
|
|
@@ -1752,6 +1878,7 @@
|
|
|
1752
1878
|
"urlTemplate": "/uploads",
|
|
1753
1879
|
"method": "GET",
|
|
1754
1880
|
"comment": "List all uploads",
|
|
1881
|
+
"optionalRequestBody": false,
|
|
1755
1882
|
"queryParamsType": "UploadInstancesHrefSchema",
|
|
1756
1883
|
"queryParamsRequired": false,
|
|
1757
1884
|
"responseType": "UploadInstancesTargetSchema",
|
|
@@ -1774,6 +1901,7 @@
|
|
|
1774
1901
|
"isEntityId": true,
|
|
1775
1902
|
"relType": "UploadData"
|
|
1776
1903
|
},
|
|
1904
|
+
"optionalRequestBody": false,
|
|
1777
1905
|
"queryParamsRequired": false,
|
|
1778
1906
|
"responseType": "UploadSelfTargetSchema",
|
|
1779
1907
|
"name": "find",
|
|
@@ -1791,6 +1919,7 @@
|
|
|
1791
1919
|
"isEntityId": true,
|
|
1792
1920
|
"relType": "UploadData"
|
|
1793
1921
|
},
|
|
1922
|
+
"optionalRequestBody": false,
|
|
1794
1923
|
"queryParamsRequired": false,
|
|
1795
1924
|
"responseType": "UploadDestroyTargetSchema",
|
|
1796
1925
|
"name": "destroy",
|
|
@@ -1809,8 +1938,10 @@
|
|
|
1809
1938
|
"relType": "UploadData"
|
|
1810
1939
|
},
|
|
1811
1940
|
"requestBodyType": "UploadUpdateSchema",
|
|
1941
|
+
"optionalRequestBody": false,
|
|
1812
1942
|
"requestStructure": {
|
|
1813
1943
|
"type": "upload",
|
|
1944
|
+
"idRequired": true,
|
|
1814
1945
|
"attributes": [
|
|
1815
1946
|
"path",
|
|
1816
1947
|
"basename",
|
|
@@ -1837,6 +1968,7 @@
|
|
|
1837
1968
|
"method": "PUT",
|
|
1838
1969
|
"comment": "Batch add tags to uploads",
|
|
1839
1970
|
"requestBodyType": "UploadBatchAddTagsSchema",
|
|
1971
|
+
"optionalRequestBody": false,
|
|
1840
1972
|
"requestStructure": {
|
|
1841
1973
|
"type": "upload",
|
|
1842
1974
|
"attributes": [
|
|
@@ -1858,6 +1990,7 @@
|
|
|
1858
1990
|
"urlTemplate": "/uploads/batch-destroy",
|
|
1859
1991
|
"method": "DELETE",
|
|
1860
1992
|
"comment": "Delete multiple uploads",
|
|
1993
|
+
"optionalRequestBody": false,
|
|
1861
1994
|
"queryParamsType": "UploadBatchDestroyHrefSchema",
|
|
1862
1995
|
"queryParamsRequired": false,
|
|
1863
1996
|
"responseType": "UploadBatchDestroyJobSchema",
|
|
@@ -1877,6 +2010,7 @@
|
|
|
1877
2010
|
"isEntityId": true,
|
|
1878
2011
|
"relType": "UploadData"
|
|
1879
2012
|
},
|
|
2013
|
+
"optionalRequestBody": false,
|
|
1880
2014
|
"queryParamsType": "UploadReferencesHrefSchema",
|
|
1881
2015
|
"queryParamsRequired": false,
|
|
1882
2016
|
"responseType": "UploadReferencesTargetSchema",
|
|
@@ -1891,6 +2025,7 @@
|
|
|
1891
2025
|
"method": "POST",
|
|
1892
2026
|
"comment": "Add tags to assets in bulk",
|
|
1893
2027
|
"requestBodyType": "UploadBulkTagSchema",
|
|
2028
|
+
"optionalRequestBody": false,
|
|
1894
2029
|
"requestStructure": {
|
|
1895
2030
|
"type": "upload_bulk_tag_operation",
|
|
1896
2031
|
"attributes": [
|
|
@@ -1913,6 +2048,7 @@
|
|
|
1913
2048
|
"method": "POST",
|
|
1914
2049
|
"comment": "Destroy uploads",
|
|
1915
2050
|
"requestBodyType": "UploadBulkDestroySchema",
|
|
2051
|
+
"optionalRequestBody": false,
|
|
1916
2052
|
"requestStructure": {
|
|
1917
2053
|
"type": "upload_bulk_destroy_operation",
|
|
1918
2054
|
"attributes": [],
|
|
@@ -1940,6 +2076,7 @@
|
|
|
1940
2076
|
"method": "POST",
|
|
1941
2077
|
"comment": "Request a new upload",
|
|
1942
2078
|
"requestBodyType": "UploadRequestCreateSchema",
|
|
2079
|
+
"optionalRequestBody": false,
|
|
1943
2080
|
"requestStructure": {
|
|
1944
2081
|
"type": "upload_request",
|
|
1945
2082
|
"attributes": [
|
|
@@ -1972,10 +2109,12 @@
|
|
|
1972
2109
|
"relType": "ItemData"
|
|
1973
2110
|
},
|
|
1974
2111
|
"requestBodyType": "ScheduledPublicationCreateSchema",
|
|
2112
|
+
"optionalRequestBody": false,
|
|
1975
2113
|
"requestStructure": {
|
|
1976
2114
|
"type": "scheduled_publication",
|
|
1977
2115
|
"attributes": [
|
|
1978
|
-
"publication_scheduled_at"
|
|
2116
|
+
"publication_scheduled_at",
|
|
2117
|
+
"selective_publication"
|
|
1979
2118
|
],
|
|
1980
2119
|
"relationships": []
|
|
1981
2120
|
},
|
|
@@ -1996,6 +2135,7 @@
|
|
|
1996
2135
|
"isEntityId": false,
|
|
1997
2136
|
"relType": "ItemData"
|
|
1998
2137
|
},
|
|
2138
|
+
"optionalRequestBody": false,
|
|
1999
2139
|
"queryParamsRequired": false,
|
|
2000
2140
|
"responseType": "ScheduledPublicationDestroyTargetSchema",
|
|
2001
2141
|
"name": "destroy",
|
|
@@ -2021,10 +2161,12 @@
|
|
|
2021
2161
|
"relType": "ItemData"
|
|
2022
2162
|
},
|
|
2023
2163
|
"requestBodyType": "ScheduledUnpublishingCreateSchema",
|
|
2164
|
+
"optionalRequestBody": false,
|
|
2024
2165
|
"requestStructure": {
|
|
2025
2166
|
"type": "scheduled_unpublishing",
|
|
2026
2167
|
"attributes": [
|
|
2027
|
-
"unpublishing_scheduled_at"
|
|
2168
|
+
"unpublishing_scheduled_at",
|
|
2169
|
+
"content_in_locales"
|
|
2028
2170
|
],
|
|
2029
2171
|
"relationships": []
|
|
2030
2172
|
},
|
|
@@ -2045,6 +2187,7 @@
|
|
|
2045
2187
|
"isEntityId": false,
|
|
2046
2188
|
"relType": "ItemData"
|
|
2047
2189
|
},
|
|
2190
|
+
"optionalRequestBody": false,
|
|
2048
2191
|
"queryParamsRequired": false,
|
|
2049
2192
|
"responseType": "ScheduledUnpublishingDestroyTargetSchema",
|
|
2050
2193
|
"name": "destroy",
|
|
@@ -2064,6 +2207,7 @@
|
|
|
2064
2207
|
"urlTemplate": "/search-results",
|
|
2065
2208
|
"method": "GET",
|
|
2066
2209
|
"comment": "Search for results",
|
|
2210
|
+
"optionalRequestBody": false,
|
|
2067
2211
|
"queryParamsType": "SearchResultInstancesHrefSchema",
|
|
2068
2212
|
"queryParamsRequired": true,
|
|
2069
2213
|
"responseType": "SearchResultInstancesTargetSchema",
|
|
@@ -2094,8 +2238,10 @@
|
|
|
2094
2238
|
"relType": "EnvironmentData"
|
|
2095
2239
|
},
|
|
2096
2240
|
"requestBodyType": "EnvironmentForkSchema",
|
|
2241
|
+
"optionalRequestBody": false,
|
|
2097
2242
|
"requestStructure": {
|
|
2098
2243
|
"type": "environment",
|
|
2244
|
+
"idRequired": true,
|
|
2099
2245
|
"attributes": [],
|
|
2100
2246
|
"relationships": []
|
|
2101
2247
|
},
|
|
@@ -2117,6 +2263,7 @@
|
|
|
2117
2263
|
"isEntityId": true,
|
|
2118
2264
|
"relType": "EnvironmentData"
|
|
2119
2265
|
},
|
|
2266
|
+
"optionalRequestBody": false,
|
|
2120
2267
|
"queryParamsRequired": false,
|
|
2121
2268
|
"responseType": "EnvironmentPromoteTargetSchema",
|
|
2122
2269
|
"name": "promote",
|
|
@@ -2129,6 +2276,7 @@
|
|
|
2129
2276
|
"urlTemplate": "/environments",
|
|
2130
2277
|
"method": "GET",
|
|
2131
2278
|
"comment": "List all environments",
|
|
2279
|
+
"optionalRequestBody": false,
|
|
2132
2280
|
"queryParamsRequired": false,
|
|
2133
2281
|
"responseType": "EnvironmentInstancesTargetSchema",
|
|
2134
2282
|
"name": "list",
|
|
@@ -2146,6 +2294,7 @@
|
|
|
2146
2294
|
"isEntityId": true,
|
|
2147
2295
|
"relType": "EnvironmentData"
|
|
2148
2296
|
},
|
|
2297
|
+
"optionalRequestBody": false,
|
|
2149
2298
|
"queryParamsRequired": false,
|
|
2150
2299
|
"responseType": "EnvironmentSelfTargetSchema",
|
|
2151
2300
|
"name": "find",
|
|
@@ -2163,6 +2312,7 @@
|
|
|
2163
2312
|
"isEntityId": true,
|
|
2164
2313
|
"relType": "EnvironmentData"
|
|
2165
2314
|
},
|
|
2315
|
+
"optionalRequestBody": false,
|
|
2166
2316
|
"queryParamsRequired": false,
|
|
2167
2317
|
"responseType": "EnvironmentDestroyJobSchema",
|
|
2168
2318
|
"name": "destroy",
|
|
@@ -2182,6 +2332,7 @@
|
|
|
2182
2332
|
"urlTemplate": "/maintenance-mode",
|
|
2183
2333
|
"method": "GET",
|
|
2184
2334
|
"comment": "Retrieve maintenence mode",
|
|
2335
|
+
"optionalRequestBody": false,
|
|
2185
2336
|
"queryParamsRequired": false,
|
|
2186
2337
|
"responseType": "MaintenanceModeSelfTargetSchema",
|
|
2187
2338
|
"name": "find",
|
|
@@ -2194,6 +2345,7 @@
|
|
|
2194
2345
|
"urlTemplate": "/maintenance-mode/activate",
|
|
2195
2346
|
"method": "PUT",
|
|
2196
2347
|
"comment": "Activate maintenance mode: this means that the primary environment will be read-only",
|
|
2348
|
+
"optionalRequestBody": false,
|
|
2197
2349
|
"queryParamsType": "MaintenanceModeActivateHrefSchema",
|
|
2198
2350
|
"queryParamsRequired": false,
|
|
2199
2351
|
"responseType": "MaintenanceModeActivateTargetSchema",
|
|
@@ -2207,6 +2359,7 @@
|
|
|
2207
2359
|
"urlTemplate": "/maintenance-mode/deactivate",
|
|
2208
2360
|
"method": "PUT",
|
|
2209
2361
|
"comment": "De-activate maintenance mode",
|
|
2362
|
+
"optionalRequestBody": false,
|
|
2210
2363
|
"queryParamsRequired": false,
|
|
2211
2364
|
"responseType": "MaintenanceModeDeactivateTargetSchema",
|
|
2212
2365
|
"name": "deactivate",
|
|
@@ -2227,6 +2380,7 @@
|
|
|
2227
2380
|
"method": "POST",
|
|
2228
2381
|
"comment": "Create a new webhook",
|
|
2229
2382
|
"requestBodyType": "WebhookCreateSchema",
|
|
2383
|
+
"optionalRequestBody": false,
|
|
2230
2384
|
"requestStructure": {
|
|
2231
2385
|
"type": "webhook",
|
|
2232
2386
|
"attributes": [
|
|
@@ -2261,8 +2415,10 @@
|
|
|
2261
2415
|
"relType": "UserData"
|
|
2262
2416
|
},
|
|
2263
2417
|
"requestBodyType": "WebhookUpdateSchema",
|
|
2418
|
+
"optionalRequestBody": false,
|
|
2264
2419
|
"requestStructure": {
|
|
2265
2420
|
"type": "webhook",
|
|
2421
|
+
"idRequired": true,
|
|
2266
2422
|
"attributes": [
|
|
2267
2423
|
"name",
|
|
2268
2424
|
"url",
|
|
@@ -2289,6 +2445,7 @@
|
|
|
2289
2445
|
"urlTemplate": "/webhooks",
|
|
2290
2446
|
"method": "GET",
|
|
2291
2447
|
"comment": "List all webhooks",
|
|
2448
|
+
"optionalRequestBody": false,
|
|
2292
2449
|
"queryParamsRequired": false,
|
|
2293
2450
|
"responseType": "WebhookInstancesTargetSchema",
|
|
2294
2451
|
"name": "list",
|
|
@@ -2306,6 +2463,7 @@
|
|
|
2306
2463
|
"isEntityId": false,
|
|
2307
2464
|
"relType": "UserData"
|
|
2308
2465
|
},
|
|
2466
|
+
"optionalRequestBody": false,
|
|
2309
2467
|
"queryParamsRequired": false,
|
|
2310
2468
|
"responseType": "WebhookSelfTargetSchema",
|
|
2311
2469
|
"name": "find",
|
|
@@ -2323,6 +2481,7 @@
|
|
|
2323
2481
|
"isEntityId": false,
|
|
2324
2482
|
"relType": "UserData"
|
|
2325
2483
|
},
|
|
2484
|
+
"optionalRequestBody": false,
|
|
2326
2485
|
"queryParamsRequired": false,
|
|
2327
2486
|
"responseType": "WebhookDestroyTargetSchema",
|
|
2328
2487
|
"name": "destroy",
|
|
@@ -2342,6 +2501,7 @@
|
|
|
2342
2501
|
"urlTemplate": "/webhook_calls",
|
|
2343
2502
|
"method": "GET",
|
|
2344
2503
|
"comment": "List all webhooks calls",
|
|
2504
|
+
"optionalRequestBody": false,
|
|
2345
2505
|
"queryParamsType": "WebhookCallInstancesHrefSchema",
|
|
2346
2506
|
"queryParamsRequired": false,
|
|
2347
2507
|
"responseType": "WebhookCallInstancesTargetSchema",
|
|
@@ -2364,6 +2524,7 @@
|
|
|
2364
2524
|
"isEntityId": false,
|
|
2365
2525
|
"relType": "UserData"
|
|
2366
2526
|
},
|
|
2527
|
+
"optionalRequestBody": false,
|
|
2367
2528
|
"queryParamsRequired": false,
|
|
2368
2529
|
"name": "resendWebhook",
|
|
2369
2530
|
"rawName": "rawResendWebhook"
|
|
@@ -2382,6 +2543,7 @@
|
|
|
2382
2543
|
"urlTemplate": "/build-triggers",
|
|
2383
2544
|
"method": "GET",
|
|
2384
2545
|
"comment": "List all build triggers for a site",
|
|
2546
|
+
"optionalRequestBody": false,
|
|
2385
2547
|
"queryParamsRequired": false,
|
|
2386
2548
|
"responseType": "BuildTriggerInstancesTargetSchema",
|
|
2387
2549
|
"name": "list",
|
|
@@ -2399,6 +2561,7 @@
|
|
|
2399
2561
|
"isEntityId": true,
|
|
2400
2562
|
"relType": "BuildTriggerData"
|
|
2401
2563
|
},
|
|
2564
|
+
"optionalRequestBody": false,
|
|
2402
2565
|
"queryParamsRequired": false,
|
|
2403
2566
|
"responseType": "BuildTriggerSelfTargetSchema",
|
|
2404
2567
|
"name": "find",
|
|
@@ -2412,6 +2575,7 @@
|
|
|
2412
2575
|
"method": "POST",
|
|
2413
2576
|
"comment": "Create build trigger",
|
|
2414
2577
|
"requestBodyType": "BuildTriggerCreateSchema",
|
|
2578
|
+
"optionalRequestBody": false,
|
|
2415
2579
|
"requestStructure": {
|
|
2416
2580
|
"type": "build_trigger",
|
|
2417
2581
|
"attributes": [
|
|
@@ -2443,8 +2607,10 @@
|
|
|
2443
2607
|
"relType": "BuildTriggerData"
|
|
2444
2608
|
},
|
|
2445
2609
|
"requestBodyType": "BuildTriggerUpdateSchema",
|
|
2610
|
+
"optionalRequestBody": false,
|
|
2446
2611
|
"requestStructure": {
|
|
2447
2612
|
"type": "build_trigger",
|
|
2613
|
+
"idRequired": true,
|
|
2448
2614
|
"attributes": [
|
|
2449
2615
|
"name",
|
|
2450
2616
|
"adapter",
|
|
@@ -2472,6 +2638,7 @@
|
|
|
2472
2638
|
"isEntityId": true,
|
|
2473
2639
|
"relType": "BuildTriggerData"
|
|
2474
2640
|
},
|
|
2641
|
+
"optionalRequestBody": false,
|
|
2475
2642
|
"queryParamsRequired": false,
|
|
2476
2643
|
"name": "trigger",
|
|
2477
2644
|
"rawName": "rawTrigger"
|
|
@@ -2488,6 +2655,7 @@
|
|
|
2488
2655
|
"isEntityId": true,
|
|
2489
2656
|
"relType": "BuildTriggerData"
|
|
2490
2657
|
},
|
|
2658
|
+
"optionalRequestBody": false,
|
|
2491
2659
|
"queryParamsRequired": false,
|
|
2492
2660
|
"name": "abort",
|
|
2493
2661
|
"rawName": "rawAbort"
|
|
@@ -2504,6 +2672,7 @@
|
|
|
2504
2672
|
"isEntityId": true,
|
|
2505
2673
|
"relType": "BuildTriggerData"
|
|
2506
2674
|
},
|
|
2675
|
+
"optionalRequestBody": false,
|
|
2507
2676
|
"queryParamsRequired": false,
|
|
2508
2677
|
"name": "abortIndexing",
|
|
2509
2678
|
"rawName": "rawAbortIndexing"
|
|
@@ -2520,6 +2689,7 @@
|
|
|
2520
2689
|
"isEntityId": true,
|
|
2521
2690
|
"relType": "BuildTriggerData"
|
|
2522
2691
|
},
|
|
2692
|
+
"optionalRequestBody": false,
|
|
2523
2693
|
"queryParamsRequired": false,
|
|
2524
2694
|
"name": "reindex",
|
|
2525
2695
|
"rawName": "rawReindex"
|
|
@@ -2536,6 +2706,7 @@
|
|
|
2536
2706
|
"isEntityId": true,
|
|
2537
2707
|
"relType": "BuildTriggerData"
|
|
2538
2708
|
},
|
|
2709
|
+
"optionalRequestBody": false,
|
|
2539
2710
|
"queryParamsRequired": false,
|
|
2540
2711
|
"responseType": "BuildTriggerDestroyTargetSchema",
|
|
2541
2712
|
"name": "destroy",
|
|
@@ -2556,6 +2727,7 @@
|
|
|
2556
2727
|
"method": "POST",
|
|
2557
2728
|
"comment": "Create a new filter",
|
|
2558
2729
|
"requestBodyType": "ItemTypeFilterCreateSchema",
|
|
2730
|
+
"optionalRequestBody": false,
|
|
2559
2731
|
"requestStructure": {
|
|
2560
2732
|
"type": "item_type_filter",
|
|
2561
2733
|
"attributes": [
|
|
@@ -2587,8 +2759,10 @@
|
|
|
2587
2759
|
"relType": "ItemTypeFilterData"
|
|
2588
2760
|
},
|
|
2589
2761
|
"requestBodyType": "ItemTypeFilterUpdateSchema",
|
|
2762
|
+
"optionalRequestBody": false,
|
|
2590
2763
|
"requestStructure": {
|
|
2591
2764
|
"type": "item_type_filter",
|
|
2765
|
+
"idRequired": true,
|
|
2592
2766
|
"attributes": [
|
|
2593
2767
|
"name",
|
|
2594
2768
|
"columns",
|
|
@@ -2612,6 +2786,7 @@
|
|
|
2612
2786
|
"urlTemplate": "/item-type-filters",
|
|
2613
2787
|
"method": "GET",
|
|
2614
2788
|
"comment": "List all filters",
|
|
2789
|
+
"optionalRequestBody": false,
|
|
2615
2790
|
"queryParamsRequired": false,
|
|
2616
2791
|
"responseType": "ItemTypeFilterInstancesTargetSchema",
|
|
2617
2792
|
"name": "list",
|
|
@@ -2629,6 +2804,7 @@
|
|
|
2629
2804
|
"isEntityId": true,
|
|
2630
2805
|
"relType": "ItemTypeFilterData"
|
|
2631
2806
|
},
|
|
2807
|
+
"optionalRequestBody": false,
|
|
2632
2808
|
"queryParamsRequired": false,
|
|
2633
2809
|
"responseType": "ItemTypeFilterSelfTargetSchema",
|
|
2634
2810
|
"name": "find",
|
|
@@ -2646,6 +2822,7 @@
|
|
|
2646
2822
|
"isEntityId": true,
|
|
2647
2823
|
"relType": "ItemTypeFilterData"
|
|
2648
2824
|
},
|
|
2825
|
+
"optionalRequestBody": false,
|
|
2649
2826
|
"queryParamsRequired": false,
|
|
2650
2827
|
"responseType": "ItemTypeFilterDestroyTargetSchema",
|
|
2651
2828
|
"name": "destroy",
|
|
@@ -2666,6 +2843,7 @@
|
|
|
2666
2843
|
"method": "POST",
|
|
2667
2844
|
"comment": "Create a new filter",
|
|
2668
2845
|
"requestBodyType": "UploadFilterCreateSchema",
|
|
2846
|
+
"optionalRequestBody": false,
|
|
2669
2847
|
"requestStructure": {
|
|
2670
2848
|
"type": "upload_filter",
|
|
2671
2849
|
"attributes": [
|
|
@@ -2693,8 +2871,10 @@
|
|
|
2693
2871
|
"relType": "UploadFilterData"
|
|
2694
2872
|
},
|
|
2695
2873
|
"requestBodyType": "UploadFilterUpdateSchema",
|
|
2874
|
+
"optionalRequestBody": false,
|
|
2696
2875
|
"requestStructure": {
|
|
2697
2876
|
"type": "upload_filter",
|
|
2877
|
+
"idRequired": true,
|
|
2698
2878
|
"attributes": [
|
|
2699
2879
|
"name",
|
|
2700
2880
|
"shared",
|
|
@@ -2714,6 +2894,7 @@
|
|
|
2714
2894
|
"urlTemplate": "/upload-filters",
|
|
2715
2895
|
"method": "GET",
|
|
2716
2896
|
"comment": "List all filters",
|
|
2897
|
+
"optionalRequestBody": false,
|
|
2717
2898
|
"queryParamsRequired": false,
|
|
2718
2899
|
"responseType": "UploadFilterInstancesTargetSchema",
|
|
2719
2900
|
"name": "list",
|
|
@@ -2731,6 +2912,7 @@
|
|
|
2731
2912
|
"isEntityId": true,
|
|
2732
2913
|
"relType": "UploadFilterData"
|
|
2733
2914
|
},
|
|
2915
|
+
"optionalRequestBody": false,
|
|
2734
2916
|
"queryParamsRequired": false,
|
|
2735
2917
|
"responseType": "UploadFilterSelfTargetSchema",
|
|
2736
2918
|
"name": "find",
|
|
@@ -2748,6 +2930,7 @@
|
|
|
2748
2930
|
"isEntityId": true,
|
|
2749
2931
|
"relType": "UploadFilterData"
|
|
2750
2932
|
},
|
|
2933
|
+
"optionalRequestBody": false,
|
|
2751
2934
|
"queryParamsRequired": false,
|
|
2752
2935
|
"responseType": "UploadFilterDestroyTargetSchema",
|
|
2753
2936
|
"name": "destroy",
|
|
@@ -2768,6 +2951,7 @@
|
|
|
2768
2951
|
"method": "POST",
|
|
2769
2952
|
"comment": "Invite a new user",
|
|
2770
2953
|
"requestBodyType": "SiteInvitationCreateSchema",
|
|
2954
|
+
"optionalRequestBody": false,
|
|
2771
2955
|
"requestStructure": {
|
|
2772
2956
|
"type": "site_invitation",
|
|
2773
2957
|
"attributes": [
|
|
@@ -2795,8 +2979,10 @@
|
|
|
2795
2979
|
"relType": "SiteInvitationData"
|
|
2796
2980
|
},
|
|
2797
2981
|
"requestBodyType": "SiteInvitationUpdateSchema",
|
|
2982
|
+
"optionalRequestBody": false,
|
|
2798
2983
|
"requestStructure": {
|
|
2799
2984
|
"type": "site_invitation",
|
|
2985
|
+
"idRequired": true,
|
|
2800
2986
|
"attributes": [],
|
|
2801
2987
|
"relationships": [
|
|
2802
2988
|
"role"
|
|
@@ -2814,6 +3000,7 @@
|
|
|
2814
3000
|
"urlTemplate": "/site-invitations",
|
|
2815
3001
|
"method": "GET",
|
|
2816
3002
|
"comment": "List all invitations",
|
|
3003
|
+
"optionalRequestBody": false,
|
|
2817
3004
|
"queryParamsRequired": false,
|
|
2818
3005
|
"responseType": "SiteInvitationInstancesTargetSchema",
|
|
2819
3006
|
"name": "list",
|
|
@@ -2831,6 +3018,7 @@
|
|
|
2831
3018
|
"isEntityId": true,
|
|
2832
3019
|
"relType": "SiteInvitationData"
|
|
2833
3020
|
},
|
|
3021
|
+
"optionalRequestBody": false,
|
|
2834
3022
|
"queryParamsRequired": false,
|
|
2835
3023
|
"responseType": "SiteInvitationSelfTargetSchema",
|
|
2836
3024
|
"name": "find",
|
|
@@ -2848,6 +3036,7 @@
|
|
|
2848
3036
|
"isEntityId": true,
|
|
2849
3037
|
"relType": "SiteInvitationData"
|
|
2850
3038
|
},
|
|
3039
|
+
"optionalRequestBody": false,
|
|
2851
3040
|
"queryParamsRequired": false,
|
|
2852
3041
|
"responseType": "SiteInvitationDestroyTargetSchema",
|
|
2853
3042
|
"name": "destroy",
|
|
@@ -2865,6 +3054,7 @@
|
|
|
2865
3054
|
"isEntityId": true,
|
|
2866
3055
|
"relType": "SiteInvitationData"
|
|
2867
3056
|
},
|
|
3057
|
+
"optionalRequestBody": false,
|
|
2868
3058
|
"queryParamsRequired": false,
|
|
2869
3059
|
"name": "resend",
|
|
2870
3060
|
"rawName": "rawResend"
|
|
@@ -2883,6 +3073,7 @@
|
|
|
2883
3073
|
"urlTemplate": "/editing-sessions",
|
|
2884
3074
|
"method": "GET",
|
|
2885
3075
|
"comment": "List all editing sessions",
|
|
3076
|
+
"optionalRequestBody": false,
|
|
2886
3077
|
"queryParamsRequired": false,
|
|
2887
3078
|
"responseType": "EditingSessionInstancesTargetSchema",
|
|
2888
3079
|
"deprecated": "This API call is to be considered private and might change without notice",
|
|
@@ -2902,6 +3093,7 @@
|
|
|
2902
3093
|
"relType": "EditingSessionData"
|
|
2903
3094
|
},
|
|
2904
3095
|
"requestBodyType": "EditingSessionUpdateSchema",
|
|
3096
|
+
"optionalRequestBody": false,
|
|
2905
3097
|
"requestStructure": {
|
|
2906
3098
|
"type": "*",
|
|
2907
3099
|
"attributes": [],
|
|
@@ -2928,6 +3120,7 @@
|
|
|
2928
3120
|
"isEntityId": true,
|
|
2929
3121
|
"relType": "EditingSessionData"
|
|
2930
3122
|
},
|
|
3123
|
+
"optionalRequestBody": false,
|
|
2931
3124
|
"queryParamsRequired": false,
|
|
2932
3125
|
"responseType": "EditingSessionDestroyTargetSchema",
|
|
2933
3126
|
"deprecated": "This API call is to be considered private and might change without notice",
|
|
@@ -2948,6 +3141,7 @@
|
|
|
2948
3141
|
"urlTemplate": "/sso-groups",
|
|
2949
3142
|
"method": "GET",
|
|
2950
3143
|
"comment": "List all SSO groups",
|
|
3144
|
+
"optionalRequestBody": false,
|
|
2951
3145
|
"queryParamsRequired": false,
|
|
2952
3146
|
"responseType": "SsoGroupInstancesTargetSchema",
|
|
2953
3147
|
"name": "list",
|
|
@@ -2965,6 +3159,7 @@
|
|
|
2965
3159
|
"isEntityId": true,
|
|
2966
3160
|
"relType": "SsoGroupData"
|
|
2967
3161
|
},
|
|
3162
|
+
"optionalRequestBody": false,
|
|
2968
3163
|
"queryParamsRequired": false,
|
|
2969
3164
|
"responseType": "SsoGroupCopyRolesTargetSchema",
|
|
2970
3165
|
"name": "copyRoles",
|
|
@@ -2983,8 +3178,10 @@
|
|
|
2983
3178
|
"relType": "SsoGroupData"
|
|
2984
3179
|
},
|
|
2985
3180
|
"requestBodyType": "SsoGroupUpdateSchema",
|
|
3181
|
+
"optionalRequestBody": false,
|
|
2986
3182
|
"requestStructure": {
|
|
2987
3183
|
"type": "sso_group",
|
|
3184
|
+
"idRequired": true,
|
|
2988
3185
|
"attributes": [
|
|
2989
3186
|
"priority"
|
|
2990
3187
|
],
|
|
@@ -3009,6 +3206,7 @@
|
|
|
3009
3206
|
"isEntityId": true,
|
|
3010
3207
|
"relType": "SsoGroupData"
|
|
3011
3208
|
},
|
|
3209
|
+
"optionalRequestBody": false,
|
|
3012
3210
|
"queryParamsRequired": false,
|
|
3013
3211
|
"responseType": "SsoGroupDestroyTargetSchema",
|
|
3014
3212
|
"name": "destroy",
|
|
@@ -3028,6 +3226,7 @@
|
|
|
3028
3226
|
"urlTemplate": "/sso-settings",
|
|
3029
3227
|
"method": "GET",
|
|
3030
3228
|
"comment": "Retrieve SSO Settings",
|
|
3229
|
+
"optionalRequestBody": false,
|
|
3031
3230
|
"queryParamsRequired": false,
|
|
3032
3231
|
"responseType": "SsoSettingsSelfTargetSchema",
|
|
3033
3232
|
"name": "find",
|
|
@@ -3040,6 +3239,7 @@
|
|
|
3040
3239
|
"urlTemplate": "/sso-settings/generate-token",
|
|
3041
3240
|
"method": "PUT",
|
|
3042
3241
|
"comment": "Generate SSO token",
|
|
3242
|
+
"optionalRequestBody": false,
|
|
3043
3243
|
"queryParamsRequired": false,
|
|
3044
3244
|
"responseType": "SsoSettingsGenerateTokenTargetSchema",
|
|
3045
3245
|
"name": "generateToken",
|
|
@@ -3053,8 +3253,10 @@
|
|
|
3053
3253
|
"method": "PUT",
|
|
3054
3254
|
"comment": "Update SSO Settings",
|
|
3055
3255
|
"requestBodyType": "SsoSettingsUpdateSchema",
|
|
3256
|
+
"optionalRequestBody": false,
|
|
3056
3257
|
"requestStructure": {
|
|
3057
3258
|
"type": "sso_settings",
|
|
3259
|
+
"idRequired": true,
|
|
3058
3260
|
"attributes": [
|
|
3059
3261
|
"idp_saml_metadata_url",
|
|
3060
3262
|
"idp_saml_metadata_xml"
|
|
@@ -3082,6 +3284,7 @@
|
|
|
3082
3284
|
"urlTemplate": "/white-label-settings",
|
|
3083
3285
|
"method": "GET",
|
|
3084
3286
|
"comment": "Retrieve white-label settings",
|
|
3287
|
+
"optionalRequestBody": false,
|
|
3085
3288
|
"queryParamsRequired": false,
|
|
3086
3289
|
"responseType": "WhiteLabelSettingsSelfTargetSchema",
|
|
3087
3290
|
"name": "find",
|
|
@@ -3095,8 +3298,10 @@
|
|
|
3095
3298
|
"method": "PUT",
|
|
3096
3299
|
"comment": "Update white-label settings",
|
|
3097
3300
|
"requestBodyType": "WhiteLabelSettingsUpdateSchema",
|
|
3301
|
+
"optionalRequestBody": false,
|
|
3098
3302
|
"requestStructure": {
|
|
3099
3303
|
"type": "white_label_settings",
|
|
3304
|
+
"idRequired": true,
|
|
3100
3305
|
"attributes": [
|
|
3101
3306
|
"custom_i18n_messages_template_url"
|
|
3102
3307
|
],
|
|
@@ -3121,6 +3326,7 @@
|
|
|
3121
3326
|
"urlTemplate": "/public-info",
|
|
3122
3327
|
"method": "GET",
|
|
3123
3328
|
"comment": "Retrieve public site info",
|
|
3329
|
+
"optionalRequestBody": false,
|
|
3124
3330
|
"queryParamsRequired": false,
|
|
3125
3331
|
"responseType": "PublicInfoSelfTargetSchema",
|
|
3126
3332
|
"name": "find",
|
|
@@ -3140,6 +3346,7 @@
|
|
|
3140
3346
|
"urlTemplate": "/daily-site-usages",
|
|
3141
3347
|
"method": "GET",
|
|
3142
3348
|
"comment": "Retrieve project's daily usage info",
|
|
3349
|
+
"optionalRequestBody": false,
|
|
3143
3350
|
"queryParamsRequired": false,
|
|
3144
3351
|
"responseType": "DailyUsageInstancesTargetSchema",
|
|
3145
3352
|
"name": "list",
|
|
@@ -3164,6 +3371,7 @@
|
|
|
3164
3371
|
"isEntityId": true,
|
|
3165
3372
|
"relType": "UsageCounterData"
|
|
3166
3373
|
},
|
|
3374
|
+
"optionalRequestBody": false,
|
|
3167
3375
|
"queryParamsType": "UsageCounterSelfHrefSchema",
|
|
3168
3376
|
"queryParamsRequired": false,
|
|
3169
3377
|
"responseType": "UsageCounterSelfTargetSchema",
|
|
@@ -3184,6 +3392,7 @@
|
|
|
3184
3392
|
"urlTemplate": "/upload-tags",
|
|
3185
3393
|
"method": "GET",
|
|
3186
3394
|
"comment": "List all manually created upload tags",
|
|
3395
|
+
"optionalRequestBody": false,
|
|
3187
3396
|
"queryParamsType": "UploadTagInstancesHrefSchema",
|
|
3188
3397
|
"queryParamsRequired": false,
|
|
3189
3398
|
"responseType": "UploadTagInstancesTargetSchema",
|
|
@@ -3202,6 +3411,7 @@
|
|
|
3202
3411
|
"method": "POST",
|
|
3203
3412
|
"comment": "Create a new upload tag",
|
|
3204
3413
|
"requestBodyType": "UploadTagCreateSchema",
|
|
3414
|
+
"optionalRequestBody": false,
|
|
3205
3415
|
"requestStructure": {
|
|
3206
3416
|
"type": "upload_tag",
|
|
3207
3417
|
"attributes": [
|
|
@@ -3228,6 +3438,7 @@
|
|
|
3228
3438
|
"urlTemplate": "/upload-smart-tags",
|
|
3229
3439
|
"method": "GET",
|
|
3230
3440
|
"comment": "List all automatically created upload tags",
|
|
3441
|
+
"optionalRequestBody": false,
|
|
3231
3442
|
"queryParamsType": "UploadSmartTagInstancesHrefSchema",
|
|
3232
3443
|
"queryParamsRequired": false,
|
|
3233
3444
|
"responseType": "UploadSmartTagInstancesTargetSchema",
|
|
@@ -3252,6 +3463,7 @@
|
|
|
3252
3463
|
"urlTemplate": "/site",
|
|
3253
3464
|
"method": "GET",
|
|
3254
3465
|
"comment": "Retrieve the site",
|
|
3466
|
+
"optionalRequestBody": false,
|
|
3255
3467
|
"queryParamsType": "SiteSelfHrefSchema",
|
|
3256
3468
|
"queryParamsRequired": false,
|
|
3257
3469
|
"responseType": "SiteSelfTargetSchema",
|
|
@@ -3266,8 +3478,10 @@
|
|
|
3266
3478
|
"method": "PUT",
|
|
3267
3479
|
"comment": "Update the site's settings",
|
|
3268
3480
|
"requestBodyType": "SiteUpdateSchema",
|
|
3481
|
+
"optionalRequestBody": false,
|
|
3269
3482
|
"requestStructure": {
|
|
3270
3483
|
"type": "site",
|
|
3484
|
+
"idRequired": true,
|
|
3271
3485
|
"attributes": [
|
|
3272
3486
|
"no_index",
|
|
3273
3487
|
"favicon",
|
|
@@ -3295,6 +3509,7 @@
|
|
|
3295
3509
|
"urlTemplate": "/site/activate-improved-timezone-management",
|
|
3296
3510
|
"method": "PUT",
|
|
3297
3511
|
"comment": "Activate improved timezone management",
|
|
3512
|
+
"optionalRequestBody": false,
|
|
3298
3513
|
"queryParamsRequired": false,
|
|
3299
3514
|
"responseType": "SiteActivateImprovedTimezoneManagementJobSchema",
|
|
3300
3515
|
"deprecated": "This API call is to be considered private and might change without notice",
|
|
@@ -3308,6 +3523,7 @@
|
|
|
3308
3523
|
"urlTemplate": "/site/activate-improved-hex-management",
|
|
3309
3524
|
"method": "PUT",
|
|
3310
3525
|
"comment": "Activate improved hex management",
|
|
3526
|
+
"optionalRequestBody": false,
|
|
3311
3527
|
"queryParamsRequired": false,
|
|
3312
3528
|
"responseType": "SiteActivateImprovedHexManagementTargetSchema",
|
|
3313
3529
|
"deprecated": "This API call is to be considered private and might change without notice",
|
|
@@ -3321,6 +3537,7 @@
|
|
|
3321
3537
|
"urlTemplate": "/site/activate-improved-gql-multilocale-fields",
|
|
3322
3538
|
"method": "PUT",
|
|
3323
3539
|
"comment": "Activate improved GraphQL multi-locale fields option",
|
|
3540
|
+
"optionalRequestBody": false,
|
|
3324
3541
|
"queryParamsRequired": false,
|
|
3325
3542
|
"responseType": "SiteActivateImprovedGqlMultilocaleFieldsTargetSchema",
|
|
3326
3543
|
"deprecated": "This API call is to be considered private and might change without notice",
|
|
@@ -3342,6 +3559,7 @@
|
|
|
3342
3559
|
"method": "POST",
|
|
3343
3560
|
"comment": "Create a new workflow",
|
|
3344
3561
|
"requestBodyType": "WorkflowCreateSchema",
|
|
3562
|
+
"optionalRequestBody": false,
|
|
3345
3563
|
"requestStructure": {
|
|
3346
3564
|
"type": "workflow",
|
|
3347
3565
|
"attributes": [
|
|
@@ -3369,8 +3587,10 @@
|
|
|
3369
3587
|
"relType": "WorkflowData"
|
|
3370
3588
|
},
|
|
3371
3589
|
"requestBodyType": "WorkflowUpdateSchema",
|
|
3590
|
+
"optionalRequestBody": false,
|
|
3372
3591
|
"requestStructure": {
|
|
3373
3592
|
"type": "workflow",
|
|
3593
|
+
"idRequired": true,
|
|
3374
3594
|
"attributes": [
|
|
3375
3595
|
"name",
|
|
3376
3596
|
"api_key",
|
|
@@ -3390,6 +3610,7 @@
|
|
|
3390
3610
|
"urlTemplate": "/workflows",
|
|
3391
3611
|
"method": "GET",
|
|
3392
3612
|
"comment": "List all workflows",
|
|
3613
|
+
"optionalRequestBody": false,
|
|
3393
3614
|
"queryParamsRequired": false,
|
|
3394
3615
|
"responseType": "WorkflowInstancesTargetSchema",
|
|
3395
3616
|
"name": "list",
|
|
@@ -3407,6 +3628,7 @@
|
|
|
3407
3628
|
"isEntityId": true,
|
|
3408
3629
|
"relType": "WorkflowData"
|
|
3409
3630
|
},
|
|
3631
|
+
"optionalRequestBody": false,
|
|
3410
3632
|
"queryParamsRequired": false,
|
|
3411
3633
|
"responseType": "WorkflowSelfTargetSchema",
|
|
3412
3634
|
"name": "find",
|
|
@@ -3424,6 +3646,7 @@
|
|
|
3424
3646
|
"isEntityId": true,
|
|
3425
3647
|
"relType": "WorkflowData"
|
|
3426
3648
|
},
|
|
3649
|
+
"optionalRequestBody": false,
|
|
3427
3650
|
"queryParamsRequired": false,
|
|
3428
3651
|
"name": "destroy",
|
|
3429
3652
|
"rawName": "rawDestroy"
|