@datocms/cma-client 0.1.4 → 0.1.8
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/BuildTrigger.js +40 -2
- package/dist/cjs/generated/resources/BuildTrigger.js.map +1 -1
- package/dist/cjs/generated/resources/Site.js +21 -0
- package/dist/cjs/generated/resources/Site.js.map +1 -1
- package/dist/esm/generated/Client.d.ts +1 -0
- package/dist/esm/generated/Client.js +1 -1
- package/dist/esm/generated/Client.js.map +1 -1
- package/dist/esm/generated/SchemaTypes.d.ts +37 -0
- package/dist/esm/generated/SimpleSchemaTypes.d.ts +28 -0
- package/dist/esm/generated/resources/BuildTrigger.d.ts +26 -2
- package/dist/esm/generated/resources/BuildTrigger.js +40 -2
- package/dist/esm/generated/resources/BuildTrigger.js.map +1 -1
- package/dist/esm/generated/resources/Site.d.ts +12 -0
- package/dist/esm/generated/resources/Site.js +21 -0
- package/dist/esm/generated/resources/Site.js.map +1 -1
- package/dist/types/generated/Client.d.ts +1 -0
- package/dist/types/generated/SchemaTypes.d.ts +37 -0
- package/dist/types/generated/SimpleSchemaTypes.d.ts +28 -0
- package/dist/types/generated/resources/BuildTrigger.d.ts +26 -2
- package/dist/types/generated/resources/Site.d.ts +12 -0
- package/package.json +6 -5
- package/resources.json +1272 -0
- package/src/generated/Client.ts +2 -0
- package/src/generated/SchemaTypes.ts +40 -0
- package/src/generated/SimpleSchemaTypes.ts +29 -0
- package/src/generated/resources/BuildTrigger.ts +44 -2
- package/src/generated/resources/Site.ts +27 -0
- package/dist/cjs/generated/schemaInfo.js +0 -3063
- package/dist/cjs/generated/schemaInfo.js.map +0 -1
- package/dist/esm/generated/schemaInfo.d.ts +0 -940
- package/dist/esm/generated/schemaInfo.js +0 -3061
- package/dist/esm/generated/schemaInfo.js.map +0 -1
- package/dist/types/generated/schemaInfo.d.ts +0 -940
- package/src/generated/schemaInfo.ts +0 -3231
|
@@ -1,3231 +0,0 @@
|
|
|
1
|
-
export default {
|
|
2
|
-
baseUrl: 'https://site-api.datocms.com',
|
|
3
|
-
resources: [
|
|
4
|
-
{
|
|
5
|
-
jsonApiType: 'role',
|
|
6
|
-
endpoints: [
|
|
7
|
-
{
|
|
8
|
-
returnsCollection: false,
|
|
9
|
-
docUrl:
|
|
10
|
-
'https://www.datocms.com/docs/content-management-api/resources/role/create',
|
|
11
|
-
name: 'create',
|
|
12
|
-
rawName: 'rawCreate',
|
|
13
|
-
urlTemplate: '/roles',
|
|
14
|
-
method: 'POST',
|
|
15
|
-
comment: 'Create a new role',
|
|
16
|
-
requestBodyType: 'RoleCreateSchema',
|
|
17
|
-
simpleMethodAvailable: true,
|
|
18
|
-
requestStructure: {
|
|
19
|
-
type: 'role',
|
|
20
|
-
attributes: [
|
|
21
|
-
'name',
|
|
22
|
-
'can_edit_favicon',
|
|
23
|
-
'can_edit_site',
|
|
24
|
-
'can_edit_schema',
|
|
25
|
-
'can_manage_menu',
|
|
26
|
-
'can_edit_environment',
|
|
27
|
-
'can_promote_environments',
|
|
28
|
-
'environments_access',
|
|
29
|
-
'can_manage_users',
|
|
30
|
-
'can_manage_shared_filters',
|
|
31
|
-
'can_manage_build_triggers',
|
|
32
|
-
'can_manage_webhooks',
|
|
33
|
-
'can_manage_environments',
|
|
34
|
-
'can_manage_sso',
|
|
35
|
-
'can_access_audit_log',
|
|
36
|
-
'can_manage_workflows',
|
|
37
|
-
'can_manage_access_tokens',
|
|
38
|
-
'can_perform_site_search',
|
|
39
|
-
'can_access_build_events_log',
|
|
40
|
-
'positive_item_type_permissions',
|
|
41
|
-
'negative_item_type_permissions',
|
|
42
|
-
'positive_upload_permissions',
|
|
43
|
-
'negative_upload_permissions',
|
|
44
|
-
'positive_build_trigger_permissions',
|
|
45
|
-
'negative_build_trigger_permissions',
|
|
46
|
-
],
|
|
47
|
-
relationships: ['inherits_permissions_from'],
|
|
48
|
-
},
|
|
49
|
-
responseType: 'RoleCreateTargetSchema',
|
|
50
|
-
},
|
|
51
|
-
{
|
|
52
|
-
returnsCollection: false,
|
|
53
|
-
docUrl:
|
|
54
|
-
'https://www.datocms.com/docs/content-management-api/resources/role/update',
|
|
55
|
-
name: 'update',
|
|
56
|
-
rawName: 'rawUpdate',
|
|
57
|
-
urlTemplate: '/roles/${roleId}',
|
|
58
|
-
method: 'PUT',
|
|
59
|
-
comment: 'Update a role',
|
|
60
|
-
urlPlaceholder: {
|
|
61
|
-
variableName: 'roleId',
|
|
62
|
-
isEntityId: true,
|
|
63
|
-
relType: 'RoleData',
|
|
64
|
-
},
|
|
65
|
-
requestBodyType: 'RoleUpdateSchema',
|
|
66
|
-
simpleMethodAvailable: true,
|
|
67
|
-
requestStructure: {
|
|
68
|
-
type: 'role',
|
|
69
|
-
attributes: [
|
|
70
|
-
'name',
|
|
71
|
-
'can_edit_favicon',
|
|
72
|
-
'can_edit_site',
|
|
73
|
-
'can_edit_schema',
|
|
74
|
-
'can_manage_menu',
|
|
75
|
-
'can_edit_environment',
|
|
76
|
-
'can_promote_environments',
|
|
77
|
-
'environments_access',
|
|
78
|
-
'can_manage_users',
|
|
79
|
-
'can_manage_shared_filters',
|
|
80
|
-
'can_manage_build_triggers',
|
|
81
|
-
'can_manage_webhooks',
|
|
82
|
-
'can_manage_environments',
|
|
83
|
-
'can_manage_sso',
|
|
84
|
-
'can_access_audit_log',
|
|
85
|
-
'can_manage_workflows',
|
|
86
|
-
'can_manage_access_tokens',
|
|
87
|
-
'can_perform_site_search',
|
|
88
|
-
'can_access_build_events_log',
|
|
89
|
-
'positive_item_type_permissions',
|
|
90
|
-
'negative_item_type_permissions',
|
|
91
|
-
'positive_upload_permissions',
|
|
92
|
-
'negative_upload_permissions',
|
|
93
|
-
'positive_build_trigger_permissions',
|
|
94
|
-
'negative_build_trigger_permissions',
|
|
95
|
-
],
|
|
96
|
-
relationships: ['inherits_permissions_from'],
|
|
97
|
-
},
|
|
98
|
-
responseType: 'RoleUpdateTargetSchema',
|
|
99
|
-
},
|
|
100
|
-
{
|
|
101
|
-
returnsCollection: true,
|
|
102
|
-
docUrl:
|
|
103
|
-
'https://www.datocms.com/docs/content-management-api/resources/role/instances',
|
|
104
|
-
name: 'list',
|
|
105
|
-
rawName: 'rawList',
|
|
106
|
-
urlTemplate: '/roles',
|
|
107
|
-
method: 'GET',
|
|
108
|
-
comment: 'List all roles',
|
|
109
|
-
simpleMethodAvailable: true,
|
|
110
|
-
responseType: 'RoleInstancesTargetSchema',
|
|
111
|
-
},
|
|
112
|
-
{
|
|
113
|
-
returnsCollection: false,
|
|
114
|
-
docUrl:
|
|
115
|
-
'https://www.datocms.com/docs/content-management-api/resources/role/self',
|
|
116
|
-
name: 'find',
|
|
117
|
-
rawName: 'rawFind',
|
|
118
|
-
urlTemplate: '/roles/${roleId}',
|
|
119
|
-
method: 'GET',
|
|
120
|
-
comment: 'Retrieve a role',
|
|
121
|
-
urlPlaceholder: {
|
|
122
|
-
variableName: 'roleId',
|
|
123
|
-
isEntityId: true,
|
|
124
|
-
relType: 'RoleData',
|
|
125
|
-
},
|
|
126
|
-
simpleMethodAvailable: true,
|
|
127
|
-
responseType: 'RoleSelfTargetSchema',
|
|
128
|
-
},
|
|
129
|
-
{
|
|
130
|
-
returnsCollection: false,
|
|
131
|
-
docUrl:
|
|
132
|
-
'https://www.datocms.com/docs/content-management-api/resources/role/destroy',
|
|
133
|
-
name: 'destroy',
|
|
134
|
-
rawName: 'rawDestroy',
|
|
135
|
-
urlTemplate: '/roles/${roleId}',
|
|
136
|
-
method: 'DELETE',
|
|
137
|
-
comment: 'Delete a role',
|
|
138
|
-
urlPlaceholder: {
|
|
139
|
-
variableName: 'roleId',
|
|
140
|
-
isEntityId: true,
|
|
141
|
-
relType: 'RoleData',
|
|
142
|
-
},
|
|
143
|
-
simpleMethodAvailable: true,
|
|
144
|
-
responseType: 'RoleDestroyTargetSchema',
|
|
145
|
-
},
|
|
146
|
-
],
|
|
147
|
-
namespace: 'roles',
|
|
148
|
-
resourceClassName: 'Role',
|
|
149
|
-
},
|
|
150
|
-
{
|
|
151
|
-
jsonApiType: 'user',
|
|
152
|
-
endpoints: [
|
|
153
|
-
{
|
|
154
|
-
returnsCollection: false,
|
|
155
|
-
docUrl:
|
|
156
|
-
'https://www.datocms.com/docs/content-management-api/resources/user/update',
|
|
157
|
-
name: 'update',
|
|
158
|
-
rawName: 'rawUpdate',
|
|
159
|
-
urlTemplate: '/users/${userId}',
|
|
160
|
-
method: 'PUT',
|
|
161
|
-
comment: 'Update a collaborator',
|
|
162
|
-
urlPlaceholder: {
|
|
163
|
-
variableName: 'userId',
|
|
164
|
-
isEntityId: true,
|
|
165
|
-
relType: 'UserData',
|
|
166
|
-
},
|
|
167
|
-
requestBodyType: 'UserUpdateSchema',
|
|
168
|
-
simpleMethodAvailable: true,
|
|
169
|
-
requestStructure: {
|
|
170
|
-
type: 'user',
|
|
171
|
-
attributes: ['is_active'],
|
|
172
|
-
relationships: ['role'],
|
|
173
|
-
},
|
|
174
|
-
responseType: 'UserUpdateTargetSchema',
|
|
175
|
-
},
|
|
176
|
-
{
|
|
177
|
-
returnsCollection: true,
|
|
178
|
-
docUrl:
|
|
179
|
-
'https://www.datocms.com/docs/content-management-api/resources/user/instances',
|
|
180
|
-
name: 'list',
|
|
181
|
-
rawName: 'rawList',
|
|
182
|
-
urlTemplate: '/users',
|
|
183
|
-
method: 'GET',
|
|
184
|
-
comment: 'List all collaborators',
|
|
185
|
-
simpleMethodAvailable: true,
|
|
186
|
-
responseType: 'UserInstancesTargetSchema',
|
|
187
|
-
},
|
|
188
|
-
{
|
|
189
|
-
returnsCollection: false,
|
|
190
|
-
docUrl:
|
|
191
|
-
'https://www.datocms.com/docs/content-management-api/resources/user/self',
|
|
192
|
-
name: 'find',
|
|
193
|
-
rawName: 'rawFind',
|
|
194
|
-
urlTemplate: '/users/${userId}',
|
|
195
|
-
method: 'GET',
|
|
196
|
-
comment: 'Retrieve a collaborator',
|
|
197
|
-
urlPlaceholder: {
|
|
198
|
-
variableName: 'userId',
|
|
199
|
-
isEntityId: true,
|
|
200
|
-
relType: 'UserData',
|
|
201
|
-
},
|
|
202
|
-
simpleMethodAvailable: true,
|
|
203
|
-
responseType: 'UserSelfTargetSchema',
|
|
204
|
-
},
|
|
205
|
-
{
|
|
206
|
-
returnsCollection: false,
|
|
207
|
-
docUrl:
|
|
208
|
-
'https://www.datocms.com/docs/content-management-api/resources/user/destroy',
|
|
209
|
-
name: 'destroy',
|
|
210
|
-
rawName: 'rawDestroy',
|
|
211
|
-
urlTemplate: '/users/${userId}',
|
|
212
|
-
method: 'DELETE',
|
|
213
|
-
comment: 'Delete a collaborator',
|
|
214
|
-
urlPlaceholder: {
|
|
215
|
-
variableName: 'userId',
|
|
216
|
-
isEntityId: true,
|
|
217
|
-
relType: 'UserData',
|
|
218
|
-
},
|
|
219
|
-
simpleMethodAvailable: true,
|
|
220
|
-
queryParamsType: 'UserDestroyHrefSchema',
|
|
221
|
-
responseType: 'UserDestroyTargetSchema',
|
|
222
|
-
},
|
|
223
|
-
],
|
|
224
|
-
namespace: 'users',
|
|
225
|
-
resourceClassName: 'User',
|
|
226
|
-
},
|
|
227
|
-
{
|
|
228
|
-
jsonApiType: 'sso_user',
|
|
229
|
-
endpoints: [
|
|
230
|
-
{
|
|
231
|
-
returnsCollection: true,
|
|
232
|
-
docUrl:
|
|
233
|
-
'https://www.datocms.com/docs/content-management-api/resources/sso-user/instances',
|
|
234
|
-
name: 'list',
|
|
235
|
-
rawName: 'rawList',
|
|
236
|
-
urlTemplate: '/sso-users',
|
|
237
|
-
method: 'GET',
|
|
238
|
-
comment: 'List all users',
|
|
239
|
-
simpleMethodAvailable: true,
|
|
240
|
-
responseType: 'SsoUserInstancesTargetSchema',
|
|
241
|
-
},
|
|
242
|
-
{
|
|
243
|
-
returnsCollection: false,
|
|
244
|
-
docUrl:
|
|
245
|
-
'https://www.datocms.com/docs/content-management-api/resources/sso-user/self',
|
|
246
|
-
name: 'find',
|
|
247
|
-
rawName: 'rawFind',
|
|
248
|
-
urlTemplate: '/sso-users/${userId}',
|
|
249
|
-
method: 'GET',
|
|
250
|
-
comment: 'Returns a SSO user',
|
|
251
|
-
urlPlaceholder: {
|
|
252
|
-
variableName: 'userId',
|
|
253
|
-
isEntityId: false,
|
|
254
|
-
relType: 'UserData',
|
|
255
|
-
},
|
|
256
|
-
simpleMethodAvailable: true,
|
|
257
|
-
responseType: 'SsoUserSelfTargetSchema',
|
|
258
|
-
},
|
|
259
|
-
{
|
|
260
|
-
returnsCollection: false,
|
|
261
|
-
docUrl:
|
|
262
|
-
'https://www.datocms.com/docs/content-management-api/resources/sso-user/copy_users',
|
|
263
|
-
name: 'copyUsers',
|
|
264
|
-
rawName: 'rawCopyUsers',
|
|
265
|
-
urlTemplate: '/sso-users/copy-users',
|
|
266
|
-
method: 'POST',
|
|
267
|
-
comment: 'Copy editors as SSO users',
|
|
268
|
-
simpleMethodAvailable: true,
|
|
269
|
-
responseType: 'SsoUserCopyUsersTargetSchema',
|
|
270
|
-
},
|
|
271
|
-
{
|
|
272
|
-
returnsCollection: false,
|
|
273
|
-
docUrl:
|
|
274
|
-
'https://www.datocms.com/docs/content-management-api/resources/sso-user/destroy',
|
|
275
|
-
name: 'destroy',
|
|
276
|
-
rawName: 'rawDestroy',
|
|
277
|
-
urlTemplate: '/sso-users/${userId}',
|
|
278
|
-
method: 'DELETE',
|
|
279
|
-
comment: 'Delete a SSO user',
|
|
280
|
-
urlPlaceholder: {
|
|
281
|
-
variableName: 'userId',
|
|
282
|
-
isEntityId: false,
|
|
283
|
-
relType: 'UserData',
|
|
284
|
-
},
|
|
285
|
-
simpleMethodAvailable: true,
|
|
286
|
-
queryParamsType: 'SsoUserDestroyHrefSchema',
|
|
287
|
-
responseType: 'SsoUserDestroyTargetSchema',
|
|
288
|
-
},
|
|
289
|
-
],
|
|
290
|
-
namespace: 'ssoUsers',
|
|
291
|
-
resourceClassName: 'SsoUser',
|
|
292
|
-
},
|
|
293
|
-
{
|
|
294
|
-
jsonApiType: 'audit_log_event',
|
|
295
|
-
endpoints: [
|
|
296
|
-
{
|
|
297
|
-
returnsCollection: true,
|
|
298
|
-
docUrl:
|
|
299
|
-
'https://www.datocms.com/docs/content-management-api/resources/audit-log_event/query',
|
|
300
|
-
name: 'query',
|
|
301
|
-
rawName: 'rawQuery',
|
|
302
|
-
urlTemplate: '/audit-log-events/query',
|
|
303
|
-
method: 'POST',
|
|
304
|
-
comment: 'List Audit Log events',
|
|
305
|
-
requestBodyType: 'AuditLogEventQuerySchema',
|
|
306
|
-
simpleMethodAvailable: true,
|
|
307
|
-
requestStructure: {
|
|
308
|
-
type: 'audit_log_query',
|
|
309
|
-
attributes: ['filter', 'next_token', 'detailed_log'],
|
|
310
|
-
relationships: [],
|
|
311
|
-
},
|
|
312
|
-
responseType: 'AuditLogEventQueryTargetSchema',
|
|
313
|
-
},
|
|
314
|
-
],
|
|
315
|
-
namespace: 'auditLogEvents',
|
|
316
|
-
resourceClassName: 'AuditLogEvent',
|
|
317
|
-
},
|
|
318
|
-
{
|
|
319
|
-
jsonApiType: 'menu_item',
|
|
320
|
-
endpoints: [
|
|
321
|
-
{
|
|
322
|
-
returnsCollection: false,
|
|
323
|
-
docUrl:
|
|
324
|
-
'https://www.datocms.com/docs/content-management-api/resources/menu-item/create',
|
|
325
|
-
name: 'create',
|
|
326
|
-
rawName: 'rawCreate',
|
|
327
|
-
urlTemplate: '/menu-items',
|
|
328
|
-
method: 'POST',
|
|
329
|
-
comment: 'Create a new menu item',
|
|
330
|
-
requestBodyType: 'MenuItemCreateSchema',
|
|
331
|
-
simpleMethodAvailable: true,
|
|
332
|
-
requestStructure: {
|
|
333
|
-
type: 'menu_item',
|
|
334
|
-
attributes: [
|
|
335
|
-
'label',
|
|
336
|
-
'external_url',
|
|
337
|
-
'position',
|
|
338
|
-
'open_in_new_tab',
|
|
339
|
-
],
|
|
340
|
-
relationships: ['item_type', 'parent'],
|
|
341
|
-
},
|
|
342
|
-
responseType: 'MenuItemCreateTargetSchema',
|
|
343
|
-
},
|
|
344
|
-
{
|
|
345
|
-
returnsCollection: false,
|
|
346
|
-
docUrl:
|
|
347
|
-
'https://www.datocms.com/docs/content-management-api/resources/menu-item/update',
|
|
348
|
-
name: 'update',
|
|
349
|
-
rawName: 'rawUpdate',
|
|
350
|
-
urlTemplate: '/menu-items/${menuItemId}',
|
|
351
|
-
method: 'PUT',
|
|
352
|
-
comment: 'Update a menu item',
|
|
353
|
-
urlPlaceholder: {
|
|
354
|
-
variableName: 'menuItemId',
|
|
355
|
-
isEntityId: true,
|
|
356
|
-
relType: 'MenuItemData',
|
|
357
|
-
},
|
|
358
|
-
requestBodyType: 'MenuItemUpdateSchema',
|
|
359
|
-
simpleMethodAvailable: true,
|
|
360
|
-
requestStructure: {
|
|
361
|
-
type: 'menu_item',
|
|
362
|
-
attributes: [
|
|
363
|
-
'label',
|
|
364
|
-
'external_url',
|
|
365
|
-
'position',
|
|
366
|
-
'open_in_new_tab',
|
|
367
|
-
],
|
|
368
|
-
relationships: ['item_type', 'parent'],
|
|
369
|
-
},
|
|
370
|
-
responseType: 'MenuItemUpdateTargetSchema',
|
|
371
|
-
},
|
|
372
|
-
{
|
|
373
|
-
returnsCollection: true,
|
|
374
|
-
docUrl:
|
|
375
|
-
'https://www.datocms.com/docs/content-management-api/resources/menu-item/instances',
|
|
376
|
-
name: 'list',
|
|
377
|
-
rawName: 'rawList',
|
|
378
|
-
urlTemplate: '/menu-items',
|
|
379
|
-
method: 'GET',
|
|
380
|
-
comment: 'List all menu items',
|
|
381
|
-
simpleMethodAvailable: true,
|
|
382
|
-
queryParamsType: 'MenuItemInstancesHrefSchema',
|
|
383
|
-
responseType: 'MenuItemInstancesTargetSchema',
|
|
384
|
-
},
|
|
385
|
-
{
|
|
386
|
-
returnsCollection: false,
|
|
387
|
-
docUrl:
|
|
388
|
-
'https://www.datocms.com/docs/content-management-api/resources/menu-item/self',
|
|
389
|
-
name: 'find',
|
|
390
|
-
rawName: 'rawFind',
|
|
391
|
-
urlTemplate: '/menu-items/${menuItemId}',
|
|
392
|
-
method: 'GET',
|
|
393
|
-
comment: 'Retrieve a menu item',
|
|
394
|
-
urlPlaceholder: {
|
|
395
|
-
variableName: 'menuItemId',
|
|
396
|
-
isEntityId: true,
|
|
397
|
-
relType: 'MenuItemData',
|
|
398
|
-
},
|
|
399
|
-
simpleMethodAvailable: true,
|
|
400
|
-
responseType: 'MenuItemSelfTargetSchema',
|
|
401
|
-
},
|
|
402
|
-
{
|
|
403
|
-
returnsCollection: false,
|
|
404
|
-
docUrl:
|
|
405
|
-
'https://www.datocms.com/docs/content-management-api/resources/menu-item/destroy',
|
|
406
|
-
name: 'destroy',
|
|
407
|
-
rawName: 'rawDestroy',
|
|
408
|
-
urlTemplate: '/menu-items/${menuItemId}',
|
|
409
|
-
method: 'DELETE',
|
|
410
|
-
comment: 'Delete a menu item',
|
|
411
|
-
urlPlaceholder: {
|
|
412
|
-
variableName: 'menuItemId',
|
|
413
|
-
isEntityId: true,
|
|
414
|
-
relType: 'MenuItemData',
|
|
415
|
-
},
|
|
416
|
-
simpleMethodAvailable: true,
|
|
417
|
-
responseType: 'MenuItemDestroyTargetSchema',
|
|
418
|
-
},
|
|
419
|
-
],
|
|
420
|
-
namespace: 'menuItems',
|
|
421
|
-
resourceClassName: 'MenuItem',
|
|
422
|
-
},
|
|
423
|
-
{
|
|
424
|
-
jsonApiType: 'item_type',
|
|
425
|
-
endpoints: [
|
|
426
|
-
{
|
|
427
|
-
returnsCollection: false,
|
|
428
|
-
docUrl:
|
|
429
|
-
'https://www.datocms.com/docs/content-management-api/resources/item-type/create',
|
|
430
|
-
name: 'create',
|
|
431
|
-
rawName: 'rawCreate',
|
|
432
|
-
urlTemplate: '/item-types',
|
|
433
|
-
method: 'POST',
|
|
434
|
-
comment: 'Create a new model',
|
|
435
|
-
requestBodyType: 'ItemTypeCreateSchema',
|
|
436
|
-
simpleMethodAvailable: true,
|
|
437
|
-
requestStructure: {
|
|
438
|
-
type: 'item_type',
|
|
439
|
-
attributes: [
|
|
440
|
-
'name',
|
|
441
|
-
'api_key',
|
|
442
|
-
'singleton',
|
|
443
|
-
'all_locales_required',
|
|
444
|
-
'sortable',
|
|
445
|
-
'modular_block',
|
|
446
|
-
'draft_mode_active',
|
|
447
|
-
'tree',
|
|
448
|
-
'ordering_direction',
|
|
449
|
-
'ordering_meta',
|
|
450
|
-
'collection_appeareance',
|
|
451
|
-
'collection_appearance',
|
|
452
|
-
'hint',
|
|
453
|
-
],
|
|
454
|
-
relationships: [
|
|
455
|
-
'ordering_field',
|
|
456
|
-
'title_field',
|
|
457
|
-
'image_preview_field',
|
|
458
|
-
'excerpt_field',
|
|
459
|
-
'workflow',
|
|
460
|
-
],
|
|
461
|
-
},
|
|
462
|
-
responseType: 'ItemTypeCreateTargetSchema',
|
|
463
|
-
},
|
|
464
|
-
{
|
|
465
|
-
returnsCollection: false,
|
|
466
|
-
docUrl:
|
|
467
|
-
'https://www.datocms.com/docs/content-management-api/resources/item-type/update',
|
|
468
|
-
name: 'update',
|
|
469
|
-
rawName: 'rawUpdate',
|
|
470
|
-
urlTemplate: '/item-types/${itemTypeId}',
|
|
471
|
-
method: 'PUT',
|
|
472
|
-
comment: 'Update a model',
|
|
473
|
-
urlPlaceholder: {
|
|
474
|
-
variableName: 'itemTypeId',
|
|
475
|
-
isEntityId: true,
|
|
476
|
-
relType: 'ItemTypeData',
|
|
477
|
-
},
|
|
478
|
-
requestBodyType: 'ItemTypeUpdateSchema',
|
|
479
|
-
simpleMethodAvailable: true,
|
|
480
|
-
requestStructure: {
|
|
481
|
-
type: 'item_type',
|
|
482
|
-
attributes: [
|
|
483
|
-
'name',
|
|
484
|
-
'api_key',
|
|
485
|
-
'collection_appeareance',
|
|
486
|
-
'collection_appearance',
|
|
487
|
-
'singleton',
|
|
488
|
-
'all_locales_required',
|
|
489
|
-
'sortable',
|
|
490
|
-
'modular_block',
|
|
491
|
-
'draft_mode_active',
|
|
492
|
-
'tree',
|
|
493
|
-
'ordering_direction',
|
|
494
|
-
'ordering_meta',
|
|
495
|
-
'has_singleton_item',
|
|
496
|
-
'hint',
|
|
497
|
-
],
|
|
498
|
-
relationships: [
|
|
499
|
-
'ordering_field',
|
|
500
|
-
'title_field',
|
|
501
|
-
'image_preview_field',
|
|
502
|
-
'excerpt_field',
|
|
503
|
-
'workflow',
|
|
504
|
-
],
|
|
505
|
-
},
|
|
506
|
-
responseType: 'ItemTypeUpdateJobSchema',
|
|
507
|
-
},
|
|
508
|
-
{
|
|
509
|
-
returnsCollection: true,
|
|
510
|
-
docUrl:
|
|
511
|
-
'https://www.datocms.com/docs/content-management-api/resources/item-type/instances',
|
|
512
|
-
name: 'list',
|
|
513
|
-
rawName: 'rawList',
|
|
514
|
-
urlTemplate: '/item-types',
|
|
515
|
-
method: 'GET',
|
|
516
|
-
comment: 'List all models',
|
|
517
|
-
simpleMethodAvailable: true,
|
|
518
|
-
responseType: 'ItemTypeInstancesTargetSchema',
|
|
519
|
-
},
|
|
520
|
-
{
|
|
521
|
-
returnsCollection: false,
|
|
522
|
-
docUrl:
|
|
523
|
-
'https://www.datocms.com/docs/content-management-api/resources/item-type/self',
|
|
524
|
-
name: 'find',
|
|
525
|
-
rawName: 'rawFind',
|
|
526
|
-
urlTemplate: '/item-types/${itemTypeId}',
|
|
527
|
-
method: 'GET',
|
|
528
|
-
comment: 'Retrieve a model',
|
|
529
|
-
urlPlaceholder: {
|
|
530
|
-
variableName: 'itemTypeId',
|
|
531
|
-
isEntityId: true,
|
|
532
|
-
relType: 'ItemTypeData',
|
|
533
|
-
},
|
|
534
|
-
simpleMethodAvailable: true,
|
|
535
|
-
responseType: 'ItemTypeSelfTargetSchema',
|
|
536
|
-
},
|
|
537
|
-
{
|
|
538
|
-
returnsCollection: false,
|
|
539
|
-
docUrl:
|
|
540
|
-
'https://www.datocms.com/docs/content-management-api/resources/item-type/duplicate',
|
|
541
|
-
name: 'duplicate',
|
|
542
|
-
rawName: 'rawDuplicate',
|
|
543
|
-
urlTemplate: '/item-types/${itemTypeId}/duplicate',
|
|
544
|
-
method: 'POST',
|
|
545
|
-
comment: 'Duplicate model',
|
|
546
|
-
urlPlaceholder: {
|
|
547
|
-
variableName: 'itemTypeId',
|
|
548
|
-
isEntityId: true,
|
|
549
|
-
relType: 'ItemTypeData',
|
|
550
|
-
},
|
|
551
|
-
simpleMethodAvailable: true,
|
|
552
|
-
responseType: 'ItemTypeDuplicateTargetSchema',
|
|
553
|
-
},
|
|
554
|
-
{
|
|
555
|
-
returnsCollection: false,
|
|
556
|
-
docUrl:
|
|
557
|
-
'https://www.datocms.com/docs/content-management-api/resources/item-type/destroy',
|
|
558
|
-
name: 'destroy',
|
|
559
|
-
rawName: 'rawDestroy',
|
|
560
|
-
urlTemplate: '/item-types/${itemTypeId}',
|
|
561
|
-
method: 'DELETE',
|
|
562
|
-
comment: 'Delete a model',
|
|
563
|
-
urlPlaceholder: {
|
|
564
|
-
variableName: 'itemTypeId',
|
|
565
|
-
isEntityId: true,
|
|
566
|
-
relType: 'ItemTypeData',
|
|
567
|
-
},
|
|
568
|
-
simpleMethodAvailable: true,
|
|
569
|
-
responseType: 'ItemTypeDestroyJobSchema',
|
|
570
|
-
},
|
|
571
|
-
],
|
|
572
|
-
namespace: 'itemTypes',
|
|
573
|
-
resourceClassName: 'ItemType',
|
|
574
|
-
},
|
|
575
|
-
{
|
|
576
|
-
jsonApiType: 'field',
|
|
577
|
-
endpoints: [
|
|
578
|
-
{
|
|
579
|
-
returnsCollection: false,
|
|
580
|
-
docUrl:
|
|
581
|
-
'https://www.datocms.com/docs/content-management-api/resources/field/create',
|
|
582
|
-
name: 'create',
|
|
583
|
-
rawName: 'rawCreate',
|
|
584
|
-
urlTemplate: '/item-types/${itemTypeId}/fields',
|
|
585
|
-
method: 'POST',
|
|
586
|
-
comment: 'Create a new field',
|
|
587
|
-
urlPlaceholder: {
|
|
588
|
-
variableName: 'itemTypeId',
|
|
589
|
-
isEntityId: false,
|
|
590
|
-
relType: 'ItemTypeData',
|
|
591
|
-
},
|
|
592
|
-
requestBodyType: 'FieldCreateSchema',
|
|
593
|
-
simpleMethodAvailable: true,
|
|
594
|
-
requestStructure: {
|
|
595
|
-
type: 'field',
|
|
596
|
-
attributes: [
|
|
597
|
-
'label',
|
|
598
|
-
'field_type',
|
|
599
|
-
'api_key',
|
|
600
|
-
'localized',
|
|
601
|
-
'validators',
|
|
602
|
-
'appeareance',
|
|
603
|
-
'appearance',
|
|
604
|
-
'position',
|
|
605
|
-
'hint',
|
|
606
|
-
'default_value',
|
|
607
|
-
],
|
|
608
|
-
relationships: ['fieldset'],
|
|
609
|
-
},
|
|
610
|
-
responseType: 'FieldCreateJobSchema',
|
|
611
|
-
},
|
|
612
|
-
{
|
|
613
|
-
returnsCollection: false,
|
|
614
|
-
docUrl:
|
|
615
|
-
'https://www.datocms.com/docs/content-management-api/resources/field/update',
|
|
616
|
-
name: 'update',
|
|
617
|
-
rawName: 'rawUpdate',
|
|
618
|
-
urlTemplate: '/fields/${fieldId}',
|
|
619
|
-
method: 'PUT',
|
|
620
|
-
comment: 'Update a field',
|
|
621
|
-
urlPlaceholder: {
|
|
622
|
-
variableName: 'fieldId',
|
|
623
|
-
isEntityId: true,
|
|
624
|
-
relType: 'FieldData',
|
|
625
|
-
},
|
|
626
|
-
requestBodyType: 'FieldUpdateSchema',
|
|
627
|
-
simpleMethodAvailable: true,
|
|
628
|
-
requestStructure: {
|
|
629
|
-
type: 'field',
|
|
630
|
-
attributes: [
|
|
631
|
-
'default_value',
|
|
632
|
-
'label',
|
|
633
|
-
'api_key',
|
|
634
|
-
'localized',
|
|
635
|
-
'validators',
|
|
636
|
-
'appeareance',
|
|
637
|
-
'appearance',
|
|
638
|
-
'position',
|
|
639
|
-
'field_type',
|
|
640
|
-
'hint',
|
|
641
|
-
],
|
|
642
|
-
relationships: ['fieldset'],
|
|
643
|
-
},
|
|
644
|
-
responseType: 'FieldUpdateJobSchema',
|
|
645
|
-
},
|
|
646
|
-
{
|
|
647
|
-
returnsCollection: true,
|
|
648
|
-
docUrl:
|
|
649
|
-
'https://www.datocms.com/docs/content-management-api/resources/field/instances',
|
|
650
|
-
name: 'list',
|
|
651
|
-
rawName: 'rawList',
|
|
652
|
-
urlTemplate: '/item-types/${itemTypeId}/fields',
|
|
653
|
-
method: 'GET',
|
|
654
|
-
comment: 'List all fields',
|
|
655
|
-
urlPlaceholder: {
|
|
656
|
-
variableName: 'itemTypeId',
|
|
657
|
-
isEntityId: false,
|
|
658
|
-
relType: 'ItemTypeData',
|
|
659
|
-
},
|
|
660
|
-
simpleMethodAvailable: true,
|
|
661
|
-
responseType: 'FieldInstancesTargetSchema',
|
|
662
|
-
},
|
|
663
|
-
{
|
|
664
|
-
returnsCollection: false,
|
|
665
|
-
docUrl:
|
|
666
|
-
'https://www.datocms.com/docs/content-management-api/resources/field/referencing',
|
|
667
|
-
name: 'referencing',
|
|
668
|
-
rawName: 'rawReferencing',
|
|
669
|
-
urlTemplate: '/item-types/${itemTypeId}/fields/referencing',
|
|
670
|
-
method: 'GET',
|
|
671
|
-
comment: 'List referenced fields',
|
|
672
|
-
urlPlaceholder: {
|
|
673
|
-
variableName: 'itemTypeId',
|
|
674
|
-
isEntityId: false,
|
|
675
|
-
relType: 'ItemTypeData',
|
|
676
|
-
},
|
|
677
|
-
simpleMethodAvailable: true,
|
|
678
|
-
responseType: 'FieldReferencingTargetSchema',
|
|
679
|
-
deprecated:
|
|
680
|
-
'This API call is to be considered private and might change without notice',
|
|
681
|
-
},
|
|
682
|
-
{
|
|
683
|
-
returnsCollection: false,
|
|
684
|
-
docUrl:
|
|
685
|
-
'https://www.datocms.com/docs/content-management-api/resources/field/related',
|
|
686
|
-
name: 'related',
|
|
687
|
-
rawName: 'rawRelated',
|
|
688
|
-
urlTemplate: '/item-types/${itemTypeId}/fields/related',
|
|
689
|
-
method: 'GET',
|
|
690
|
-
comment: 'List related fields',
|
|
691
|
-
urlPlaceholder: {
|
|
692
|
-
variableName: 'itemTypeId',
|
|
693
|
-
isEntityId: false,
|
|
694
|
-
relType: 'ItemTypeData',
|
|
695
|
-
},
|
|
696
|
-
simpleMethodAvailable: true,
|
|
697
|
-
responseType: 'FieldRelatedTargetSchema',
|
|
698
|
-
deprecated:
|
|
699
|
-
'This API call is to be considered private and might change without notice',
|
|
700
|
-
},
|
|
701
|
-
{
|
|
702
|
-
returnsCollection: false,
|
|
703
|
-
docUrl:
|
|
704
|
-
'https://www.datocms.com/docs/content-management-api/resources/field/self',
|
|
705
|
-
name: 'find',
|
|
706
|
-
rawName: 'rawFind',
|
|
707
|
-
urlTemplate: '/fields/${fieldId}',
|
|
708
|
-
method: 'GET',
|
|
709
|
-
comment: 'Retrieve a field',
|
|
710
|
-
urlPlaceholder: {
|
|
711
|
-
variableName: 'fieldId',
|
|
712
|
-
isEntityId: true,
|
|
713
|
-
relType: 'FieldData',
|
|
714
|
-
},
|
|
715
|
-
simpleMethodAvailable: true,
|
|
716
|
-
responseType: 'FieldSelfTargetSchema',
|
|
717
|
-
},
|
|
718
|
-
{
|
|
719
|
-
returnsCollection: false,
|
|
720
|
-
docUrl:
|
|
721
|
-
'https://www.datocms.com/docs/content-management-api/resources/field/destroy',
|
|
722
|
-
name: 'destroy',
|
|
723
|
-
rawName: 'rawDestroy',
|
|
724
|
-
urlTemplate: '/fields/${fieldId}',
|
|
725
|
-
method: 'DELETE',
|
|
726
|
-
comment: 'Delete a field',
|
|
727
|
-
urlPlaceholder: {
|
|
728
|
-
variableName: 'fieldId',
|
|
729
|
-
isEntityId: true,
|
|
730
|
-
relType: 'FieldData',
|
|
731
|
-
},
|
|
732
|
-
simpleMethodAvailable: true,
|
|
733
|
-
responseType: 'FieldDestroyJobSchema',
|
|
734
|
-
},
|
|
735
|
-
{
|
|
736
|
-
returnsCollection: false,
|
|
737
|
-
docUrl:
|
|
738
|
-
'https://www.datocms.com/docs/content-management-api/resources/field/duplicate',
|
|
739
|
-
name: 'duplicate',
|
|
740
|
-
rawName: 'rawDuplicate',
|
|
741
|
-
urlTemplate: '/fields/${fieldId}/duplicate',
|
|
742
|
-
method: 'POST',
|
|
743
|
-
comment: 'Duplicate a field',
|
|
744
|
-
urlPlaceholder: {
|
|
745
|
-
variableName: 'fieldId',
|
|
746
|
-
isEntityId: true,
|
|
747
|
-
relType: 'FieldData',
|
|
748
|
-
},
|
|
749
|
-
simpleMethodAvailable: true,
|
|
750
|
-
responseType: 'FieldDuplicateJobSchema',
|
|
751
|
-
},
|
|
752
|
-
],
|
|
753
|
-
namespace: 'fields',
|
|
754
|
-
resourceClassName: 'Field',
|
|
755
|
-
},
|
|
756
|
-
{
|
|
757
|
-
jsonApiType: 'fieldset',
|
|
758
|
-
endpoints: [
|
|
759
|
-
{
|
|
760
|
-
returnsCollection: false,
|
|
761
|
-
docUrl:
|
|
762
|
-
'https://www.datocms.com/docs/content-management-api/resources/fieldset/create',
|
|
763
|
-
name: 'create',
|
|
764
|
-
rawName: 'rawCreate',
|
|
765
|
-
urlTemplate: '/item-types/${itemTypeId}/fieldsets',
|
|
766
|
-
method: 'POST',
|
|
767
|
-
comment: 'Create a new fieldset',
|
|
768
|
-
urlPlaceholder: {
|
|
769
|
-
variableName: 'itemTypeId',
|
|
770
|
-
isEntityId: false,
|
|
771
|
-
relType: 'ItemTypeData',
|
|
772
|
-
},
|
|
773
|
-
requestBodyType: 'FieldsetCreateSchema',
|
|
774
|
-
simpleMethodAvailable: true,
|
|
775
|
-
requestStructure: {
|
|
776
|
-
type: 'fieldset',
|
|
777
|
-
attributes: [
|
|
778
|
-
'title',
|
|
779
|
-
'hint',
|
|
780
|
-
'position',
|
|
781
|
-
'collapsible',
|
|
782
|
-
'start_collapsed',
|
|
783
|
-
],
|
|
784
|
-
relationships: [],
|
|
785
|
-
},
|
|
786
|
-
responseType: 'FieldsetCreateTargetSchema',
|
|
787
|
-
},
|
|
788
|
-
{
|
|
789
|
-
returnsCollection: false,
|
|
790
|
-
docUrl:
|
|
791
|
-
'https://www.datocms.com/docs/content-management-api/resources/fieldset/update',
|
|
792
|
-
name: 'update',
|
|
793
|
-
rawName: 'rawUpdate',
|
|
794
|
-
urlTemplate: '/fieldsets/${fieldsetId}',
|
|
795
|
-
method: 'PUT',
|
|
796
|
-
comment: 'Update a fieldset',
|
|
797
|
-
urlPlaceholder: {
|
|
798
|
-
variableName: 'fieldsetId',
|
|
799
|
-
isEntityId: true,
|
|
800
|
-
relType: 'FieldsetData',
|
|
801
|
-
},
|
|
802
|
-
requestBodyType: 'FieldsetUpdateSchema',
|
|
803
|
-
simpleMethodAvailable: true,
|
|
804
|
-
requestStructure: {
|
|
805
|
-
type: 'fieldset',
|
|
806
|
-
attributes: [
|
|
807
|
-
'title',
|
|
808
|
-
'hint',
|
|
809
|
-
'position',
|
|
810
|
-
'collapsible',
|
|
811
|
-
'start_collapsed',
|
|
812
|
-
],
|
|
813
|
-
relationships: [],
|
|
814
|
-
},
|
|
815
|
-
responseType: 'FieldsetUpdateTargetSchema',
|
|
816
|
-
},
|
|
817
|
-
{
|
|
818
|
-
returnsCollection: true,
|
|
819
|
-
docUrl:
|
|
820
|
-
'https://www.datocms.com/docs/content-management-api/resources/fieldset/instances',
|
|
821
|
-
name: 'list',
|
|
822
|
-
rawName: 'rawList',
|
|
823
|
-
urlTemplate: '/item-types/${itemTypeId}/fieldsets',
|
|
824
|
-
method: 'GET',
|
|
825
|
-
comment: 'List all fieldsets',
|
|
826
|
-
urlPlaceholder: {
|
|
827
|
-
variableName: 'itemTypeId',
|
|
828
|
-
isEntityId: false,
|
|
829
|
-
relType: 'ItemTypeData',
|
|
830
|
-
},
|
|
831
|
-
simpleMethodAvailable: true,
|
|
832
|
-
responseType: 'FieldsetInstancesTargetSchema',
|
|
833
|
-
},
|
|
834
|
-
{
|
|
835
|
-
returnsCollection: false,
|
|
836
|
-
docUrl:
|
|
837
|
-
'https://www.datocms.com/docs/content-management-api/resources/fieldset/self',
|
|
838
|
-
name: 'find',
|
|
839
|
-
rawName: 'rawFind',
|
|
840
|
-
urlTemplate: '/fieldsets/${fieldsetId}',
|
|
841
|
-
method: 'GET',
|
|
842
|
-
comment: 'Retrieve a fieldset',
|
|
843
|
-
urlPlaceholder: {
|
|
844
|
-
variableName: 'fieldsetId',
|
|
845
|
-
isEntityId: true,
|
|
846
|
-
relType: 'FieldsetData',
|
|
847
|
-
},
|
|
848
|
-
simpleMethodAvailable: true,
|
|
849
|
-
responseType: 'FieldsetSelfTargetSchema',
|
|
850
|
-
},
|
|
851
|
-
{
|
|
852
|
-
returnsCollection: false,
|
|
853
|
-
docUrl:
|
|
854
|
-
'https://www.datocms.com/docs/content-management-api/resources/fieldset/destroy',
|
|
855
|
-
name: 'destroy',
|
|
856
|
-
rawName: 'rawDestroy',
|
|
857
|
-
urlTemplate: '/fieldsets/${fieldsetId}',
|
|
858
|
-
method: 'DELETE',
|
|
859
|
-
comment: 'Delete a fieldset',
|
|
860
|
-
urlPlaceholder: {
|
|
861
|
-
variableName: 'fieldsetId',
|
|
862
|
-
isEntityId: true,
|
|
863
|
-
relType: 'FieldsetData',
|
|
864
|
-
},
|
|
865
|
-
simpleMethodAvailable: true,
|
|
866
|
-
responseType: 'FieldsetDestroyTargetSchema',
|
|
867
|
-
},
|
|
868
|
-
],
|
|
869
|
-
namespace: 'fieldsets',
|
|
870
|
-
resourceClassName: 'Fieldset',
|
|
871
|
-
},
|
|
872
|
-
{
|
|
873
|
-
jsonApiType: 'session',
|
|
874
|
-
endpoints: [
|
|
875
|
-
{
|
|
876
|
-
returnsCollection: false,
|
|
877
|
-
docUrl:
|
|
878
|
-
'https://www.datocms.com/docs/content-management-api/resources/session/create',
|
|
879
|
-
name: 'create',
|
|
880
|
-
rawName: 'rawCreate',
|
|
881
|
-
urlTemplate: '/sessions',
|
|
882
|
-
method: 'POST',
|
|
883
|
-
comment: 'Create a new session',
|
|
884
|
-
requestBodyType: 'SessionCreateSchema',
|
|
885
|
-
simpleMethodAvailable: true,
|
|
886
|
-
requestStructure: {
|
|
887
|
-
type: 'email_credentials',
|
|
888
|
-
attributes: ['email', 'password', 'otp_code'],
|
|
889
|
-
relationships: [],
|
|
890
|
-
},
|
|
891
|
-
responseType: 'SessionCreateTargetSchema',
|
|
892
|
-
deprecated:
|
|
893
|
-
'This API call is to be considered private and might change without notice',
|
|
894
|
-
},
|
|
895
|
-
],
|
|
896
|
-
namespace: 'session',
|
|
897
|
-
resourceClassName: 'Session',
|
|
898
|
-
},
|
|
899
|
-
{
|
|
900
|
-
jsonApiType: 'access_token',
|
|
901
|
-
endpoints: [
|
|
902
|
-
{
|
|
903
|
-
returnsCollection: false,
|
|
904
|
-
docUrl:
|
|
905
|
-
'https://www.datocms.com/docs/content-management-api/resources/access-token/create',
|
|
906
|
-
name: 'create',
|
|
907
|
-
rawName: 'rawCreate',
|
|
908
|
-
urlTemplate: '/access_tokens',
|
|
909
|
-
method: 'POST',
|
|
910
|
-
comment: 'Create a new API token',
|
|
911
|
-
requestBodyType: 'AccessTokenCreateSchema',
|
|
912
|
-
simpleMethodAvailable: true,
|
|
913
|
-
requestStructure: {
|
|
914
|
-
type: 'access_token',
|
|
915
|
-
attributes: [
|
|
916
|
-
'name',
|
|
917
|
-
'can_access_cda',
|
|
918
|
-
'can_access_cda_preview',
|
|
919
|
-
'can_access_cma',
|
|
920
|
-
],
|
|
921
|
-
relationships: ['role'],
|
|
922
|
-
},
|
|
923
|
-
responseType: 'AccessTokenCreateTargetSchema',
|
|
924
|
-
},
|
|
925
|
-
{
|
|
926
|
-
returnsCollection: false,
|
|
927
|
-
docUrl:
|
|
928
|
-
'https://www.datocms.com/docs/content-management-api/resources/access-token/update',
|
|
929
|
-
name: 'update',
|
|
930
|
-
rawName: 'rawUpdate',
|
|
931
|
-
urlTemplate: '/access_tokens/${accessTokenId}',
|
|
932
|
-
method: 'PUT',
|
|
933
|
-
comment: 'Update an API token',
|
|
934
|
-
urlPlaceholder: {
|
|
935
|
-
variableName: 'accessTokenId',
|
|
936
|
-
isEntityId: true,
|
|
937
|
-
relType: 'AccessTokenData',
|
|
938
|
-
},
|
|
939
|
-
requestBodyType: 'AccessTokenUpdateSchema',
|
|
940
|
-
simpleMethodAvailable: true,
|
|
941
|
-
requestStructure: {
|
|
942
|
-
type: 'access_token',
|
|
943
|
-
attributes: [
|
|
944
|
-
'name',
|
|
945
|
-
'can_access_cda',
|
|
946
|
-
'can_access_cda_preview',
|
|
947
|
-
'can_access_cma',
|
|
948
|
-
],
|
|
949
|
-
relationships: ['role'],
|
|
950
|
-
},
|
|
951
|
-
responseType: 'AccessTokenUpdateTargetSchema',
|
|
952
|
-
},
|
|
953
|
-
{
|
|
954
|
-
returnsCollection: true,
|
|
955
|
-
docUrl:
|
|
956
|
-
'https://www.datocms.com/docs/content-management-api/resources/access-token/instances',
|
|
957
|
-
name: 'list',
|
|
958
|
-
rawName: 'rawList',
|
|
959
|
-
urlTemplate: '/access_tokens',
|
|
960
|
-
method: 'GET',
|
|
961
|
-
comment: 'List all API tokens',
|
|
962
|
-
simpleMethodAvailable: true,
|
|
963
|
-
responseType: 'AccessTokenInstancesTargetSchema',
|
|
964
|
-
},
|
|
965
|
-
{
|
|
966
|
-
returnsCollection: false,
|
|
967
|
-
docUrl:
|
|
968
|
-
'https://www.datocms.com/docs/content-management-api/resources/access-token/self',
|
|
969
|
-
name: 'find',
|
|
970
|
-
rawName: 'rawFind',
|
|
971
|
-
urlTemplate: '/access_tokens/${accessTokenId}',
|
|
972
|
-
method: 'GET',
|
|
973
|
-
comment: 'Retrieve an API token',
|
|
974
|
-
urlPlaceholder: {
|
|
975
|
-
variableName: 'accessTokenId',
|
|
976
|
-
isEntityId: true,
|
|
977
|
-
relType: 'AccessTokenData',
|
|
978
|
-
},
|
|
979
|
-
simpleMethodAvailable: true,
|
|
980
|
-
responseType: 'AccessTokenSelfTargetSchema',
|
|
981
|
-
},
|
|
982
|
-
{
|
|
983
|
-
returnsCollection: false,
|
|
984
|
-
docUrl:
|
|
985
|
-
'https://www.datocms.com/docs/content-management-api/resources/access-token/regenerate_token',
|
|
986
|
-
name: 'regenerateToken',
|
|
987
|
-
rawName: 'rawRegenerateToken',
|
|
988
|
-
urlTemplate: '/access_tokens/${accessTokenId}/regenerate_token',
|
|
989
|
-
method: 'POST',
|
|
990
|
-
comment: 'Rotate API token',
|
|
991
|
-
urlPlaceholder: {
|
|
992
|
-
variableName: 'accessTokenId',
|
|
993
|
-
isEntityId: true,
|
|
994
|
-
relType: 'AccessTokenData',
|
|
995
|
-
},
|
|
996
|
-
simpleMethodAvailable: true,
|
|
997
|
-
responseType: 'AccessTokenRegenerateTokenTargetSchema',
|
|
998
|
-
},
|
|
999
|
-
{
|
|
1000
|
-
returnsCollection: false,
|
|
1001
|
-
docUrl:
|
|
1002
|
-
'https://www.datocms.com/docs/content-management-api/resources/access-token/destroy',
|
|
1003
|
-
name: 'destroy',
|
|
1004
|
-
rawName: 'rawDestroy',
|
|
1005
|
-
urlTemplate: '/access_tokens/${accessTokenId}',
|
|
1006
|
-
method: 'DELETE',
|
|
1007
|
-
comment: 'Delete an API token',
|
|
1008
|
-
urlPlaceholder: {
|
|
1009
|
-
variableName: 'accessTokenId',
|
|
1010
|
-
isEntityId: true,
|
|
1011
|
-
relType: 'AccessTokenData',
|
|
1012
|
-
},
|
|
1013
|
-
simpleMethodAvailable: true,
|
|
1014
|
-
queryParamsType: 'AccessTokenDestroyHrefSchema',
|
|
1015
|
-
responseType: 'AccessTokenDestroyTargetSchema',
|
|
1016
|
-
},
|
|
1017
|
-
],
|
|
1018
|
-
namespace: 'accessTokens',
|
|
1019
|
-
resourceClassName: 'AccessToken',
|
|
1020
|
-
},
|
|
1021
|
-
{
|
|
1022
|
-
jsonApiType: 'plugin',
|
|
1023
|
-
endpoints: [
|
|
1024
|
-
{
|
|
1025
|
-
returnsCollection: false,
|
|
1026
|
-
docUrl:
|
|
1027
|
-
'https://www.datocms.com/docs/content-management-api/resources/plugin/create',
|
|
1028
|
-
name: 'create',
|
|
1029
|
-
rawName: 'rawCreate',
|
|
1030
|
-
urlTemplate: '/plugins',
|
|
1031
|
-
method: 'POST',
|
|
1032
|
-
comment: 'Create a new plugin',
|
|
1033
|
-
requestBodyType: 'PluginCreateSchema',
|
|
1034
|
-
simpleMethodAvailable: true,
|
|
1035
|
-
requestStructure: {
|
|
1036
|
-
type: 'plugin',
|
|
1037
|
-
attributes: [
|
|
1038
|
-
'package_name',
|
|
1039
|
-
'name',
|
|
1040
|
-
'description',
|
|
1041
|
-
'url',
|
|
1042
|
-
'permissions',
|
|
1043
|
-
'plugin_type',
|
|
1044
|
-
'field_types',
|
|
1045
|
-
'parameter_definitions',
|
|
1046
|
-
'package_version',
|
|
1047
|
-
],
|
|
1048
|
-
relationships: [],
|
|
1049
|
-
},
|
|
1050
|
-
responseType: 'PluginCreateTargetSchema',
|
|
1051
|
-
},
|
|
1052
|
-
{
|
|
1053
|
-
returnsCollection: false,
|
|
1054
|
-
docUrl:
|
|
1055
|
-
'https://www.datocms.com/docs/content-management-api/resources/plugin/update',
|
|
1056
|
-
name: 'update',
|
|
1057
|
-
rawName: 'rawUpdate',
|
|
1058
|
-
urlTemplate: '/plugins/${pluginId}',
|
|
1059
|
-
method: 'PUT',
|
|
1060
|
-
comment: 'Update a plugin',
|
|
1061
|
-
urlPlaceholder: {
|
|
1062
|
-
variableName: 'pluginId',
|
|
1063
|
-
isEntityId: true,
|
|
1064
|
-
relType: 'PluginData',
|
|
1065
|
-
},
|
|
1066
|
-
requestBodyType: 'PluginUpdateSchema',
|
|
1067
|
-
simpleMethodAvailable: true,
|
|
1068
|
-
requestStructure: {
|
|
1069
|
-
type: 'plugin',
|
|
1070
|
-
attributes: [
|
|
1071
|
-
'name',
|
|
1072
|
-
'description',
|
|
1073
|
-
'url',
|
|
1074
|
-
'parameters',
|
|
1075
|
-
'package_version',
|
|
1076
|
-
'permissions',
|
|
1077
|
-
],
|
|
1078
|
-
relationships: [],
|
|
1079
|
-
},
|
|
1080
|
-
responseType: 'PluginUpdateTargetSchema',
|
|
1081
|
-
},
|
|
1082
|
-
{
|
|
1083
|
-
returnsCollection: true,
|
|
1084
|
-
docUrl:
|
|
1085
|
-
'https://www.datocms.com/docs/content-management-api/resources/plugin/instances',
|
|
1086
|
-
name: 'list',
|
|
1087
|
-
rawName: 'rawList',
|
|
1088
|
-
urlTemplate: '/plugins',
|
|
1089
|
-
method: 'GET',
|
|
1090
|
-
comment: 'List all plugins',
|
|
1091
|
-
simpleMethodAvailable: true,
|
|
1092
|
-
responseType: 'PluginInstancesTargetSchema',
|
|
1093
|
-
},
|
|
1094
|
-
{
|
|
1095
|
-
returnsCollection: false,
|
|
1096
|
-
docUrl:
|
|
1097
|
-
'https://www.datocms.com/docs/content-management-api/resources/plugin/self',
|
|
1098
|
-
name: 'find',
|
|
1099
|
-
rawName: 'rawFind',
|
|
1100
|
-
urlTemplate: '/plugins/${pluginId}',
|
|
1101
|
-
method: 'GET',
|
|
1102
|
-
comment: 'Retrieve a plugins',
|
|
1103
|
-
urlPlaceholder: {
|
|
1104
|
-
variableName: 'pluginId',
|
|
1105
|
-
isEntityId: true,
|
|
1106
|
-
relType: 'PluginData',
|
|
1107
|
-
},
|
|
1108
|
-
simpleMethodAvailable: true,
|
|
1109
|
-
responseType: 'PluginSelfTargetSchema',
|
|
1110
|
-
},
|
|
1111
|
-
{
|
|
1112
|
-
returnsCollection: false,
|
|
1113
|
-
docUrl:
|
|
1114
|
-
'https://www.datocms.com/docs/content-management-api/resources/plugin/destroy',
|
|
1115
|
-
name: 'destroy',
|
|
1116
|
-
rawName: 'rawDestroy',
|
|
1117
|
-
urlTemplate: '/plugins/${pluginId}',
|
|
1118
|
-
method: 'DELETE',
|
|
1119
|
-
comment: 'Delete a plugin',
|
|
1120
|
-
urlPlaceholder: {
|
|
1121
|
-
variableName: 'pluginId',
|
|
1122
|
-
isEntityId: true,
|
|
1123
|
-
relType: 'PluginData',
|
|
1124
|
-
},
|
|
1125
|
-
simpleMethodAvailable: true,
|
|
1126
|
-
responseType: 'PluginDestroyTargetSchema',
|
|
1127
|
-
},
|
|
1128
|
-
{
|
|
1129
|
-
returnsCollection: false,
|
|
1130
|
-
docUrl:
|
|
1131
|
-
'https://www.datocms.com/docs/content-management-api/resources/plugin/fields',
|
|
1132
|
-
name: 'fields',
|
|
1133
|
-
rawName: 'rawFields',
|
|
1134
|
-
urlTemplate: '/plugins/${pluginId}/fields',
|
|
1135
|
-
method: 'GET',
|
|
1136
|
-
comment: 'Retrieve all fields using the plugin',
|
|
1137
|
-
urlPlaceholder: {
|
|
1138
|
-
variableName: 'pluginId',
|
|
1139
|
-
isEntityId: true,
|
|
1140
|
-
relType: 'PluginData',
|
|
1141
|
-
},
|
|
1142
|
-
simpleMethodAvailable: true,
|
|
1143
|
-
responseType: 'PluginFieldsTargetSchema',
|
|
1144
|
-
},
|
|
1145
|
-
],
|
|
1146
|
-
namespace: 'plugins',
|
|
1147
|
-
resourceClassName: 'Plugin',
|
|
1148
|
-
},
|
|
1149
|
-
{
|
|
1150
|
-
jsonApiType: 'job_result',
|
|
1151
|
-
endpoints: [
|
|
1152
|
-
{
|
|
1153
|
-
returnsCollection: false,
|
|
1154
|
-
docUrl:
|
|
1155
|
-
'https://www.datocms.com/docs/content-management-api/resources/job-result/self',
|
|
1156
|
-
name: 'find',
|
|
1157
|
-
rawName: 'rawFind',
|
|
1158
|
-
urlTemplate: '/job-results/${jobResultId}',
|
|
1159
|
-
method: 'GET',
|
|
1160
|
-
comment: 'Retrieve a job result',
|
|
1161
|
-
urlPlaceholder: {
|
|
1162
|
-
variableName: 'jobResultId',
|
|
1163
|
-
isEntityId: true,
|
|
1164
|
-
relType: 'JobResultData',
|
|
1165
|
-
},
|
|
1166
|
-
simpleMethodAvailable: true,
|
|
1167
|
-
responseType: 'JobResultSelfTargetSchema',
|
|
1168
|
-
},
|
|
1169
|
-
],
|
|
1170
|
-
namespace: 'jobResults',
|
|
1171
|
-
resourceClassName: 'JobResult',
|
|
1172
|
-
},
|
|
1173
|
-
{
|
|
1174
|
-
jsonApiType: 'subscription_limit',
|
|
1175
|
-
endpoints: [
|
|
1176
|
-
{
|
|
1177
|
-
returnsCollection: true,
|
|
1178
|
-
docUrl:
|
|
1179
|
-
'https://www.datocms.com/docs/content-management-api/resources/subscription-limit/instances',
|
|
1180
|
-
name: 'list',
|
|
1181
|
-
rawName: 'rawList',
|
|
1182
|
-
urlTemplate: '/subscription-limits',
|
|
1183
|
-
method: 'GET',
|
|
1184
|
-
comment: 'Get all the subscription limits',
|
|
1185
|
-
simpleMethodAvailable: true,
|
|
1186
|
-
responseType: 'SubscriptionLimitInstancesTargetSchema',
|
|
1187
|
-
},
|
|
1188
|
-
{
|
|
1189
|
-
returnsCollection: false,
|
|
1190
|
-
docUrl:
|
|
1191
|
-
'https://www.datocms.com/docs/content-management-api/resources/subscription-limit/self',
|
|
1192
|
-
name: 'find',
|
|
1193
|
-
rawName: 'rawFind',
|
|
1194
|
-
urlTemplate: '/subscription-limits/${subscriptionLimitId}',
|
|
1195
|
-
method: 'GET',
|
|
1196
|
-
comment: 'Get a single subscription limit',
|
|
1197
|
-
urlPlaceholder: {
|
|
1198
|
-
variableName: 'subscriptionLimitId',
|
|
1199
|
-
isEntityId: true,
|
|
1200
|
-
relType: 'SubscriptionLimitData',
|
|
1201
|
-
},
|
|
1202
|
-
simpleMethodAvailable: true,
|
|
1203
|
-
responseType: 'SubscriptionLimitSelfTargetSchema',
|
|
1204
|
-
},
|
|
1205
|
-
],
|
|
1206
|
-
namespace: 'subscriptionLimits',
|
|
1207
|
-
resourceClassName: 'SubscriptionLimit',
|
|
1208
|
-
},
|
|
1209
|
-
{
|
|
1210
|
-
jsonApiType: 'subscription_feature',
|
|
1211
|
-
endpoints: [
|
|
1212
|
-
{
|
|
1213
|
-
returnsCollection: true,
|
|
1214
|
-
docUrl:
|
|
1215
|
-
'https://www.datocms.com/docs/content-management-api/resources/subscription-feature/instances',
|
|
1216
|
-
name: 'list',
|
|
1217
|
-
rawName: 'rawList',
|
|
1218
|
-
urlTemplate: '/subscription-features',
|
|
1219
|
-
method: 'GET',
|
|
1220
|
-
comment: 'Get all the subscription features',
|
|
1221
|
-
simpleMethodAvailable: true,
|
|
1222
|
-
responseType: 'SubscriptionFeatureInstancesTargetSchema',
|
|
1223
|
-
},
|
|
1224
|
-
],
|
|
1225
|
-
namespace: 'subscriptionFeatures',
|
|
1226
|
-
resourceClassName: 'SubscriptionFeature',
|
|
1227
|
-
},
|
|
1228
|
-
{
|
|
1229
|
-
jsonApiType: 'build_event',
|
|
1230
|
-
endpoints: [
|
|
1231
|
-
{
|
|
1232
|
-
returnsCollection: true,
|
|
1233
|
-
docUrl:
|
|
1234
|
-
'https://www.datocms.com/docs/content-management-api/resources/build-event/instances',
|
|
1235
|
-
name: 'list',
|
|
1236
|
-
rawName: 'rawList',
|
|
1237
|
-
urlTemplate: '/build-events',
|
|
1238
|
-
method: 'GET',
|
|
1239
|
-
comment: 'List all deploy events',
|
|
1240
|
-
simpleMethodAvailable: true,
|
|
1241
|
-
responseType: 'BuildEventInstancesTargetSchema',
|
|
1242
|
-
},
|
|
1243
|
-
{
|
|
1244
|
-
returnsCollection: false,
|
|
1245
|
-
docUrl:
|
|
1246
|
-
'https://www.datocms.com/docs/content-management-api/resources/build-event/self',
|
|
1247
|
-
name: 'find',
|
|
1248
|
-
rawName: 'rawFind',
|
|
1249
|
-
urlTemplate: '/build-events/${buildEventId}',
|
|
1250
|
-
method: 'GET',
|
|
1251
|
-
comment: 'Retrieve a deploy event',
|
|
1252
|
-
urlPlaceholder: {
|
|
1253
|
-
variableName: 'buildEventId',
|
|
1254
|
-
isEntityId: true,
|
|
1255
|
-
relType: 'BuildEventData',
|
|
1256
|
-
},
|
|
1257
|
-
simpleMethodAvailable: true,
|
|
1258
|
-
responseType: 'BuildEventSelfTargetSchema',
|
|
1259
|
-
},
|
|
1260
|
-
],
|
|
1261
|
-
namespace: 'buildEvents',
|
|
1262
|
-
resourceClassName: 'BuildEvent',
|
|
1263
|
-
},
|
|
1264
|
-
{
|
|
1265
|
-
jsonApiType: 'item',
|
|
1266
|
-
endpoints: [
|
|
1267
|
-
{
|
|
1268
|
-
returnsCollection: true,
|
|
1269
|
-
docUrl:
|
|
1270
|
-
'https://www.datocms.com/docs/content-management-api/resources/item/instances',
|
|
1271
|
-
name: 'list',
|
|
1272
|
-
rawName: 'rawList',
|
|
1273
|
-
urlTemplate: '/items',
|
|
1274
|
-
method: 'GET',
|
|
1275
|
-
comment: 'List all records',
|
|
1276
|
-
simpleMethodAvailable: true,
|
|
1277
|
-
queryParamsType: 'ItemInstancesHrefSchema',
|
|
1278
|
-
responseType: 'ItemInstancesTargetSchema',
|
|
1279
|
-
paginatedResponse: {
|
|
1280
|
-
defaultLimit: 30,
|
|
1281
|
-
maxLimit: 500,
|
|
1282
|
-
},
|
|
1283
|
-
},
|
|
1284
|
-
{
|
|
1285
|
-
returnsCollection: false,
|
|
1286
|
-
docUrl:
|
|
1287
|
-
'https://www.datocms.com/docs/content-management-api/resources/item/validate_existing',
|
|
1288
|
-
name: 'validateExisting',
|
|
1289
|
-
rawName: 'rawValidateExisting',
|
|
1290
|
-
urlTemplate: '/items/${itemId}/validate',
|
|
1291
|
-
method: 'POST',
|
|
1292
|
-
comment: 'Validates an existing record field',
|
|
1293
|
-
urlPlaceholder: {
|
|
1294
|
-
variableName: 'itemId',
|
|
1295
|
-
isEntityId: true,
|
|
1296
|
-
relType: 'ItemData',
|
|
1297
|
-
},
|
|
1298
|
-
requestBodyType: 'ItemValidateExistingSchema',
|
|
1299
|
-
simpleMethodAvailable: true,
|
|
1300
|
-
requestStructure: {
|
|
1301
|
-
type: 'item',
|
|
1302
|
-
attributes: '*',
|
|
1303
|
-
relationships: ['item_type', 'creator'],
|
|
1304
|
-
},
|
|
1305
|
-
deprecated:
|
|
1306
|
-
'This API call is to be considered private and might change without notice',
|
|
1307
|
-
},
|
|
1308
|
-
{
|
|
1309
|
-
returnsCollection: false,
|
|
1310
|
-
docUrl:
|
|
1311
|
-
'https://www.datocms.com/docs/content-management-api/resources/item/validate_new',
|
|
1312
|
-
name: 'validateNew',
|
|
1313
|
-
rawName: 'rawValidateNew',
|
|
1314
|
-
urlTemplate: '/items/validate',
|
|
1315
|
-
method: 'POST',
|
|
1316
|
-
comment: 'Validates a record field',
|
|
1317
|
-
requestBodyType: 'ItemValidateNewSchema',
|
|
1318
|
-
simpleMethodAvailable: true,
|
|
1319
|
-
requestStructure: {
|
|
1320
|
-
type: 'item',
|
|
1321
|
-
attributes: '*',
|
|
1322
|
-
relationships: ['item_type'],
|
|
1323
|
-
},
|
|
1324
|
-
deprecated:
|
|
1325
|
-
'This API call is to be considered private and might change without notice',
|
|
1326
|
-
},
|
|
1327
|
-
{
|
|
1328
|
-
returnsCollection: false,
|
|
1329
|
-
docUrl:
|
|
1330
|
-
'https://www.datocms.com/docs/content-management-api/resources/item/create',
|
|
1331
|
-
name: 'create',
|
|
1332
|
-
rawName: 'rawCreate',
|
|
1333
|
-
urlTemplate: '/items',
|
|
1334
|
-
method: 'POST',
|
|
1335
|
-
comment: 'Create a new record',
|
|
1336
|
-
requestBodyType: 'ItemCreateSchema',
|
|
1337
|
-
simpleMethodAvailable: true,
|
|
1338
|
-
requestStructure: {
|
|
1339
|
-
type: 'item',
|
|
1340
|
-
attributes: '*',
|
|
1341
|
-
relationships: ['item_type'],
|
|
1342
|
-
},
|
|
1343
|
-
responseType: 'ItemCreateTargetSchema',
|
|
1344
|
-
},
|
|
1345
|
-
{
|
|
1346
|
-
returnsCollection: false,
|
|
1347
|
-
docUrl:
|
|
1348
|
-
'https://www.datocms.com/docs/content-management-api/resources/item/duplicate',
|
|
1349
|
-
name: 'duplicate',
|
|
1350
|
-
rawName: 'rawDuplicate',
|
|
1351
|
-
urlTemplate: '/items/${itemId}/duplicate',
|
|
1352
|
-
method: 'POST',
|
|
1353
|
-
comment: 'Duplicate a record',
|
|
1354
|
-
urlPlaceholder: {
|
|
1355
|
-
variableName: 'itemId',
|
|
1356
|
-
isEntityId: true,
|
|
1357
|
-
relType: 'ItemData',
|
|
1358
|
-
},
|
|
1359
|
-
simpleMethodAvailable: true,
|
|
1360
|
-
responseType: 'ItemDuplicateJobSchema',
|
|
1361
|
-
},
|
|
1362
|
-
{
|
|
1363
|
-
returnsCollection: false,
|
|
1364
|
-
docUrl:
|
|
1365
|
-
'https://www.datocms.com/docs/content-management-api/resources/item/update',
|
|
1366
|
-
name: 'update',
|
|
1367
|
-
rawName: 'rawUpdate',
|
|
1368
|
-
urlTemplate: '/items/${itemId}',
|
|
1369
|
-
method: 'PUT',
|
|
1370
|
-
comment: 'Update a record',
|
|
1371
|
-
urlPlaceholder: {
|
|
1372
|
-
variableName: 'itemId',
|
|
1373
|
-
isEntityId: true,
|
|
1374
|
-
relType: 'ItemData',
|
|
1375
|
-
},
|
|
1376
|
-
requestBodyType: 'ItemUpdateSchema',
|
|
1377
|
-
simpleMethodAvailable: true,
|
|
1378
|
-
requestStructure: {
|
|
1379
|
-
type: 'item',
|
|
1380
|
-
attributes: '*',
|
|
1381
|
-
relationships: ['item_type', 'creator'],
|
|
1382
|
-
},
|
|
1383
|
-
responseType: 'ItemUpdateTargetSchema',
|
|
1384
|
-
},
|
|
1385
|
-
{
|
|
1386
|
-
returnsCollection: false,
|
|
1387
|
-
docUrl:
|
|
1388
|
-
'https://www.datocms.com/docs/content-management-api/resources/item/references',
|
|
1389
|
-
name: 'references',
|
|
1390
|
-
rawName: 'rawReferences',
|
|
1391
|
-
urlTemplate: '/items/${itemId}/references',
|
|
1392
|
-
method: 'GET',
|
|
1393
|
-
comment: 'Referenced records',
|
|
1394
|
-
urlPlaceholder: {
|
|
1395
|
-
variableName: 'itemId',
|
|
1396
|
-
isEntityId: true,
|
|
1397
|
-
relType: 'ItemData',
|
|
1398
|
-
},
|
|
1399
|
-
simpleMethodAvailable: true,
|
|
1400
|
-
queryParamsType: 'ItemReferencesHrefSchema',
|
|
1401
|
-
responseType: 'ItemReferencesTargetSchema',
|
|
1402
|
-
},
|
|
1403
|
-
{
|
|
1404
|
-
returnsCollection: false,
|
|
1405
|
-
docUrl:
|
|
1406
|
-
'https://www.datocms.com/docs/content-management-api/resources/item/self',
|
|
1407
|
-
name: 'find',
|
|
1408
|
-
rawName: 'rawFind',
|
|
1409
|
-
urlTemplate: '/items/${itemId}',
|
|
1410
|
-
method: 'GET',
|
|
1411
|
-
comment: 'Retrieve a record',
|
|
1412
|
-
urlPlaceholder: {
|
|
1413
|
-
variableName: 'itemId',
|
|
1414
|
-
isEntityId: true,
|
|
1415
|
-
relType: 'ItemData',
|
|
1416
|
-
},
|
|
1417
|
-
simpleMethodAvailable: true,
|
|
1418
|
-
queryParamsType: 'ItemSelfHrefSchema',
|
|
1419
|
-
responseType: 'ItemSelfTargetSchema',
|
|
1420
|
-
},
|
|
1421
|
-
{
|
|
1422
|
-
returnsCollection: false,
|
|
1423
|
-
docUrl:
|
|
1424
|
-
'https://www.datocms.com/docs/content-management-api/resources/item/destroy',
|
|
1425
|
-
name: 'destroy',
|
|
1426
|
-
rawName: 'rawDestroy',
|
|
1427
|
-
urlTemplate: '/items/${itemId}',
|
|
1428
|
-
method: 'DELETE',
|
|
1429
|
-
comment: 'Delete a record',
|
|
1430
|
-
urlPlaceholder: {
|
|
1431
|
-
variableName: 'itemId',
|
|
1432
|
-
isEntityId: true,
|
|
1433
|
-
relType: 'ItemData',
|
|
1434
|
-
},
|
|
1435
|
-
simpleMethodAvailable: true,
|
|
1436
|
-
responseType: 'ItemDestroyJobSchema',
|
|
1437
|
-
},
|
|
1438
|
-
{
|
|
1439
|
-
returnsCollection: false,
|
|
1440
|
-
docUrl:
|
|
1441
|
-
'https://www.datocms.com/docs/content-management-api/resources/item/batch_destroy',
|
|
1442
|
-
name: 'batchDestroy',
|
|
1443
|
-
rawName: 'rawBatchDestroy',
|
|
1444
|
-
urlTemplate: '/items',
|
|
1445
|
-
method: 'DELETE',
|
|
1446
|
-
comment: 'Delete multiple records',
|
|
1447
|
-
simpleMethodAvailable: true,
|
|
1448
|
-
queryParamsType: 'ItemBatchDestroyHrefSchema',
|
|
1449
|
-
responseType: 'ItemBatchDestroyJobSchema',
|
|
1450
|
-
deprecated:
|
|
1451
|
-
'This API call is to be considered private and might change without notice',
|
|
1452
|
-
},
|
|
1453
|
-
{
|
|
1454
|
-
returnsCollection: false,
|
|
1455
|
-
docUrl:
|
|
1456
|
-
'https://www.datocms.com/docs/content-management-api/resources/item/batch_publish',
|
|
1457
|
-
name: 'batchPublish',
|
|
1458
|
-
rawName: 'rawBatchPublish',
|
|
1459
|
-
urlTemplate: '/items/publish',
|
|
1460
|
-
method: 'PUT',
|
|
1461
|
-
comment: 'Publish multiple records',
|
|
1462
|
-
simpleMethodAvailable: true,
|
|
1463
|
-
queryParamsType: 'ItemBatchPublishHrefSchema',
|
|
1464
|
-
responseType: 'ItemBatchPublishJobSchema',
|
|
1465
|
-
deprecated:
|
|
1466
|
-
'This API call is to be considered private and might change without notice',
|
|
1467
|
-
},
|
|
1468
|
-
{
|
|
1469
|
-
returnsCollection: false,
|
|
1470
|
-
docUrl:
|
|
1471
|
-
'https://www.datocms.com/docs/content-management-api/resources/item/batch_unpublish',
|
|
1472
|
-
name: 'batchUnpublish',
|
|
1473
|
-
rawName: 'rawBatchUnpublish',
|
|
1474
|
-
urlTemplate: '/items/unpublish',
|
|
1475
|
-
method: 'PUT',
|
|
1476
|
-
comment: 'Unpublish multiple records',
|
|
1477
|
-
simpleMethodAvailable: true,
|
|
1478
|
-
queryParamsType: 'ItemBatchUnpublishHrefSchema',
|
|
1479
|
-
responseType: 'ItemBatchUnpublishJobSchema',
|
|
1480
|
-
deprecated:
|
|
1481
|
-
'This API call is to be considered private and might change without notice',
|
|
1482
|
-
},
|
|
1483
|
-
{
|
|
1484
|
-
returnsCollection: false,
|
|
1485
|
-
docUrl:
|
|
1486
|
-
'https://www.datocms.com/docs/content-management-api/resources/item/publish',
|
|
1487
|
-
name: 'publish',
|
|
1488
|
-
rawName: 'rawPublish',
|
|
1489
|
-
urlTemplate: '/items/${itemId}/publish',
|
|
1490
|
-
method: 'PUT',
|
|
1491
|
-
comment: 'Publish a record',
|
|
1492
|
-
urlPlaceholder: {
|
|
1493
|
-
variableName: 'itemId',
|
|
1494
|
-
isEntityId: true,
|
|
1495
|
-
relType: 'ItemData',
|
|
1496
|
-
},
|
|
1497
|
-
simpleMethodAvailable: true,
|
|
1498
|
-
queryParamsType: 'ItemPublishHrefSchema',
|
|
1499
|
-
responseType: 'ItemPublishTargetSchema',
|
|
1500
|
-
},
|
|
1501
|
-
{
|
|
1502
|
-
returnsCollection: false,
|
|
1503
|
-
docUrl:
|
|
1504
|
-
'https://www.datocms.com/docs/content-management-api/resources/item/unpublish',
|
|
1505
|
-
name: 'unpublish',
|
|
1506
|
-
rawName: 'rawUnpublish',
|
|
1507
|
-
urlTemplate: '/items/${itemId}/unpublish',
|
|
1508
|
-
method: 'PUT',
|
|
1509
|
-
comment: 'Unpublish a record',
|
|
1510
|
-
urlPlaceholder: {
|
|
1511
|
-
variableName: 'itemId',
|
|
1512
|
-
isEntityId: true,
|
|
1513
|
-
relType: 'ItemData',
|
|
1514
|
-
},
|
|
1515
|
-
simpleMethodAvailable: true,
|
|
1516
|
-
queryParamsType: 'ItemUnpublishHrefSchema',
|
|
1517
|
-
responseType: 'ItemUnpublishTargetSchema',
|
|
1518
|
-
},
|
|
1519
|
-
{
|
|
1520
|
-
returnsCollection: false,
|
|
1521
|
-
docUrl:
|
|
1522
|
-
'https://www.datocms.com/docs/content-management-api/resources/item/bulk_publish',
|
|
1523
|
-
name: 'bulkPublish',
|
|
1524
|
-
rawName: 'rawBulkPublish',
|
|
1525
|
-
urlTemplate: '/items/bulk/publish',
|
|
1526
|
-
method: 'POST',
|
|
1527
|
-
comment: 'Publish items in bulk',
|
|
1528
|
-
requestBodyType: 'ItemBulkPublishSchema',
|
|
1529
|
-
simpleMethodAvailable: true,
|
|
1530
|
-
requestStructure: {
|
|
1531
|
-
type: 'item_bulk_publish_operation',
|
|
1532
|
-
attributes: [],
|
|
1533
|
-
relationships: ['items'],
|
|
1534
|
-
},
|
|
1535
|
-
responseType: 'ItemBulkPublishJobSchema',
|
|
1536
|
-
},
|
|
1537
|
-
{
|
|
1538
|
-
returnsCollection: false,
|
|
1539
|
-
docUrl:
|
|
1540
|
-
'https://www.datocms.com/docs/content-management-api/resources/item/bulk_unpublish',
|
|
1541
|
-
name: 'bulkUnpublish',
|
|
1542
|
-
rawName: 'rawBulkUnpublish',
|
|
1543
|
-
urlTemplate: '/items/bulk/unpublish',
|
|
1544
|
-
method: 'POST',
|
|
1545
|
-
comment: 'Unpublish items in bulk',
|
|
1546
|
-
requestBodyType: 'ItemBulkUnpublishSchema',
|
|
1547
|
-
simpleMethodAvailable: true,
|
|
1548
|
-
requestStructure: {
|
|
1549
|
-
type: 'item_bulk_unpublish_operation',
|
|
1550
|
-
attributes: [],
|
|
1551
|
-
relationships: ['items'],
|
|
1552
|
-
},
|
|
1553
|
-
responseType: 'ItemBulkUnpublishJobSchema',
|
|
1554
|
-
},
|
|
1555
|
-
{
|
|
1556
|
-
returnsCollection: false,
|
|
1557
|
-
docUrl:
|
|
1558
|
-
'https://www.datocms.com/docs/content-management-api/resources/item/bulk_destroy',
|
|
1559
|
-
name: 'bulkDestroy',
|
|
1560
|
-
rawName: 'rawBulkDestroy',
|
|
1561
|
-
urlTemplate: '/items/bulk/destroy',
|
|
1562
|
-
method: 'POST',
|
|
1563
|
-
comment: 'Destroy items in bulk',
|
|
1564
|
-
requestBodyType: 'ItemBulkDestroySchema',
|
|
1565
|
-
simpleMethodAvailable: true,
|
|
1566
|
-
requestStructure: {
|
|
1567
|
-
type: 'item_bulk_destroy_operation',
|
|
1568
|
-
attributes: [],
|
|
1569
|
-
relationships: ['items'],
|
|
1570
|
-
},
|
|
1571
|
-
responseType: 'ItemBulkDestroyJobSchema',
|
|
1572
|
-
},
|
|
1573
|
-
{
|
|
1574
|
-
returnsCollection: false,
|
|
1575
|
-
docUrl:
|
|
1576
|
-
'https://www.datocms.com/docs/content-management-api/resources/item/bulk_move_to_stage',
|
|
1577
|
-
name: 'bulkMoveToStage',
|
|
1578
|
-
rawName: 'rawBulkMoveToStage',
|
|
1579
|
-
urlTemplate: '/items/bulk/move-to-stage',
|
|
1580
|
-
method: 'POST',
|
|
1581
|
-
comment: 'Move items to stage in bulk',
|
|
1582
|
-
requestBodyType: 'ItemBulkMoveToStageSchema',
|
|
1583
|
-
simpleMethodAvailable: true,
|
|
1584
|
-
requestStructure: {
|
|
1585
|
-
type: 'item_bulk_move_to_stage_operation',
|
|
1586
|
-
attributes: ['stage'],
|
|
1587
|
-
relationships: ['items'],
|
|
1588
|
-
},
|
|
1589
|
-
responseType: 'ItemBulkMoveToStageJobSchema',
|
|
1590
|
-
},
|
|
1591
|
-
],
|
|
1592
|
-
namespace: 'items',
|
|
1593
|
-
resourceClassName: 'Item',
|
|
1594
|
-
},
|
|
1595
|
-
{
|
|
1596
|
-
jsonApiType: 'item_version',
|
|
1597
|
-
endpoints: [
|
|
1598
|
-
{
|
|
1599
|
-
returnsCollection: false,
|
|
1600
|
-
docUrl:
|
|
1601
|
-
'https://www.datocms.com/docs/content-management-api/resources/item-version/restore',
|
|
1602
|
-
name: 'restore',
|
|
1603
|
-
rawName: 'rawRestore',
|
|
1604
|
-
urlTemplate: '/versions/${itemVersionId}/restore',
|
|
1605
|
-
method: 'POST',
|
|
1606
|
-
comment: 'Restore an old record version',
|
|
1607
|
-
urlPlaceholder: {
|
|
1608
|
-
variableName: 'itemVersionId',
|
|
1609
|
-
isEntityId: true,
|
|
1610
|
-
relType: 'ItemVersionData',
|
|
1611
|
-
},
|
|
1612
|
-
simpleMethodAvailable: true,
|
|
1613
|
-
responseType: 'ItemVersionRestoreJobSchema',
|
|
1614
|
-
},
|
|
1615
|
-
{
|
|
1616
|
-
returnsCollection: true,
|
|
1617
|
-
docUrl:
|
|
1618
|
-
'https://www.datocms.com/docs/content-management-api/resources/item-version/instances',
|
|
1619
|
-
name: 'list',
|
|
1620
|
-
rawName: 'rawList',
|
|
1621
|
-
urlTemplate: '/items/${itemId}/versions',
|
|
1622
|
-
method: 'GET',
|
|
1623
|
-
comment: 'List all record versions',
|
|
1624
|
-
urlPlaceholder: {
|
|
1625
|
-
variableName: 'itemId',
|
|
1626
|
-
isEntityId: false,
|
|
1627
|
-
relType: 'ItemData',
|
|
1628
|
-
},
|
|
1629
|
-
simpleMethodAvailable: true,
|
|
1630
|
-
queryParamsType: 'ItemVersionInstancesHrefSchema',
|
|
1631
|
-
responseType: 'ItemVersionInstancesTargetSchema',
|
|
1632
|
-
paginatedResponse: {
|
|
1633
|
-
defaultLimit: 15,
|
|
1634
|
-
maxLimit: 50,
|
|
1635
|
-
},
|
|
1636
|
-
},
|
|
1637
|
-
{
|
|
1638
|
-
returnsCollection: false,
|
|
1639
|
-
docUrl:
|
|
1640
|
-
'https://www.datocms.com/docs/content-management-api/resources/item-version/self',
|
|
1641
|
-
name: 'find',
|
|
1642
|
-
rawName: 'rawFind',
|
|
1643
|
-
urlTemplate: '/versions/${itemVersionId}',
|
|
1644
|
-
method: 'GET',
|
|
1645
|
-
comment: 'Retrieve a record version',
|
|
1646
|
-
urlPlaceholder: {
|
|
1647
|
-
variableName: 'itemVersionId',
|
|
1648
|
-
isEntityId: true,
|
|
1649
|
-
relType: 'ItemVersionData',
|
|
1650
|
-
},
|
|
1651
|
-
simpleMethodAvailable: true,
|
|
1652
|
-
responseType: 'ItemVersionSelfTargetSchema',
|
|
1653
|
-
},
|
|
1654
|
-
],
|
|
1655
|
-
namespace: 'itemVersions',
|
|
1656
|
-
resourceClassName: 'ItemVersion',
|
|
1657
|
-
},
|
|
1658
|
-
{
|
|
1659
|
-
jsonApiType: 'upload',
|
|
1660
|
-
endpoints: [
|
|
1661
|
-
{
|
|
1662
|
-
returnsCollection: false,
|
|
1663
|
-
docUrl:
|
|
1664
|
-
'https://www.datocms.com/docs/content-management-api/resources/upload/create',
|
|
1665
|
-
name: 'create',
|
|
1666
|
-
rawName: 'rawCreate',
|
|
1667
|
-
urlTemplate: '/uploads',
|
|
1668
|
-
method: 'POST',
|
|
1669
|
-
comment: 'Create a new upload',
|
|
1670
|
-
requestBodyType: 'UploadCreateSchema',
|
|
1671
|
-
simpleMethodAvailable: true,
|
|
1672
|
-
requestStructure: {
|
|
1673
|
-
type: 'upload',
|
|
1674
|
-
attributes: [
|
|
1675
|
-
'path',
|
|
1676
|
-
'copyright',
|
|
1677
|
-
'author',
|
|
1678
|
-
'notes',
|
|
1679
|
-
'default_field_metadata',
|
|
1680
|
-
'tags',
|
|
1681
|
-
],
|
|
1682
|
-
relationships: [],
|
|
1683
|
-
},
|
|
1684
|
-
responseType: 'UploadCreateJobSchema',
|
|
1685
|
-
},
|
|
1686
|
-
{
|
|
1687
|
-
returnsCollection: true,
|
|
1688
|
-
docUrl:
|
|
1689
|
-
'https://www.datocms.com/docs/content-management-api/resources/upload/instances',
|
|
1690
|
-
name: 'list',
|
|
1691
|
-
rawName: 'rawList',
|
|
1692
|
-
urlTemplate: '/uploads',
|
|
1693
|
-
method: 'GET',
|
|
1694
|
-
comment: 'List all uploads',
|
|
1695
|
-
simpleMethodAvailable: true,
|
|
1696
|
-
queryParamsType: 'UploadInstancesHrefSchema',
|
|
1697
|
-
responseType: 'UploadInstancesTargetSchema',
|
|
1698
|
-
paginatedResponse: {
|
|
1699
|
-
defaultLimit: 30,
|
|
1700
|
-
maxLimit: 500,
|
|
1701
|
-
},
|
|
1702
|
-
},
|
|
1703
|
-
{
|
|
1704
|
-
returnsCollection: false,
|
|
1705
|
-
docUrl:
|
|
1706
|
-
'https://www.datocms.com/docs/content-management-api/resources/upload/self',
|
|
1707
|
-
name: 'find',
|
|
1708
|
-
rawName: 'rawFind',
|
|
1709
|
-
urlTemplate: '/uploads/${uploadId}',
|
|
1710
|
-
method: 'GET',
|
|
1711
|
-
comment: 'Retrieve an upload',
|
|
1712
|
-
urlPlaceholder: {
|
|
1713
|
-
variableName: 'uploadId',
|
|
1714
|
-
isEntityId: true,
|
|
1715
|
-
relType: 'UploadData',
|
|
1716
|
-
},
|
|
1717
|
-
simpleMethodAvailable: true,
|
|
1718
|
-
responseType: 'UploadSelfTargetSchema',
|
|
1719
|
-
},
|
|
1720
|
-
{
|
|
1721
|
-
returnsCollection: false,
|
|
1722
|
-
docUrl:
|
|
1723
|
-
'https://www.datocms.com/docs/content-management-api/resources/upload/destroy',
|
|
1724
|
-
name: 'destroy',
|
|
1725
|
-
rawName: 'rawDestroy',
|
|
1726
|
-
urlTemplate: '/uploads/${uploadId}',
|
|
1727
|
-
method: 'DELETE',
|
|
1728
|
-
comment: 'Delete an upload',
|
|
1729
|
-
urlPlaceholder: {
|
|
1730
|
-
variableName: 'uploadId',
|
|
1731
|
-
isEntityId: true,
|
|
1732
|
-
relType: 'UploadData',
|
|
1733
|
-
},
|
|
1734
|
-
simpleMethodAvailable: true,
|
|
1735
|
-
responseType: 'UploadDestroyTargetSchema',
|
|
1736
|
-
},
|
|
1737
|
-
{
|
|
1738
|
-
returnsCollection: false,
|
|
1739
|
-
docUrl:
|
|
1740
|
-
'https://www.datocms.com/docs/content-management-api/resources/upload/update',
|
|
1741
|
-
name: 'update',
|
|
1742
|
-
rawName: 'rawUpdate',
|
|
1743
|
-
urlTemplate: '/uploads/${uploadId}',
|
|
1744
|
-
method: 'PUT',
|
|
1745
|
-
comment: 'Update an upload',
|
|
1746
|
-
urlPlaceholder: {
|
|
1747
|
-
variableName: 'uploadId',
|
|
1748
|
-
isEntityId: true,
|
|
1749
|
-
relType: 'UploadData',
|
|
1750
|
-
},
|
|
1751
|
-
requestBodyType: 'UploadUpdateSchema',
|
|
1752
|
-
simpleMethodAvailable: true,
|
|
1753
|
-
requestStructure: {
|
|
1754
|
-
type: 'upload',
|
|
1755
|
-
attributes: [
|
|
1756
|
-
'path',
|
|
1757
|
-
'basename',
|
|
1758
|
-
'copyright',
|
|
1759
|
-
'author',
|
|
1760
|
-
'notes',
|
|
1761
|
-
'tags',
|
|
1762
|
-
'default_field_metadata',
|
|
1763
|
-
],
|
|
1764
|
-
relationships: ['creator'],
|
|
1765
|
-
},
|
|
1766
|
-
responseType: 'UploadUpdateJobSchema',
|
|
1767
|
-
},
|
|
1768
|
-
{
|
|
1769
|
-
returnsCollection: false,
|
|
1770
|
-
docUrl:
|
|
1771
|
-
'https://www.datocms.com/docs/content-management-api/resources/upload/batch_add_tags',
|
|
1772
|
-
name: 'batchAddTags',
|
|
1773
|
-
rawName: 'rawBatchAddTags',
|
|
1774
|
-
urlTemplate: '/uploads/batch-add-tags',
|
|
1775
|
-
method: 'PUT',
|
|
1776
|
-
comment: 'Batch add tags to uploads',
|
|
1777
|
-
requestBodyType: 'UploadBatchAddTagsSchema',
|
|
1778
|
-
simpleMethodAvailable: true,
|
|
1779
|
-
requestStructure: {
|
|
1780
|
-
type: 'upload',
|
|
1781
|
-
attributes: ['tags'],
|
|
1782
|
-
relationships: [],
|
|
1783
|
-
},
|
|
1784
|
-
queryParamsType: 'UploadBatchAddTagsHrefSchema',
|
|
1785
|
-
responseType: 'UploadBatchAddTagsJobSchema',
|
|
1786
|
-
deprecated:
|
|
1787
|
-
'This API call is to be considered private and might change without notice',
|
|
1788
|
-
},
|
|
1789
|
-
{
|
|
1790
|
-
returnsCollection: false,
|
|
1791
|
-
docUrl:
|
|
1792
|
-
'https://www.datocms.com/docs/content-management-api/resources/upload/batch_destroy',
|
|
1793
|
-
name: 'batchDestroy',
|
|
1794
|
-
rawName: 'rawBatchDestroy',
|
|
1795
|
-
urlTemplate: '/uploads/batch-destroy',
|
|
1796
|
-
method: 'DELETE',
|
|
1797
|
-
comment: 'Delete multiple uploads',
|
|
1798
|
-
simpleMethodAvailable: true,
|
|
1799
|
-
queryParamsType: 'UploadBatchDestroyHrefSchema',
|
|
1800
|
-
responseType: 'UploadBatchDestroyJobSchema',
|
|
1801
|
-
deprecated:
|
|
1802
|
-
'This API call is to be considered private and might change without notice',
|
|
1803
|
-
},
|
|
1804
|
-
{
|
|
1805
|
-
returnsCollection: false,
|
|
1806
|
-
docUrl:
|
|
1807
|
-
'https://www.datocms.com/docs/content-management-api/resources/upload/references',
|
|
1808
|
-
name: 'references',
|
|
1809
|
-
rawName: 'rawReferences',
|
|
1810
|
-
urlTemplate: '/uploads/${uploadId}/references',
|
|
1811
|
-
method: 'GET',
|
|
1812
|
-
comment: 'Referenced records',
|
|
1813
|
-
urlPlaceholder: {
|
|
1814
|
-
variableName: 'uploadId',
|
|
1815
|
-
isEntityId: true,
|
|
1816
|
-
relType: 'UploadData',
|
|
1817
|
-
},
|
|
1818
|
-
simpleMethodAvailable: true,
|
|
1819
|
-
queryParamsType: 'UploadReferencesHrefSchema',
|
|
1820
|
-
responseType: 'UploadReferencesTargetSchema',
|
|
1821
|
-
},
|
|
1822
|
-
{
|
|
1823
|
-
returnsCollection: false,
|
|
1824
|
-
docUrl:
|
|
1825
|
-
'https://www.datocms.com/docs/content-management-api/resources/upload/bulk_tag',
|
|
1826
|
-
name: 'bulkTag',
|
|
1827
|
-
rawName: 'rawBulkTag',
|
|
1828
|
-
urlTemplate: '/uploads/bulk/tag',
|
|
1829
|
-
method: 'POST',
|
|
1830
|
-
comment: 'Add tags to assets in bulk',
|
|
1831
|
-
requestBodyType: 'UploadBulkTagSchema',
|
|
1832
|
-
simpleMethodAvailable: true,
|
|
1833
|
-
requestStructure: {
|
|
1834
|
-
type: 'upload_bulk_tag_operation',
|
|
1835
|
-
attributes: ['tags'],
|
|
1836
|
-
relationships: ['uploads'],
|
|
1837
|
-
},
|
|
1838
|
-
responseType: 'UploadBulkTagJobSchema',
|
|
1839
|
-
},
|
|
1840
|
-
{
|
|
1841
|
-
returnsCollection: false,
|
|
1842
|
-
docUrl:
|
|
1843
|
-
'https://www.datocms.com/docs/content-management-api/resources/upload/bulk_destroy',
|
|
1844
|
-
name: 'bulkDestroy',
|
|
1845
|
-
rawName: 'rawBulkDestroy',
|
|
1846
|
-
urlTemplate: '/uploads/bulk/destroy',
|
|
1847
|
-
method: 'POST',
|
|
1848
|
-
comment: 'Destroy uploads',
|
|
1849
|
-
requestBodyType: 'UploadBulkDestroySchema',
|
|
1850
|
-
simpleMethodAvailable: true,
|
|
1851
|
-
requestStructure: {
|
|
1852
|
-
type: 'upload_bulk_destroy_operation',
|
|
1853
|
-
attributes: [],
|
|
1854
|
-
relationships: ['uploads'],
|
|
1855
|
-
},
|
|
1856
|
-
responseType: 'UploadBulkDestroyJobSchema',
|
|
1857
|
-
},
|
|
1858
|
-
],
|
|
1859
|
-
namespace: 'uploads',
|
|
1860
|
-
resourceClassName: 'Upload',
|
|
1861
|
-
},
|
|
1862
|
-
{
|
|
1863
|
-
jsonApiType: 'upload_request',
|
|
1864
|
-
endpoints: [
|
|
1865
|
-
{
|
|
1866
|
-
returnsCollection: false,
|
|
1867
|
-
docUrl:
|
|
1868
|
-
'https://www.datocms.com/docs/content-management-api/resources/upload-request/create',
|
|
1869
|
-
name: 'create',
|
|
1870
|
-
rawName: 'rawCreate',
|
|
1871
|
-
urlTemplate: '/upload-requests',
|
|
1872
|
-
method: 'POST',
|
|
1873
|
-
comment: 'Request a new upload',
|
|
1874
|
-
requestBodyType: 'UploadRequestCreateSchema',
|
|
1875
|
-
simpleMethodAvailable: true,
|
|
1876
|
-
requestStructure: {
|
|
1877
|
-
type: 'upload_request',
|
|
1878
|
-
attributes: ['filename'],
|
|
1879
|
-
relationships: [],
|
|
1880
|
-
},
|
|
1881
|
-
responseType: 'UploadRequestCreateTargetSchema',
|
|
1882
|
-
},
|
|
1883
|
-
],
|
|
1884
|
-
namespace: 'uploadRequest',
|
|
1885
|
-
resourceClassName: 'UploadRequest',
|
|
1886
|
-
},
|
|
1887
|
-
{
|
|
1888
|
-
jsonApiType: 'scheduled_publication',
|
|
1889
|
-
endpoints: [
|
|
1890
|
-
{
|
|
1891
|
-
returnsCollection: false,
|
|
1892
|
-
docUrl:
|
|
1893
|
-
'https://www.datocms.com/docs/content-management-api/resources/scheduled-publication/create',
|
|
1894
|
-
name: 'create',
|
|
1895
|
-
rawName: 'rawCreate',
|
|
1896
|
-
urlTemplate: '/items/${itemId}/scheduled-publication',
|
|
1897
|
-
method: 'POST',
|
|
1898
|
-
comment: 'Create a new scheduled publication',
|
|
1899
|
-
urlPlaceholder: {
|
|
1900
|
-
variableName: 'itemId',
|
|
1901
|
-
isEntityId: false,
|
|
1902
|
-
relType: 'ItemData',
|
|
1903
|
-
},
|
|
1904
|
-
requestBodyType: 'ScheduledPublicationCreateSchema',
|
|
1905
|
-
simpleMethodAvailable: true,
|
|
1906
|
-
requestStructure: {
|
|
1907
|
-
type: 'scheduled_publication',
|
|
1908
|
-
attributes: ['publication_scheduled_at'],
|
|
1909
|
-
relationships: [],
|
|
1910
|
-
},
|
|
1911
|
-
responseType: 'ScheduledPublicationCreateTargetSchema',
|
|
1912
|
-
},
|
|
1913
|
-
{
|
|
1914
|
-
returnsCollection: false,
|
|
1915
|
-
docUrl:
|
|
1916
|
-
'https://www.datocms.com/docs/content-management-api/resources/scheduled-publication/destroy',
|
|
1917
|
-
name: 'destroy',
|
|
1918
|
-
rawName: 'rawDestroy',
|
|
1919
|
-
urlTemplate: '/items/${itemId}/scheduled-publication',
|
|
1920
|
-
method: 'DELETE',
|
|
1921
|
-
comment: 'Delete a scheduled publication',
|
|
1922
|
-
urlPlaceholder: {
|
|
1923
|
-
variableName: 'itemId',
|
|
1924
|
-
isEntityId: false,
|
|
1925
|
-
relType: 'ItemData',
|
|
1926
|
-
},
|
|
1927
|
-
simpleMethodAvailable: true,
|
|
1928
|
-
responseType: 'ScheduledPublicationDestroyTargetSchema',
|
|
1929
|
-
},
|
|
1930
|
-
],
|
|
1931
|
-
namespace: 'scheduledPublication',
|
|
1932
|
-
resourceClassName: 'ScheduledPublication',
|
|
1933
|
-
},
|
|
1934
|
-
{
|
|
1935
|
-
jsonApiType: 'scheduled_unpublishing',
|
|
1936
|
-
endpoints: [
|
|
1937
|
-
{
|
|
1938
|
-
returnsCollection: false,
|
|
1939
|
-
docUrl:
|
|
1940
|
-
'https://www.datocms.com/docs/content-management-api/resources/scheduled-unpublishing/create',
|
|
1941
|
-
name: 'create',
|
|
1942
|
-
rawName: 'rawCreate',
|
|
1943
|
-
urlTemplate: '/items/${itemId}/scheduled-unpublishing',
|
|
1944
|
-
method: 'POST',
|
|
1945
|
-
comment: 'Create a new scheduled unpublishing',
|
|
1946
|
-
urlPlaceholder: {
|
|
1947
|
-
variableName: 'itemId',
|
|
1948
|
-
isEntityId: false,
|
|
1949
|
-
relType: 'ItemData',
|
|
1950
|
-
},
|
|
1951
|
-
requestBodyType: 'ScheduledUnpublishingCreateSchema',
|
|
1952
|
-
simpleMethodAvailable: true,
|
|
1953
|
-
requestStructure: {
|
|
1954
|
-
type: 'scheduled_unpublishing',
|
|
1955
|
-
attributes: ['unpublishing_scheduled_at'],
|
|
1956
|
-
relationships: [],
|
|
1957
|
-
},
|
|
1958
|
-
responseType: 'ScheduledUnpublishingCreateTargetSchema',
|
|
1959
|
-
},
|
|
1960
|
-
{
|
|
1961
|
-
returnsCollection: false,
|
|
1962
|
-
docUrl:
|
|
1963
|
-
'https://www.datocms.com/docs/content-management-api/resources/scheduled-unpublishing/destroy',
|
|
1964
|
-
name: 'destroy',
|
|
1965
|
-
rawName: 'rawDestroy',
|
|
1966
|
-
urlTemplate: '/items/${itemId}/scheduled-unpublishing',
|
|
1967
|
-
method: 'DELETE',
|
|
1968
|
-
comment: 'Delete a scheduled unpublishing',
|
|
1969
|
-
urlPlaceholder: {
|
|
1970
|
-
variableName: 'itemId',
|
|
1971
|
-
isEntityId: false,
|
|
1972
|
-
relType: 'ItemData',
|
|
1973
|
-
},
|
|
1974
|
-
simpleMethodAvailable: true,
|
|
1975
|
-
responseType: 'ScheduledUnpublishingDestroyTargetSchema',
|
|
1976
|
-
},
|
|
1977
|
-
],
|
|
1978
|
-
namespace: 'scheduledUnpublishing',
|
|
1979
|
-
resourceClassName: 'ScheduledUnpublishing',
|
|
1980
|
-
},
|
|
1981
|
-
{
|
|
1982
|
-
jsonApiType: 'search_result',
|
|
1983
|
-
endpoints: [
|
|
1984
|
-
{
|
|
1985
|
-
returnsCollection: true,
|
|
1986
|
-
docUrl:
|
|
1987
|
-
'https://www.datocms.com/docs/content-management-api/resources/search-result/instances',
|
|
1988
|
-
name: 'list',
|
|
1989
|
-
rawName: 'rawList',
|
|
1990
|
-
urlTemplate: '/search-results',
|
|
1991
|
-
method: 'GET',
|
|
1992
|
-
comment: 'Search for results',
|
|
1993
|
-
simpleMethodAvailable: true,
|
|
1994
|
-
queryParamsType: 'SearchResultInstancesHrefSchema',
|
|
1995
|
-
responseType: 'SearchResultInstancesTargetSchema',
|
|
1996
|
-
},
|
|
1997
|
-
],
|
|
1998
|
-
namespace: 'searchResults',
|
|
1999
|
-
resourceClassName: 'SearchResult',
|
|
2000
|
-
},
|
|
2001
|
-
{
|
|
2002
|
-
jsonApiType: 'environment',
|
|
2003
|
-
endpoints: [
|
|
2004
|
-
{
|
|
2005
|
-
returnsCollection: false,
|
|
2006
|
-
docUrl:
|
|
2007
|
-
'https://www.datocms.com/docs/content-management-api/resources/environment/fork',
|
|
2008
|
-
name: 'fork',
|
|
2009
|
-
rawName: 'rawFork',
|
|
2010
|
-
urlTemplate: '/environments/${environmentId}/fork',
|
|
2011
|
-
method: 'POST',
|
|
2012
|
-
comment: 'Fork an existing environment',
|
|
2013
|
-
urlPlaceholder: {
|
|
2014
|
-
variableName: 'environmentId',
|
|
2015
|
-
isEntityId: true,
|
|
2016
|
-
relType: 'EnvironmentData',
|
|
2017
|
-
},
|
|
2018
|
-
requestBodyType: 'EnvironmentForkSchema',
|
|
2019
|
-
simpleMethodAvailable: true,
|
|
2020
|
-
requestStructure: {
|
|
2021
|
-
type: 'environment',
|
|
2022
|
-
attributes: [],
|
|
2023
|
-
relationships: [],
|
|
2024
|
-
},
|
|
2025
|
-
responseType: 'EnvironmentForkJobSchema',
|
|
2026
|
-
},
|
|
2027
|
-
{
|
|
2028
|
-
returnsCollection: false,
|
|
2029
|
-
docUrl:
|
|
2030
|
-
'https://www.datocms.com/docs/content-management-api/resources/environment/promote',
|
|
2031
|
-
name: 'promote',
|
|
2032
|
-
rawName: 'rawPromote',
|
|
2033
|
-
urlTemplate: '/environments/${environmentId}/promote',
|
|
2034
|
-
method: 'PUT',
|
|
2035
|
-
comment: 'Promote an environment to primary',
|
|
2036
|
-
urlPlaceholder: {
|
|
2037
|
-
variableName: 'environmentId',
|
|
2038
|
-
isEntityId: true,
|
|
2039
|
-
relType: 'EnvironmentData',
|
|
2040
|
-
},
|
|
2041
|
-
simpleMethodAvailable: true,
|
|
2042
|
-
responseType: 'EnvironmentPromoteTargetSchema',
|
|
2043
|
-
},
|
|
2044
|
-
{
|
|
2045
|
-
returnsCollection: true,
|
|
2046
|
-
docUrl:
|
|
2047
|
-
'https://www.datocms.com/docs/content-management-api/resources/environment/instances',
|
|
2048
|
-
name: 'list',
|
|
2049
|
-
rawName: 'rawList',
|
|
2050
|
-
urlTemplate: '/environments',
|
|
2051
|
-
method: 'GET',
|
|
2052
|
-
comment: 'List all environments',
|
|
2053
|
-
simpleMethodAvailable: true,
|
|
2054
|
-
responseType: 'EnvironmentInstancesTargetSchema',
|
|
2055
|
-
},
|
|
2056
|
-
{
|
|
2057
|
-
returnsCollection: false,
|
|
2058
|
-
docUrl:
|
|
2059
|
-
'https://www.datocms.com/docs/content-management-api/resources/environment/self',
|
|
2060
|
-
name: 'find',
|
|
2061
|
-
rawName: 'rawFind',
|
|
2062
|
-
urlTemplate: '/environments/${environmentId}',
|
|
2063
|
-
method: 'GET',
|
|
2064
|
-
comment: 'Retrieve a environment',
|
|
2065
|
-
urlPlaceholder: {
|
|
2066
|
-
variableName: 'environmentId',
|
|
2067
|
-
isEntityId: true,
|
|
2068
|
-
relType: 'EnvironmentData',
|
|
2069
|
-
},
|
|
2070
|
-
simpleMethodAvailable: true,
|
|
2071
|
-
responseType: 'EnvironmentSelfTargetSchema',
|
|
2072
|
-
},
|
|
2073
|
-
{
|
|
2074
|
-
returnsCollection: false,
|
|
2075
|
-
docUrl:
|
|
2076
|
-
'https://www.datocms.com/docs/content-management-api/resources/environment/destroy',
|
|
2077
|
-
name: 'destroy',
|
|
2078
|
-
rawName: 'rawDestroy',
|
|
2079
|
-
urlTemplate: '/environments/${environmentId}',
|
|
2080
|
-
method: 'DELETE',
|
|
2081
|
-
comment: 'Delete a environment',
|
|
2082
|
-
urlPlaceholder: {
|
|
2083
|
-
variableName: 'environmentId',
|
|
2084
|
-
isEntityId: true,
|
|
2085
|
-
relType: 'EnvironmentData',
|
|
2086
|
-
},
|
|
2087
|
-
simpleMethodAvailable: true,
|
|
2088
|
-
responseType: 'EnvironmentDestroyJobSchema',
|
|
2089
|
-
},
|
|
2090
|
-
],
|
|
2091
|
-
namespace: 'environments',
|
|
2092
|
-
resourceClassName: 'Environment',
|
|
2093
|
-
},
|
|
2094
|
-
{
|
|
2095
|
-
jsonApiType: 'maintenance_mode',
|
|
2096
|
-
endpoints: [
|
|
2097
|
-
{
|
|
2098
|
-
returnsCollection: false,
|
|
2099
|
-
docUrl:
|
|
2100
|
-
'https://www.datocms.com/docs/content-management-api/resources/maintenance-mode/self',
|
|
2101
|
-
name: 'find',
|
|
2102
|
-
rawName: 'rawFind',
|
|
2103
|
-
urlTemplate: '/maintenance-mode',
|
|
2104
|
-
method: 'GET',
|
|
2105
|
-
comment: 'Retrieve maintenence mode',
|
|
2106
|
-
simpleMethodAvailable: true,
|
|
2107
|
-
responseType: 'MaintenanceModeSelfTargetSchema',
|
|
2108
|
-
},
|
|
2109
|
-
{
|
|
2110
|
-
returnsCollection: false,
|
|
2111
|
-
docUrl:
|
|
2112
|
-
'https://www.datocms.com/docs/content-management-api/resources/maintenance-mode/activate',
|
|
2113
|
-
name: 'activate',
|
|
2114
|
-
rawName: 'rawActivate',
|
|
2115
|
-
urlTemplate: '/maintenance-mode/activate',
|
|
2116
|
-
method: 'PUT',
|
|
2117
|
-
comment:
|
|
2118
|
-
'Activate maintenance mode: this means that the primary environment will be read-only',
|
|
2119
|
-
simpleMethodAvailable: true,
|
|
2120
|
-
queryParamsType: 'MaintenanceModeActivateHrefSchema',
|
|
2121
|
-
responseType: 'MaintenanceModeActivateTargetSchema',
|
|
2122
|
-
},
|
|
2123
|
-
{
|
|
2124
|
-
returnsCollection: false,
|
|
2125
|
-
docUrl:
|
|
2126
|
-
'https://www.datocms.com/docs/content-management-api/resources/maintenance-mode/deactivate',
|
|
2127
|
-
name: 'deactivate',
|
|
2128
|
-
rawName: 'rawDeactivate',
|
|
2129
|
-
urlTemplate: '/maintenance-mode/deactivate',
|
|
2130
|
-
method: 'PUT',
|
|
2131
|
-
comment: 'De-activate maintenance mode',
|
|
2132
|
-
simpleMethodAvailable: true,
|
|
2133
|
-
responseType: 'MaintenanceModeDeactivateTargetSchema',
|
|
2134
|
-
},
|
|
2135
|
-
],
|
|
2136
|
-
namespace: 'maintenanceMode',
|
|
2137
|
-
resourceClassName: 'MaintenanceMode',
|
|
2138
|
-
},
|
|
2139
|
-
{
|
|
2140
|
-
jsonApiType: 'webhook',
|
|
2141
|
-
endpoints: [
|
|
2142
|
-
{
|
|
2143
|
-
returnsCollection: false,
|
|
2144
|
-
docUrl:
|
|
2145
|
-
'https://www.datocms.com/docs/content-management-api/resources/webhook/create',
|
|
2146
|
-
name: 'create',
|
|
2147
|
-
rawName: 'rawCreate',
|
|
2148
|
-
urlTemplate: '/webhooks',
|
|
2149
|
-
method: 'POST',
|
|
2150
|
-
comment: 'Create a new webhook',
|
|
2151
|
-
requestBodyType: 'WebhookCreateSchema',
|
|
2152
|
-
simpleMethodAvailable: true,
|
|
2153
|
-
requestStructure: {
|
|
2154
|
-
type: 'webhook',
|
|
2155
|
-
attributes: [
|
|
2156
|
-
'name',
|
|
2157
|
-
'url',
|
|
2158
|
-
'custom_payload',
|
|
2159
|
-
'headers',
|
|
2160
|
-
'events',
|
|
2161
|
-
'http_basic_user',
|
|
2162
|
-
'http_basic_password',
|
|
2163
|
-
'enabled',
|
|
2164
|
-
'payload_api_version',
|
|
2165
|
-
'nested_items_in_payload',
|
|
2166
|
-
],
|
|
2167
|
-
relationships: [],
|
|
2168
|
-
},
|
|
2169
|
-
responseType: 'WebhookCreateTargetSchema',
|
|
2170
|
-
},
|
|
2171
|
-
{
|
|
2172
|
-
returnsCollection: false,
|
|
2173
|
-
docUrl:
|
|
2174
|
-
'https://www.datocms.com/docs/content-management-api/resources/webhook/update',
|
|
2175
|
-
name: 'update',
|
|
2176
|
-
rawName: 'rawUpdate',
|
|
2177
|
-
urlTemplate: '/webhooks/${userId}',
|
|
2178
|
-
method: 'PUT',
|
|
2179
|
-
comment: 'Update a webhook',
|
|
2180
|
-
urlPlaceholder: {
|
|
2181
|
-
variableName: 'userId',
|
|
2182
|
-
isEntityId: false,
|
|
2183
|
-
relType: 'UserData',
|
|
2184
|
-
},
|
|
2185
|
-
requestBodyType: 'WebhookUpdateSchema',
|
|
2186
|
-
simpleMethodAvailable: true,
|
|
2187
|
-
requestStructure: {
|
|
2188
|
-
type: 'webhook',
|
|
2189
|
-
attributes: [
|
|
2190
|
-
'name',
|
|
2191
|
-
'url',
|
|
2192
|
-
'custom_payload',
|
|
2193
|
-
'headers',
|
|
2194
|
-
'events',
|
|
2195
|
-
'http_basic_user',
|
|
2196
|
-
'http_basic_password',
|
|
2197
|
-
'enabled',
|
|
2198
|
-
'payload_api_version',
|
|
2199
|
-
'nested_items_in_payload',
|
|
2200
|
-
],
|
|
2201
|
-
relationships: [],
|
|
2202
|
-
},
|
|
2203
|
-
responseType: 'WebhookUpdateTargetSchema',
|
|
2204
|
-
},
|
|
2205
|
-
{
|
|
2206
|
-
returnsCollection: true,
|
|
2207
|
-
docUrl:
|
|
2208
|
-
'https://www.datocms.com/docs/content-management-api/resources/webhook/instances',
|
|
2209
|
-
name: 'list',
|
|
2210
|
-
rawName: 'rawList',
|
|
2211
|
-
urlTemplate: '/webhooks',
|
|
2212
|
-
method: 'GET',
|
|
2213
|
-
comment: 'List all webhooks',
|
|
2214
|
-
simpleMethodAvailable: true,
|
|
2215
|
-
responseType: 'WebhookInstancesTargetSchema',
|
|
2216
|
-
},
|
|
2217
|
-
{
|
|
2218
|
-
returnsCollection: false,
|
|
2219
|
-
docUrl:
|
|
2220
|
-
'https://www.datocms.com/docs/content-management-api/resources/webhook/self',
|
|
2221
|
-
name: 'find',
|
|
2222
|
-
rawName: 'rawFind',
|
|
2223
|
-
urlTemplate: '/webhooks/${userId}',
|
|
2224
|
-
method: 'GET',
|
|
2225
|
-
comment: 'Retrieve a webhook',
|
|
2226
|
-
urlPlaceholder: {
|
|
2227
|
-
variableName: 'userId',
|
|
2228
|
-
isEntityId: false,
|
|
2229
|
-
relType: 'UserData',
|
|
2230
|
-
},
|
|
2231
|
-
simpleMethodAvailable: true,
|
|
2232
|
-
responseType: 'WebhookSelfTargetSchema',
|
|
2233
|
-
},
|
|
2234
|
-
{
|
|
2235
|
-
returnsCollection: false,
|
|
2236
|
-
docUrl:
|
|
2237
|
-
'https://www.datocms.com/docs/content-management-api/resources/webhook/destroy',
|
|
2238
|
-
name: 'destroy',
|
|
2239
|
-
rawName: 'rawDestroy',
|
|
2240
|
-
urlTemplate: '/webhooks/${userId}',
|
|
2241
|
-
method: 'DELETE',
|
|
2242
|
-
comment: 'Delete a webhook',
|
|
2243
|
-
urlPlaceholder: {
|
|
2244
|
-
variableName: 'userId',
|
|
2245
|
-
isEntityId: false,
|
|
2246
|
-
relType: 'UserData',
|
|
2247
|
-
},
|
|
2248
|
-
simpleMethodAvailable: true,
|
|
2249
|
-
responseType: 'WebhookDestroyTargetSchema',
|
|
2250
|
-
},
|
|
2251
|
-
],
|
|
2252
|
-
namespace: 'webhooks',
|
|
2253
|
-
resourceClassName: 'Webhook',
|
|
2254
|
-
},
|
|
2255
|
-
{
|
|
2256
|
-
jsonApiType: 'webhook_call',
|
|
2257
|
-
endpoints: [
|
|
2258
|
-
{
|
|
2259
|
-
returnsCollection: true,
|
|
2260
|
-
docUrl:
|
|
2261
|
-
'https://www.datocms.com/docs/content-management-api/resources/webhook-call/instances',
|
|
2262
|
-
name: 'list',
|
|
2263
|
-
rawName: 'rawList',
|
|
2264
|
-
urlTemplate: '/webhook_calls',
|
|
2265
|
-
method: 'GET',
|
|
2266
|
-
comment: 'List all webhooks calls',
|
|
2267
|
-
simpleMethodAvailable: true,
|
|
2268
|
-
queryParamsType: 'WebhookCallInstancesHrefSchema',
|
|
2269
|
-
responseType: 'WebhookCallInstancesTargetSchema',
|
|
2270
|
-
paginatedResponse: {
|
|
2271
|
-
defaultLimit: 30,
|
|
2272
|
-
maxLimit: 500,
|
|
2273
|
-
},
|
|
2274
|
-
},
|
|
2275
|
-
{
|
|
2276
|
-
returnsCollection: false,
|
|
2277
|
-
docUrl:
|
|
2278
|
-
'https://www.datocms.com/docs/content-management-api/resources/webhook-call/resend_webhook',
|
|
2279
|
-
name: 'resendWebhook',
|
|
2280
|
-
rawName: 'rawResendWebhook',
|
|
2281
|
-
urlTemplate: '/webhook_calls/${userId}/resend_webhook',
|
|
2282
|
-
method: 'POST',
|
|
2283
|
-
comment: 'Re-send the webhook call',
|
|
2284
|
-
urlPlaceholder: {
|
|
2285
|
-
variableName: 'userId',
|
|
2286
|
-
isEntityId: false,
|
|
2287
|
-
relType: 'UserData',
|
|
2288
|
-
},
|
|
2289
|
-
simpleMethodAvailable: true,
|
|
2290
|
-
},
|
|
2291
|
-
],
|
|
2292
|
-
namespace: 'webhookCalls',
|
|
2293
|
-
resourceClassName: 'WebhookCall',
|
|
2294
|
-
},
|
|
2295
|
-
{
|
|
2296
|
-
jsonApiType: 'build_trigger',
|
|
2297
|
-
endpoints: [
|
|
2298
|
-
{
|
|
2299
|
-
returnsCollection: true,
|
|
2300
|
-
docUrl:
|
|
2301
|
-
'https://www.datocms.com/docs/content-management-api/resources/build-trigger/instances',
|
|
2302
|
-
name: 'list',
|
|
2303
|
-
rawName: 'rawList',
|
|
2304
|
-
urlTemplate: '/build-triggers',
|
|
2305
|
-
method: 'GET',
|
|
2306
|
-
comment: 'List all build triggers for a site',
|
|
2307
|
-
simpleMethodAvailable: true,
|
|
2308
|
-
responseType: 'BuildTriggerInstancesTargetSchema',
|
|
2309
|
-
},
|
|
2310
|
-
{
|
|
2311
|
-
returnsCollection: false,
|
|
2312
|
-
docUrl:
|
|
2313
|
-
'https://www.datocms.com/docs/content-management-api/resources/build-trigger/self',
|
|
2314
|
-
name: 'find',
|
|
2315
|
-
rawName: 'rawFind',
|
|
2316
|
-
urlTemplate: '/build-triggers/${buildTriggerId}',
|
|
2317
|
-
method: 'GET',
|
|
2318
|
-
comment: 'Retrieve a build trigger',
|
|
2319
|
-
urlPlaceholder: {
|
|
2320
|
-
variableName: 'buildTriggerId',
|
|
2321
|
-
isEntityId: true,
|
|
2322
|
-
relType: 'BuildTriggerData',
|
|
2323
|
-
},
|
|
2324
|
-
simpleMethodAvailable: true,
|
|
2325
|
-
responseType: 'BuildTriggerSelfTargetSchema',
|
|
2326
|
-
},
|
|
2327
|
-
{
|
|
2328
|
-
returnsCollection: false,
|
|
2329
|
-
docUrl:
|
|
2330
|
-
'https://www.datocms.com/docs/content-management-api/resources/build-trigger/create',
|
|
2331
|
-
name: 'create',
|
|
2332
|
-
rawName: 'rawCreate',
|
|
2333
|
-
urlTemplate: '/build-triggers',
|
|
2334
|
-
method: 'POST',
|
|
2335
|
-
comment: 'Create build trigger',
|
|
2336
|
-
requestBodyType: 'BuildTriggerCreateSchema',
|
|
2337
|
-
simpleMethodAvailable: true,
|
|
2338
|
-
requestStructure: {
|
|
2339
|
-
type: 'build_trigger',
|
|
2340
|
-
attributes: [
|
|
2341
|
-
'name',
|
|
2342
|
-
'webhook_token',
|
|
2343
|
-
'adapter',
|
|
2344
|
-
'indexing_enabled',
|
|
2345
|
-
'frontend_url',
|
|
2346
|
-
'autotrigger_on_scheduled_publications',
|
|
2347
|
-
'adapter_settings',
|
|
2348
|
-
],
|
|
2349
|
-
relationships: [],
|
|
2350
|
-
},
|
|
2351
|
-
responseType: 'BuildTriggerCreateTargetSchema',
|
|
2352
|
-
},
|
|
2353
|
-
{
|
|
2354
|
-
returnsCollection: false,
|
|
2355
|
-
docUrl:
|
|
2356
|
-
'https://www.datocms.com/docs/content-management-api/resources/build-trigger/update',
|
|
2357
|
-
name: 'update',
|
|
2358
|
-
rawName: 'rawUpdate',
|
|
2359
|
-
urlTemplate: '/build-triggers/${buildTriggerId}',
|
|
2360
|
-
method: 'PUT',
|
|
2361
|
-
comment: 'Update build trigger',
|
|
2362
|
-
urlPlaceholder: {
|
|
2363
|
-
variableName: 'buildTriggerId',
|
|
2364
|
-
isEntityId: true,
|
|
2365
|
-
relType: 'BuildTriggerData',
|
|
2366
|
-
},
|
|
2367
|
-
requestBodyType: 'BuildTriggerUpdateSchema',
|
|
2368
|
-
simpleMethodAvailable: true,
|
|
2369
|
-
requestStructure: {
|
|
2370
|
-
type: 'build_trigger',
|
|
2371
|
-
attributes: [
|
|
2372
|
-
'name',
|
|
2373
|
-
'adapter',
|
|
2374
|
-
'indexing_enabled',
|
|
2375
|
-
'frontend_url',
|
|
2376
|
-
'autotrigger_on_scheduled_publications',
|
|
2377
|
-
'adapter_settings',
|
|
2378
|
-
],
|
|
2379
|
-
relationships: [],
|
|
2380
|
-
},
|
|
2381
|
-
responseType: 'BuildTriggerUpdateTargetSchema',
|
|
2382
|
-
},
|
|
2383
|
-
{
|
|
2384
|
-
returnsCollection: false,
|
|
2385
|
-
docUrl:
|
|
2386
|
-
'https://www.datocms.com/docs/content-management-api/resources/build-trigger/trigger',
|
|
2387
|
-
name: 'trigger',
|
|
2388
|
-
rawName: 'rawTrigger',
|
|
2389
|
-
urlTemplate: '/build-triggers/${buildTriggerId}/trigger',
|
|
2390
|
-
method: 'POST',
|
|
2391
|
-
comment: 'Trigger a deploy',
|
|
2392
|
-
urlPlaceholder: {
|
|
2393
|
-
variableName: 'buildTriggerId',
|
|
2394
|
-
isEntityId: true,
|
|
2395
|
-
relType: 'BuildTriggerData',
|
|
2396
|
-
},
|
|
2397
|
-
simpleMethodAvailable: true,
|
|
2398
|
-
},
|
|
2399
|
-
{
|
|
2400
|
-
returnsCollection: false,
|
|
2401
|
-
docUrl:
|
|
2402
|
-
'https://www.datocms.com/docs/content-management-api/resources/build-trigger/reindex',
|
|
2403
|
-
name: 'reindex',
|
|
2404
|
-
rawName: 'rawReindex',
|
|
2405
|
-
urlTemplate: '/build-triggers/${buildTriggerId}/reindex',
|
|
2406
|
-
method: 'PUT',
|
|
2407
|
-
comment: 'Trigger a new Site Search spidering of the website',
|
|
2408
|
-
urlPlaceholder: {
|
|
2409
|
-
variableName: 'buildTriggerId',
|
|
2410
|
-
isEntityId: true,
|
|
2411
|
-
relType: 'BuildTriggerData',
|
|
2412
|
-
},
|
|
2413
|
-
simpleMethodAvailable: true,
|
|
2414
|
-
},
|
|
2415
|
-
{
|
|
2416
|
-
returnsCollection: false,
|
|
2417
|
-
docUrl:
|
|
2418
|
-
'https://www.datocms.com/docs/content-management-api/resources/build-trigger/destroy',
|
|
2419
|
-
name: 'destroy',
|
|
2420
|
-
rawName: 'rawDestroy',
|
|
2421
|
-
urlTemplate: '/build-triggers/${buildTriggerId}',
|
|
2422
|
-
method: 'DELETE',
|
|
2423
|
-
comment: 'Delete a build trigger',
|
|
2424
|
-
urlPlaceholder: {
|
|
2425
|
-
variableName: 'buildTriggerId',
|
|
2426
|
-
isEntityId: true,
|
|
2427
|
-
relType: 'BuildTriggerData',
|
|
2428
|
-
},
|
|
2429
|
-
simpleMethodAvailable: true,
|
|
2430
|
-
responseType: 'BuildTriggerDestroyTargetSchema',
|
|
2431
|
-
},
|
|
2432
|
-
],
|
|
2433
|
-
namespace: 'buildTriggers',
|
|
2434
|
-
resourceClassName: 'BuildTrigger',
|
|
2435
|
-
},
|
|
2436
|
-
{
|
|
2437
|
-
jsonApiType: 'item_type_filter',
|
|
2438
|
-
endpoints: [
|
|
2439
|
-
{
|
|
2440
|
-
returnsCollection: false,
|
|
2441
|
-
docUrl:
|
|
2442
|
-
'https://www.datocms.com/docs/content-management-api/resources/item-type_filter/create',
|
|
2443
|
-
name: 'create',
|
|
2444
|
-
rawName: 'rawCreate',
|
|
2445
|
-
urlTemplate: '/item-type-filters',
|
|
2446
|
-
method: 'POST',
|
|
2447
|
-
comment: 'Create a new filter',
|
|
2448
|
-
requestBodyType: 'ItemTypeFilterCreateSchema',
|
|
2449
|
-
simpleMethodAvailable: true,
|
|
2450
|
-
requestStructure: {
|
|
2451
|
-
type: 'item_type_filter',
|
|
2452
|
-
attributes: ['name', 'filter', 'shared'],
|
|
2453
|
-
relationships: ['item_type'],
|
|
2454
|
-
},
|
|
2455
|
-
responseType: 'ItemTypeFilterCreateTargetSchema',
|
|
2456
|
-
},
|
|
2457
|
-
{
|
|
2458
|
-
returnsCollection: false,
|
|
2459
|
-
docUrl:
|
|
2460
|
-
'https://www.datocms.com/docs/content-management-api/resources/item-type_filter/update',
|
|
2461
|
-
name: 'update',
|
|
2462
|
-
rawName: 'rawUpdate',
|
|
2463
|
-
urlTemplate: '/item-type-filters/${itemTypeFilterId}',
|
|
2464
|
-
method: 'PUT',
|
|
2465
|
-
comment: 'Update a filter',
|
|
2466
|
-
urlPlaceholder: {
|
|
2467
|
-
variableName: 'itemTypeFilterId',
|
|
2468
|
-
isEntityId: true,
|
|
2469
|
-
relType: 'ItemTypeFilterData',
|
|
2470
|
-
},
|
|
2471
|
-
requestBodyType: 'ItemTypeFilterUpdateSchema',
|
|
2472
|
-
simpleMethodAvailable: true,
|
|
2473
|
-
requestStructure: {
|
|
2474
|
-
type: 'item_type_filter',
|
|
2475
|
-
attributes: ['name', 'shared', 'filter'],
|
|
2476
|
-
relationships: [],
|
|
2477
|
-
},
|
|
2478
|
-
responseType: 'ItemTypeFilterUpdateTargetSchema',
|
|
2479
|
-
},
|
|
2480
|
-
{
|
|
2481
|
-
returnsCollection: true,
|
|
2482
|
-
docUrl:
|
|
2483
|
-
'https://www.datocms.com/docs/content-management-api/resources/item-type_filter/instances',
|
|
2484
|
-
name: 'list',
|
|
2485
|
-
rawName: 'rawList',
|
|
2486
|
-
urlTemplate: '/item-type-filters',
|
|
2487
|
-
method: 'GET',
|
|
2488
|
-
comment: 'List all filters',
|
|
2489
|
-
simpleMethodAvailable: true,
|
|
2490
|
-
responseType: 'ItemTypeFilterInstancesTargetSchema',
|
|
2491
|
-
},
|
|
2492
|
-
{
|
|
2493
|
-
returnsCollection: false,
|
|
2494
|
-
docUrl:
|
|
2495
|
-
'https://www.datocms.com/docs/content-management-api/resources/item-type_filter/self',
|
|
2496
|
-
name: 'find',
|
|
2497
|
-
rawName: 'rawFind',
|
|
2498
|
-
urlTemplate: '/item-type-filters/${itemTypeFilterId}',
|
|
2499
|
-
method: 'GET',
|
|
2500
|
-
comment: 'Retrieve a filter',
|
|
2501
|
-
urlPlaceholder: {
|
|
2502
|
-
variableName: 'itemTypeFilterId',
|
|
2503
|
-
isEntityId: true,
|
|
2504
|
-
relType: 'ItemTypeFilterData',
|
|
2505
|
-
},
|
|
2506
|
-
simpleMethodAvailable: true,
|
|
2507
|
-
responseType: 'ItemTypeFilterSelfTargetSchema',
|
|
2508
|
-
},
|
|
2509
|
-
{
|
|
2510
|
-
returnsCollection: false,
|
|
2511
|
-
docUrl:
|
|
2512
|
-
'https://www.datocms.com/docs/content-management-api/resources/item-type_filter/destroy',
|
|
2513
|
-
name: 'destroy',
|
|
2514
|
-
rawName: 'rawDestroy',
|
|
2515
|
-
urlTemplate: '/item-type-filters/${itemTypeFilterId}',
|
|
2516
|
-
method: 'DELETE',
|
|
2517
|
-
comment: 'Delete a filter',
|
|
2518
|
-
urlPlaceholder: {
|
|
2519
|
-
variableName: 'itemTypeFilterId',
|
|
2520
|
-
isEntityId: true,
|
|
2521
|
-
relType: 'ItemTypeFilterData',
|
|
2522
|
-
},
|
|
2523
|
-
simpleMethodAvailable: true,
|
|
2524
|
-
responseType: 'ItemTypeFilterDestroyTargetSchema',
|
|
2525
|
-
},
|
|
2526
|
-
],
|
|
2527
|
-
namespace: 'itemTypeFilters',
|
|
2528
|
-
resourceClassName: 'ItemTypeFilter',
|
|
2529
|
-
},
|
|
2530
|
-
{
|
|
2531
|
-
jsonApiType: 'upload_filter',
|
|
2532
|
-
endpoints: [
|
|
2533
|
-
{
|
|
2534
|
-
returnsCollection: false,
|
|
2535
|
-
docUrl:
|
|
2536
|
-
'https://www.datocms.com/docs/content-management-api/resources/upload-filter/create',
|
|
2537
|
-
name: 'create',
|
|
2538
|
-
rawName: 'rawCreate',
|
|
2539
|
-
urlTemplate: '/upload-filters',
|
|
2540
|
-
method: 'POST',
|
|
2541
|
-
comment: 'Create a new filter',
|
|
2542
|
-
requestBodyType: 'UploadFilterCreateSchema',
|
|
2543
|
-
simpleMethodAvailable: true,
|
|
2544
|
-
requestStructure: {
|
|
2545
|
-
type: 'upload_filter',
|
|
2546
|
-
attributes: ['name', 'filter', 'shared'],
|
|
2547
|
-
relationships: [],
|
|
2548
|
-
},
|
|
2549
|
-
responseType: 'UploadFilterCreateTargetSchema',
|
|
2550
|
-
},
|
|
2551
|
-
{
|
|
2552
|
-
returnsCollection: false,
|
|
2553
|
-
docUrl:
|
|
2554
|
-
'https://www.datocms.com/docs/content-management-api/resources/upload-filter/update',
|
|
2555
|
-
name: 'update',
|
|
2556
|
-
rawName: 'rawUpdate',
|
|
2557
|
-
urlTemplate: '/upload-filters/${uploadFilterId}',
|
|
2558
|
-
method: 'PUT',
|
|
2559
|
-
comment: 'Update a filter',
|
|
2560
|
-
urlPlaceholder: {
|
|
2561
|
-
variableName: 'uploadFilterId',
|
|
2562
|
-
isEntityId: true,
|
|
2563
|
-
relType: 'UploadFilterData',
|
|
2564
|
-
},
|
|
2565
|
-
requestBodyType: 'UploadFilterUpdateSchema',
|
|
2566
|
-
simpleMethodAvailable: true,
|
|
2567
|
-
requestStructure: {
|
|
2568
|
-
type: 'upload_filter',
|
|
2569
|
-
attributes: ['name', 'shared', 'filter'],
|
|
2570
|
-
relationships: [],
|
|
2571
|
-
},
|
|
2572
|
-
responseType: 'UploadFilterUpdateTargetSchema',
|
|
2573
|
-
},
|
|
2574
|
-
{
|
|
2575
|
-
returnsCollection: true,
|
|
2576
|
-
docUrl:
|
|
2577
|
-
'https://www.datocms.com/docs/content-management-api/resources/upload-filter/instances',
|
|
2578
|
-
name: 'list',
|
|
2579
|
-
rawName: 'rawList',
|
|
2580
|
-
urlTemplate: '/upload-filters',
|
|
2581
|
-
method: 'GET',
|
|
2582
|
-
comment: 'List all filters',
|
|
2583
|
-
simpleMethodAvailable: true,
|
|
2584
|
-
responseType: 'UploadFilterInstancesTargetSchema',
|
|
2585
|
-
},
|
|
2586
|
-
{
|
|
2587
|
-
returnsCollection: false,
|
|
2588
|
-
docUrl:
|
|
2589
|
-
'https://www.datocms.com/docs/content-management-api/resources/upload-filter/self',
|
|
2590
|
-
name: 'find',
|
|
2591
|
-
rawName: 'rawFind',
|
|
2592
|
-
urlTemplate: '/upload-filters/${uploadFilterId}',
|
|
2593
|
-
method: 'GET',
|
|
2594
|
-
comment: 'Retrieve a filter',
|
|
2595
|
-
urlPlaceholder: {
|
|
2596
|
-
variableName: 'uploadFilterId',
|
|
2597
|
-
isEntityId: true,
|
|
2598
|
-
relType: 'UploadFilterData',
|
|
2599
|
-
},
|
|
2600
|
-
simpleMethodAvailable: true,
|
|
2601
|
-
responseType: 'UploadFilterSelfTargetSchema',
|
|
2602
|
-
},
|
|
2603
|
-
{
|
|
2604
|
-
returnsCollection: false,
|
|
2605
|
-
docUrl:
|
|
2606
|
-
'https://www.datocms.com/docs/content-management-api/resources/upload-filter/destroy',
|
|
2607
|
-
name: 'destroy',
|
|
2608
|
-
rawName: 'rawDestroy',
|
|
2609
|
-
urlTemplate: '/upload-filters/${uploadFilterId}',
|
|
2610
|
-
method: 'DELETE',
|
|
2611
|
-
comment: 'Delete a filter',
|
|
2612
|
-
urlPlaceholder: {
|
|
2613
|
-
variableName: 'uploadFilterId',
|
|
2614
|
-
isEntityId: true,
|
|
2615
|
-
relType: 'UploadFilterData',
|
|
2616
|
-
},
|
|
2617
|
-
simpleMethodAvailable: true,
|
|
2618
|
-
responseType: 'UploadFilterDestroyTargetSchema',
|
|
2619
|
-
},
|
|
2620
|
-
],
|
|
2621
|
-
namespace: 'uploadFilters',
|
|
2622
|
-
resourceClassName: 'UploadFilter',
|
|
2623
|
-
},
|
|
2624
|
-
{
|
|
2625
|
-
jsonApiType: 'site_invitation',
|
|
2626
|
-
endpoints: [
|
|
2627
|
-
{
|
|
2628
|
-
returnsCollection: false,
|
|
2629
|
-
docUrl:
|
|
2630
|
-
'https://www.datocms.com/docs/content-management-api/resources/site-invitation/create',
|
|
2631
|
-
name: 'create',
|
|
2632
|
-
rawName: 'rawCreate',
|
|
2633
|
-
urlTemplate: '/site-invitations',
|
|
2634
|
-
method: 'POST',
|
|
2635
|
-
comment: 'Invite a new user',
|
|
2636
|
-
requestBodyType: 'SiteInvitationCreateSchema',
|
|
2637
|
-
simpleMethodAvailable: true,
|
|
2638
|
-
requestStructure: {
|
|
2639
|
-
type: 'site_invitation',
|
|
2640
|
-
attributes: ['email'],
|
|
2641
|
-
relationships: ['role'],
|
|
2642
|
-
},
|
|
2643
|
-
responseType: 'SiteInvitationCreateTargetSchema',
|
|
2644
|
-
},
|
|
2645
|
-
{
|
|
2646
|
-
returnsCollection: false,
|
|
2647
|
-
docUrl:
|
|
2648
|
-
'https://www.datocms.com/docs/content-management-api/resources/site-invitation/update',
|
|
2649
|
-
name: 'update',
|
|
2650
|
-
rawName: 'rawUpdate',
|
|
2651
|
-
urlTemplate: '/site-invitations/${siteInvitationId}',
|
|
2652
|
-
method: 'PUT',
|
|
2653
|
-
comment: 'Update an invitation',
|
|
2654
|
-
urlPlaceholder: {
|
|
2655
|
-
variableName: 'siteInvitationId',
|
|
2656
|
-
isEntityId: true,
|
|
2657
|
-
relType: 'SiteInvitationData',
|
|
2658
|
-
},
|
|
2659
|
-
requestBodyType: 'SiteInvitationUpdateSchema',
|
|
2660
|
-
simpleMethodAvailable: true,
|
|
2661
|
-
requestStructure: {
|
|
2662
|
-
type: 'site_invitation',
|
|
2663
|
-
attributes: [],
|
|
2664
|
-
relationships: ['role'],
|
|
2665
|
-
},
|
|
2666
|
-
responseType: 'SiteInvitationUpdateTargetSchema',
|
|
2667
|
-
},
|
|
2668
|
-
{
|
|
2669
|
-
returnsCollection: true,
|
|
2670
|
-
docUrl:
|
|
2671
|
-
'https://www.datocms.com/docs/content-management-api/resources/site-invitation/instances',
|
|
2672
|
-
name: 'list',
|
|
2673
|
-
rawName: 'rawList',
|
|
2674
|
-
urlTemplate: '/site-invitations',
|
|
2675
|
-
method: 'GET',
|
|
2676
|
-
comment: 'List all invitations',
|
|
2677
|
-
simpleMethodAvailable: true,
|
|
2678
|
-
responseType: 'SiteInvitationInstancesTargetSchema',
|
|
2679
|
-
},
|
|
2680
|
-
{
|
|
2681
|
-
returnsCollection: false,
|
|
2682
|
-
docUrl:
|
|
2683
|
-
'https://www.datocms.com/docs/content-management-api/resources/site-invitation/self',
|
|
2684
|
-
name: 'find',
|
|
2685
|
-
rawName: 'rawFind',
|
|
2686
|
-
urlTemplate: '/site-invitations/${siteInvitationId}',
|
|
2687
|
-
method: 'GET',
|
|
2688
|
-
comment: 'Retrieve an invitation',
|
|
2689
|
-
urlPlaceholder: {
|
|
2690
|
-
variableName: 'siteInvitationId',
|
|
2691
|
-
isEntityId: true,
|
|
2692
|
-
relType: 'SiteInvitationData',
|
|
2693
|
-
},
|
|
2694
|
-
simpleMethodAvailable: true,
|
|
2695
|
-
responseType: 'SiteInvitationSelfTargetSchema',
|
|
2696
|
-
},
|
|
2697
|
-
{
|
|
2698
|
-
returnsCollection: false,
|
|
2699
|
-
docUrl:
|
|
2700
|
-
'https://www.datocms.com/docs/content-management-api/resources/site-invitation/destroy',
|
|
2701
|
-
name: 'destroy',
|
|
2702
|
-
rawName: 'rawDestroy',
|
|
2703
|
-
urlTemplate: '/site-invitations/${siteInvitationId}',
|
|
2704
|
-
method: 'DELETE',
|
|
2705
|
-
comment: 'Delete an invitation',
|
|
2706
|
-
urlPlaceholder: {
|
|
2707
|
-
variableName: 'siteInvitationId',
|
|
2708
|
-
isEntityId: true,
|
|
2709
|
-
relType: 'SiteInvitationData',
|
|
2710
|
-
},
|
|
2711
|
-
simpleMethodAvailable: true,
|
|
2712
|
-
responseType: 'SiteInvitationDestroyTargetSchema',
|
|
2713
|
-
},
|
|
2714
|
-
{
|
|
2715
|
-
returnsCollection: false,
|
|
2716
|
-
docUrl:
|
|
2717
|
-
'https://www.datocms.com/docs/content-management-api/resources/site-invitation/resend',
|
|
2718
|
-
name: 'resend',
|
|
2719
|
-
rawName: 'rawResend',
|
|
2720
|
-
urlTemplate: '/site-invitations/${siteInvitationId}/resend',
|
|
2721
|
-
method: 'POST',
|
|
2722
|
-
comment: 'Resend an invitation',
|
|
2723
|
-
urlPlaceholder: {
|
|
2724
|
-
variableName: 'siteInvitationId',
|
|
2725
|
-
isEntityId: true,
|
|
2726
|
-
relType: 'SiteInvitationData',
|
|
2727
|
-
},
|
|
2728
|
-
simpleMethodAvailable: true,
|
|
2729
|
-
},
|
|
2730
|
-
],
|
|
2731
|
-
namespace: 'siteInvitations',
|
|
2732
|
-
resourceClassName: 'SiteInvitation',
|
|
2733
|
-
},
|
|
2734
|
-
{
|
|
2735
|
-
jsonApiType: 'editing_session',
|
|
2736
|
-
endpoints: [
|
|
2737
|
-
{
|
|
2738
|
-
returnsCollection: true,
|
|
2739
|
-
docUrl:
|
|
2740
|
-
'https://www.datocms.com/docs/content-management-api/resources/editing-session/instances',
|
|
2741
|
-
name: 'list',
|
|
2742
|
-
rawName: 'rawList',
|
|
2743
|
-
urlTemplate: '/editing-sessions',
|
|
2744
|
-
method: 'GET',
|
|
2745
|
-
comment: 'List all editing sessions',
|
|
2746
|
-
simpleMethodAvailable: true,
|
|
2747
|
-
responseType: 'EditingSessionInstancesTargetSchema',
|
|
2748
|
-
deprecated:
|
|
2749
|
-
'This API call is to be considered private and might change without notice',
|
|
2750
|
-
},
|
|
2751
|
-
{
|
|
2752
|
-
returnsCollection: false,
|
|
2753
|
-
docUrl:
|
|
2754
|
-
'https://www.datocms.com/docs/content-management-api/resources/editing-session/update',
|
|
2755
|
-
name: 'update',
|
|
2756
|
-
rawName: 'rawUpdate',
|
|
2757
|
-
urlTemplate: '/editing-sessions/${editingSessionId}',
|
|
2758
|
-
method: 'PUT',
|
|
2759
|
-
comment: 'Allows all actions on editing sessions',
|
|
2760
|
-
urlPlaceholder: {
|
|
2761
|
-
variableName: 'editingSessionId',
|
|
2762
|
-
isEntityId: true,
|
|
2763
|
-
relType: 'EditingSessionData',
|
|
2764
|
-
},
|
|
2765
|
-
requestBodyType: 'EditingSessionUpdateSchema',
|
|
2766
|
-
simpleMethodAvailable: false,
|
|
2767
|
-
requestStructure: {
|
|
2768
|
-
type: '*',
|
|
2769
|
-
attributes: [],
|
|
2770
|
-
relationships: ['item', 'item', 'item'],
|
|
2771
|
-
},
|
|
2772
|
-
responseType: 'EditingSessionUpdateTargetSchema',
|
|
2773
|
-
deprecated:
|
|
2774
|
-
'This API call is to be considered private and might change without notice',
|
|
2775
|
-
},
|
|
2776
|
-
{
|
|
2777
|
-
returnsCollection: false,
|
|
2778
|
-
docUrl:
|
|
2779
|
-
'https://www.datocms.com/docs/content-management-api/resources/editing-session/destroy',
|
|
2780
|
-
name: 'destroy',
|
|
2781
|
-
rawName: 'rawDestroy',
|
|
2782
|
-
urlTemplate: '/editing-sessions/${editingSessionId}',
|
|
2783
|
-
method: 'DELETE',
|
|
2784
|
-
comment: 'Delete an editing session',
|
|
2785
|
-
urlPlaceholder: {
|
|
2786
|
-
variableName: 'editingSessionId',
|
|
2787
|
-
isEntityId: true,
|
|
2788
|
-
relType: 'EditingSessionData',
|
|
2789
|
-
},
|
|
2790
|
-
simpleMethodAvailable: true,
|
|
2791
|
-
responseType: 'EditingSessionDestroyTargetSchema',
|
|
2792
|
-
deprecated:
|
|
2793
|
-
'This API call is to be considered private and might change without notice',
|
|
2794
|
-
},
|
|
2795
|
-
],
|
|
2796
|
-
namespace: 'editingSessions',
|
|
2797
|
-
resourceClassName: 'EditingSession',
|
|
2798
|
-
},
|
|
2799
|
-
{
|
|
2800
|
-
jsonApiType: 'sso_group',
|
|
2801
|
-
endpoints: [
|
|
2802
|
-
{
|
|
2803
|
-
returnsCollection: true,
|
|
2804
|
-
docUrl:
|
|
2805
|
-
'https://www.datocms.com/docs/content-management-api/resources/sso-group/instances',
|
|
2806
|
-
name: 'list',
|
|
2807
|
-
rawName: 'rawList',
|
|
2808
|
-
urlTemplate: '/sso-groups',
|
|
2809
|
-
method: 'GET',
|
|
2810
|
-
comment: 'List all SSO groups',
|
|
2811
|
-
simpleMethodAvailable: true,
|
|
2812
|
-
responseType: 'SsoGroupInstancesTargetSchema',
|
|
2813
|
-
},
|
|
2814
|
-
{
|
|
2815
|
-
returnsCollection: false,
|
|
2816
|
-
docUrl:
|
|
2817
|
-
'https://www.datocms.com/docs/content-management-api/resources/sso-group/copy_roles',
|
|
2818
|
-
name: 'copyRoles',
|
|
2819
|
-
rawName: 'rawCopyRoles',
|
|
2820
|
-
urlTemplate: '/sso-groups/${ssoGroupId}/copy-roles',
|
|
2821
|
-
method: 'POST',
|
|
2822
|
-
comment: 'Sync SSO provider groups to DatoCMS roles',
|
|
2823
|
-
urlPlaceholder: {
|
|
2824
|
-
variableName: 'ssoGroupId',
|
|
2825
|
-
isEntityId: true,
|
|
2826
|
-
relType: 'SsoGroupData',
|
|
2827
|
-
},
|
|
2828
|
-
simpleMethodAvailable: true,
|
|
2829
|
-
responseType: 'SsoGroupCopyRolesTargetSchema',
|
|
2830
|
-
},
|
|
2831
|
-
{
|
|
2832
|
-
returnsCollection: false,
|
|
2833
|
-
docUrl:
|
|
2834
|
-
'https://www.datocms.com/docs/content-management-api/resources/sso-group/update',
|
|
2835
|
-
name: 'update',
|
|
2836
|
-
rawName: 'rawUpdate',
|
|
2837
|
-
urlTemplate: '/sso-groups/${ssoGroupId}',
|
|
2838
|
-
method: 'PUT',
|
|
2839
|
-
comment: 'Update a SSO group',
|
|
2840
|
-
urlPlaceholder: {
|
|
2841
|
-
variableName: 'ssoGroupId',
|
|
2842
|
-
isEntityId: true,
|
|
2843
|
-
relType: 'SsoGroupData',
|
|
2844
|
-
},
|
|
2845
|
-
requestBodyType: 'SsoGroupUpdateSchema',
|
|
2846
|
-
simpleMethodAvailable: true,
|
|
2847
|
-
requestStructure: {
|
|
2848
|
-
type: 'sso_group',
|
|
2849
|
-
attributes: ['priority'],
|
|
2850
|
-
relationships: ['role'],
|
|
2851
|
-
},
|
|
2852
|
-
responseType: 'SsoGroupUpdateTargetSchema',
|
|
2853
|
-
},
|
|
2854
|
-
{
|
|
2855
|
-
returnsCollection: false,
|
|
2856
|
-
docUrl:
|
|
2857
|
-
'https://www.datocms.com/docs/content-management-api/resources/sso-group/destroy',
|
|
2858
|
-
name: 'destroy',
|
|
2859
|
-
rawName: 'rawDestroy',
|
|
2860
|
-
urlTemplate: '/sso-groups/${ssoGroupId}',
|
|
2861
|
-
method: 'DELETE',
|
|
2862
|
-
comment: 'Delete a group',
|
|
2863
|
-
urlPlaceholder: {
|
|
2864
|
-
variableName: 'ssoGroupId',
|
|
2865
|
-
isEntityId: true,
|
|
2866
|
-
relType: 'SsoGroupData',
|
|
2867
|
-
},
|
|
2868
|
-
simpleMethodAvailable: true,
|
|
2869
|
-
responseType: 'SsoGroupDestroyTargetSchema',
|
|
2870
|
-
},
|
|
2871
|
-
],
|
|
2872
|
-
namespace: 'ssoGroups',
|
|
2873
|
-
resourceClassName: 'SsoGroup',
|
|
2874
|
-
},
|
|
2875
|
-
{
|
|
2876
|
-
jsonApiType: 'sso_settings',
|
|
2877
|
-
endpoints: [
|
|
2878
|
-
{
|
|
2879
|
-
returnsCollection: false,
|
|
2880
|
-
docUrl:
|
|
2881
|
-
'https://www.datocms.com/docs/content-management-api/resources/sso-settings/self',
|
|
2882
|
-
name: 'find',
|
|
2883
|
-
rawName: 'rawFind',
|
|
2884
|
-
urlTemplate: '/sso-settings',
|
|
2885
|
-
method: 'GET',
|
|
2886
|
-
comment: 'Retrieve SSO Settings',
|
|
2887
|
-
simpleMethodAvailable: true,
|
|
2888
|
-
responseType: 'SsoSettingsSelfTargetSchema',
|
|
2889
|
-
},
|
|
2890
|
-
{
|
|
2891
|
-
returnsCollection: false,
|
|
2892
|
-
docUrl:
|
|
2893
|
-
'https://www.datocms.com/docs/content-management-api/resources/sso-settings/generate_token',
|
|
2894
|
-
name: 'generateToken',
|
|
2895
|
-
rawName: 'rawGenerateToken',
|
|
2896
|
-
urlTemplate: '/sso-settings/generate-token',
|
|
2897
|
-
method: 'PUT',
|
|
2898
|
-
comment: 'Generate SSO token',
|
|
2899
|
-
simpleMethodAvailable: true,
|
|
2900
|
-
responseType: 'SsoSettingsGenerateTokenTargetSchema',
|
|
2901
|
-
},
|
|
2902
|
-
{
|
|
2903
|
-
returnsCollection: false,
|
|
2904
|
-
docUrl:
|
|
2905
|
-
'https://www.datocms.com/docs/content-management-api/resources/sso-settings/update',
|
|
2906
|
-
name: 'update',
|
|
2907
|
-
rawName: 'rawUpdate',
|
|
2908
|
-
urlTemplate: '/sso-settings',
|
|
2909
|
-
method: 'PUT',
|
|
2910
|
-
comment: 'Update SSO Settings',
|
|
2911
|
-
requestBodyType: 'SsoSettingsUpdateSchema',
|
|
2912
|
-
simpleMethodAvailable: true,
|
|
2913
|
-
requestStructure: {
|
|
2914
|
-
type: 'sso_settings',
|
|
2915
|
-
attributes: ['idp_saml_metadata_url'],
|
|
2916
|
-
relationships: ['default_role'],
|
|
2917
|
-
},
|
|
2918
|
-
responseType: 'SsoSettingsUpdateTargetSchema',
|
|
2919
|
-
},
|
|
2920
|
-
],
|
|
2921
|
-
namespace: 'ssoSettings',
|
|
2922
|
-
resourceClassName: 'SsoSettings',
|
|
2923
|
-
},
|
|
2924
|
-
{
|
|
2925
|
-
jsonApiType: 'white_label_settings',
|
|
2926
|
-
endpoints: [
|
|
2927
|
-
{
|
|
2928
|
-
returnsCollection: false,
|
|
2929
|
-
docUrl:
|
|
2930
|
-
'https://www.datocms.com/docs/content-management-api/resources/white-label_settings/self',
|
|
2931
|
-
name: 'find',
|
|
2932
|
-
rawName: 'rawFind',
|
|
2933
|
-
urlTemplate: '/white-label-settings',
|
|
2934
|
-
method: 'GET',
|
|
2935
|
-
comment: 'Retrieve white-label settings',
|
|
2936
|
-
simpleMethodAvailable: true,
|
|
2937
|
-
responseType: 'WhiteLabelSettingsSelfTargetSchema',
|
|
2938
|
-
},
|
|
2939
|
-
{
|
|
2940
|
-
returnsCollection: false,
|
|
2941
|
-
docUrl:
|
|
2942
|
-
'https://www.datocms.com/docs/content-management-api/resources/white-label_settings/update',
|
|
2943
|
-
name: 'update',
|
|
2944
|
-
rawName: 'rawUpdate',
|
|
2945
|
-
urlTemplate: '/white-label-settings',
|
|
2946
|
-
method: 'PUT',
|
|
2947
|
-
comment: 'Update white-label settings',
|
|
2948
|
-
requestBodyType: 'WhiteLabelSettingsUpdateSchema',
|
|
2949
|
-
simpleMethodAvailable: true,
|
|
2950
|
-
requestStructure: {
|
|
2951
|
-
type: 'white_label_settings',
|
|
2952
|
-
attributes: ['custom_i18n_messages_template_url'],
|
|
2953
|
-
relationships: [],
|
|
2954
|
-
},
|
|
2955
|
-
responseType: 'WhiteLabelSettingsUpdateTargetSchema',
|
|
2956
|
-
},
|
|
2957
|
-
],
|
|
2958
|
-
namespace: 'whiteLabelSettings',
|
|
2959
|
-
resourceClassName: 'WhiteLabelSettings',
|
|
2960
|
-
},
|
|
2961
|
-
{
|
|
2962
|
-
jsonApiType: 'public_info',
|
|
2963
|
-
endpoints: [
|
|
2964
|
-
{
|
|
2965
|
-
returnsCollection: false,
|
|
2966
|
-
docUrl:
|
|
2967
|
-
'https://www.datocms.com/docs/content-management-api/resources/public-info/self',
|
|
2968
|
-
name: 'find',
|
|
2969
|
-
rawName: 'rawFind',
|
|
2970
|
-
urlTemplate: '/public-info',
|
|
2971
|
-
method: 'GET',
|
|
2972
|
-
comment: 'Retrieve public site info',
|
|
2973
|
-
simpleMethodAvailable: true,
|
|
2974
|
-
responseType: 'PublicInfoSelfTargetSchema',
|
|
2975
|
-
},
|
|
2976
|
-
],
|
|
2977
|
-
namespace: 'publicInfo',
|
|
2978
|
-
resourceClassName: 'PublicInfo',
|
|
2979
|
-
},
|
|
2980
|
-
{
|
|
2981
|
-
jsonApiType: 'daily_usage',
|
|
2982
|
-
endpoints: [
|
|
2983
|
-
{
|
|
2984
|
-
returnsCollection: true,
|
|
2985
|
-
docUrl:
|
|
2986
|
-
'https://www.datocms.com/docs/content-management-api/resources/daily-usage/instances',
|
|
2987
|
-
name: 'list',
|
|
2988
|
-
rawName: 'rawList',
|
|
2989
|
-
urlTemplate: '/daily-site-usages',
|
|
2990
|
-
method: 'GET',
|
|
2991
|
-
comment: "Retrieve project's daily usage info",
|
|
2992
|
-
simpleMethodAvailable: true,
|
|
2993
|
-
responseType: 'DailyUsageInstancesTargetSchema',
|
|
2994
|
-
},
|
|
2995
|
-
],
|
|
2996
|
-
namespace: 'dailyUsages',
|
|
2997
|
-
resourceClassName: 'DailyUsage',
|
|
2998
|
-
},
|
|
2999
|
-
{
|
|
3000
|
-
jsonApiType: 'usage_counter',
|
|
3001
|
-
endpoints: [
|
|
3002
|
-
{
|
|
3003
|
-
returnsCollection: false,
|
|
3004
|
-
docUrl:
|
|
3005
|
-
'https://www.datocms.com/docs/content-management-api/resources/usage-counter/self',
|
|
3006
|
-
name: 'find',
|
|
3007
|
-
rawName: 'rawFind',
|
|
3008
|
-
urlTemplate: '/usage-log-counters/${usageCounterId}',
|
|
3009
|
-
method: 'GET',
|
|
3010
|
-
comment: "Retrieve a project's usage counter",
|
|
3011
|
-
urlPlaceholder: {
|
|
3012
|
-
variableName: 'usageCounterId',
|
|
3013
|
-
isEntityId: true,
|
|
3014
|
-
relType: 'UsageCounterData',
|
|
3015
|
-
},
|
|
3016
|
-
simpleMethodAvailable: true,
|
|
3017
|
-
queryParamsType: 'UsageCounterSelfHrefSchema',
|
|
3018
|
-
responseType: 'UsageCounterSelfTargetSchema',
|
|
3019
|
-
},
|
|
3020
|
-
],
|
|
3021
|
-
namespace: 'usageCounters',
|
|
3022
|
-
resourceClassName: 'UsageCounter',
|
|
3023
|
-
},
|
|
3024
|
-
{
|
|
3025
|
-
jsonApiType: 'upload_tag',
|
|
3026
|
-
endpoints: [
|
|
3027
|
-
{
|
|
3028
|
-
returnsCollection: true,
|
|
3029
|
-
docUrl:
|
|
3030
|
-
'https://www.datocms.com/docs/content-management-api/resources/upload-tag/instances',
|
|
3031
|
-
name: 'list',
|
|
3032
|
-
rawName: 'rawList',
|
|
3033
|
-
urlTemplate: '/upload-tags',
|
|
3034
|
-
method: 'GET',
|
|
3035
|
-
comment: 'List all manually created upload tags',
|
|
3036
|
-
simpleMethodAvailable: true,
|
|
3037
|
-
queryParamsType: 'UploadTagInstancesHrefSchema',
|
|
3038
|
-
responseType: 'UploadTagInstancesTargetSchema',
|
|
3039
|
-
paginatedResponse: {
|
|
3040
|
-
defaultLimit: 50,
|
|
3041
|
-
maxLimit: 500,
|
|
3042
|
-
},
|
|
3043
|
-
},
|
|
3044
|
-
{
|
|
3045
|
-
returnsCollection: false,
|
|
3046
|
-
docUrl:
|
|
3047
|
-
'https://www.datocms.com/docs/content-management-api/resources/upload-tag/create',
|
|
3048
|
-
name: 'create',
|
|
3049
|
-
rawName: 'rawCreate',
|
|
3050
|
-
urlTemplate: '/upload-tags',
|
|
3051
|
-
method: 'POST',
|
|
3052
|
-
comment: 'Create a new upload tag',
|
|
3053
|
-
requestBodyType: 'UploadTagCreateSchema',
|
|
3054
|
-
simpleMethodAvailable: true,
|
|
3055
|
-
requestStructure: {
|
|
3056
|
-
type: 'upload_tag',
|
|
3057
|
-
attributes: ['name'],
|
|
3058
|
-
relationships: [],
|
|
3059
|
-
},
|
|
3060
|
-
responseType: 'UploadTagCreateTargetSchema',
|
|
3061
|
-
},
|
|
3062
|
-
],
|
|
3063
|
-
namespace: 'uploadTags',
|
|
3064
|
-
resourceClassName: 'UploadTag',
|
|
3065
|
-
},
|
|
3066
|
-
{
|
|
3067
|
-
jsonApiType: 'upload_smart_tag',
|
|
3068
|
-
endpoints: [
|
|
3069
|
-
{
|
|
3070
|
-
returnsCollection: true,
|
|
3071
|
-
docUrl:
|
|
3072
|
-
'https://www.datocms.com/docs/content-management-api/resources/upload-smart_tag/instances',
|
|
3073
|
-
name: 'list',
|
|
3074
|
-
rawName: 'rawList',
|
|
3075
|
-
urlTemplate: '/upload-smart-tags',
|
|
3076
|
-
method: 'GET',
|
|
3077
|
-
comment: 'List all automatically created upload tags',
|
|
3078
|
-
simpleMethodAvailable: true,
|
|
3079
|
-
queryParamsType: 'UploadSmartTagInstancesHrefSchema',
|
|
3080
|
-
responseType: 'UploadSmartTagInstancesTargetSchema',
|
|
3081
|
-
paginatedResponse: {
|
|
3082
|
-
defaultLimit: 50,
|
|
3083
|
-
maxLimit: 500,
|
|
3084
|
-
},
|
|
3085
|
-
},
|
|
3086
|
-
],
|
|
3087
|
-
namespace: 'uploadSmartTags',
|
|
3088
|
-
resourceClassName: 'UploadSmartTag',
|
|
3089
|
-
},
|
|
3090
|
-
{
|
|
3091
|
-
jsonApiType: 'site',
|
|
3092
|
-
endpoints: [
|
|
3093
|
-
{
|
|
3094
|
-
returnsCollection: false,
|
|
3095
|
-
docUrl:
|
|
3096
|
-
'https://www.datocms.com/docs/content-management-api/resources/site/self',
|
|
3097
|
-
name: 'find',
|
|
3098
|
-
rawName: 'rawFind',
|
|
3099
|
-
urlTemplate: '/site',
|
|
3100
|
-
method: 'GET',
|
|
3101
|
-
comment: 'Retrieve the site',
|
|
3102
|
-
simpleMethodAvailable: true,
|
|
3103
|
-
responseType: 'SiteSelfTargetSchema',
|
|
3104
|
-
},
|
|
3105
|
-
{
|
|
3106
|
-
returnsCollection: false,
|
|
3107
|
-
docUrl:
|
|
3108
|
-
'https://www.datocms.com/docs/content-management-api/resources/site/update',
|
|
3109
|
-
name: 'update',
|
|
3110
|
-
rawName: 'rawUpdate',
|
|
3111
|
-
urlTemplate: '/site',
|
|
3112
|
-
method: 'PUT',
|
|
3113
|
-
comment: "Update the site's settings",
|
|
3114
|
-
requestBodyType: 'SiteUpdateSchema',
|
|
3115
|
-
simpleMethodAvailable: true,
|
|
3116
|
-
requestStructure: {
|
|
3117
|
-
type: 'site',
|
|
3118
|
-
attributes: [
|
|
3119
|
-
'no_index',
|
|
3120
|
-
'favicon',
|
|
3121
|
-
'global_seo',
|
|
3122
|
-
'name',
|
|
3123
|
-
'theme',
|
|
3124
|
-
'locales',
|
|
3125
|
-
'timezone',
|
|
3126
|
-
'require_2fa',
|
|
3127
|
-
'ip_tracking_enabled',
|
|
3128
|
-
],
|
|
3129
|
-
relationships: ['sso_default_role'],
|
|
3130
|
-
},
|
|
3131
|
-
responseType: 'SiteUpdateJobSchema',
|
|
3132
|
-
},
|
|
3133
|
-
],
|
|
3134
|
-
namespace: 'site',
|
|
3135
|
-
resourceClassName: 'Site',
|
|
3136
|
-
},
|
|
3137
|
-
{
|
|
3138
|
-
jsonApiType: 'workflow',
|
|
3139
|
-
endpoints: [
|
|
3140
|
-
{
|
|
3141
|
-
returnsCollection: false,
|
|
3142
|
-
docUrl:
|
|
3143
|
-
'https://www.datocms.com/docs/content-management-api/resources/workflow/create',
|
|
3144
|
-
name: 'create',
|
|
3145
|
-
rawName: 'rawCreate',
|
|
3146
|
-
urlTemplate: '/workflows',
|
|
3147
|
-
method: 'POST',
|
|
3148
|
-
comment: 'Create a new workflow',
|
|
3149
|
-
requestBodyType: 'WorkflowCreateSchema',
|
|
3150
|
-
simpleMethodAvailable: true,
|
|
3151
|
-
requestStructure: {
|
|
3152
|
-
type: 'workflow',
|
|
3153
|
-
attributes: ['name', 'stages'],
|
|
3154
|
-
relationships: [],
|
|
3155
|
-
},
|
|
3156
|
-
responseType: 'WorkflowCreateTargetSchema',
|
|
3157
|
-
},
|
|
3158
|
-
{
|
|
3159
|
-
returnsCollection: false,
|
|
3160
|
-
docUrl:
|
|
3161
|
-
'https://www.datocms.com/docs/content-management-api/resources/workflow/update',
|
|
3162
|
-
name: 'update',
|
|
3163
|
-
rawName: 'rawUpdate',
|
|
3164
|
-
urlTemplate: '/workflows/${workflowId}',
|
|
3165
|
-
method: 'PUT',
|
|
3166
|
-
comment: 'Update a workflow',
|
|
3167
|
-
urlPlaceholder: {
|
|
3168
|
-
variableName: 'workflowId',
|
|
3169
|
-
isEntityId: true,
|
|
3170
|
-
relType: 'WorkflowData',
|
|
3171
|
-
},
|
|
3172
|
-
requestBodyType: 'WorkflowUpdateSchema',
|
|
3173
|
-
simpleMethodAvailable: true,
|
|
3174
|
-
requestStructure: {
|
|
3175
|
-
type: 'workflow',
|
|
3176
|
-
attributes: ['name', 'stages'],
|
|
3177
|
-
relationships: [],
|
|
3178
|
-
},
|
|
3179
|
-
responseType: 'WorkflowUpdateTargetSchema',
|
|
3180
|
-
},
|
|
3181
|
-
{
|
|
3182
|
-
returnsCollection: true,
|
|
3183
|
-
docUrl:
|
|
3184
|
-
'https://www.datocms.com/docs/content-management-api/resources/workflow/instances',
|
|
3185
|
-
name: 'list',
|
|
3186
|
-
rawName: 'rawList',
|
|
3187
|
-
urlTemplate: '/workflows',
|
|
3188
|
-
method: 'GET',
|
|
3189
|
-
comment: 'List all workflows',
|
|
3190
|
-
simpleMethodAvailable: true,
|
|
3191
|
-
responseType: 'WorkflowInstancesTargetSchema',
|
|
3192
|
-
},
|
|
3193
|
-
{
|
|
3194
|
-
returnsCollection: false,
|
|
3195
|
-
docUrl:
|
|
3196
|
-
'https://www.datocms.com/docs/content-management-api/resources/workflow/self',
|
|
3197
|
-
name: 'find',
|
|
3198
|
-
rawName: 'rawFind',
|
|
3199
|
-
urlTemplate: '/workflows/${workflowId}',
|
|
3200
|
-
method: 'GET',
|
|
3201
|
-
comment: 'Retrieve a workflow',
|
|
3202
|
-
urlPlaceholder: {
|
|
3203
|
-
variableName: 'workflowId',
|
|
3204
|
-
isEntityId: true,
|
|
3205
|
-
relType: 'WorkflowData',
|
|
3206
|
-
},
|
|
3207
|
-
simpleMethodAvailable: true,
|
|
3208
|
-
responseType: 'WorkflowSelfTargetSchema',
|
|
3209
|
-
},
|
|
3210
|
-
{
|
|
3211
|
-
returnsCollection: false,
|
|
3212
|
-
docUrl:
|
|
3213
|
-
'https://www.datocms.com/docs/content-management-api/resources/workflow/destroy',
|
|
3214
|
-
name: 'destroy',
|
|
3215
|
-
rawName: 'rawDestroy',
|
|
3216
|
-
urlTemplate: '/workflows/${workflowId}',
|
|
3217
|
-
method: 'DELETE',
|
|
3218
|
-
comment: 'Delete a workflow',
|
|
3219
|
-
urlPlaceholder: {
|
|
3220
|
-
variableName: 'workflowId',
|
|
3221
|
-
isEntityId: true,
|
|
3222
|
-
relType: 'WorkflowData',
|
|
3223
|
-
},
|
|
3224
|
-
simpleMethodAvailable: true,
|
|
3225
|
-
},
|
|
3226
|
-
],
|
|
3227
|
-
namespace: 'workflows',
|
|
3228
|
-
resourceClassName: 'Workflow',
|
|
3229
|
-
},
|
|
3230
|
-
],
|
|
3231
|
-
};
|