deere-sdk 2.3.1 → 2.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +56 -0
- package/dist/api/assets.d.ts +23 -23
- package/dist/api/assets.d.ts.map +1 -1
- package/dist/api/assets.js +35 -35
- package/dist/api/assets.js.map +1 -1
- package/dist/api/boundaries.d.ts +16 -16
- package/dist/api/boundaries.d.ts.map +1 -1
- package/dist/api/boundaries.js +19 -19
- package/dist/api/boundaries.js.map +1 -1
- package/dist/api/clients.d.ts +10 -10
- package/dist/api/clients.d.ts.map +1 -1
- package/dist/api/clients.js +13 -13
- package/dist/api/clients.js.map +1 -1
- package/dist/api/crop-types.d.ts +4 -4
- package/dist/api/crop-types.d.ts.map +1 -1
- package/dist/api/crop-types.js +6 -6
- package/dist/api/crop-types.js.map +1 -1
- package/dist/api/equipment.d.ts +76 -76
- package/dist/api/equipment.d.ts.map +1 -1
- package/dist/api/equipment.js +96 -96
- package/dist/api/equipment.js.map +1 -1
- package/dist/api/farms.d.ts +11 -11
- package/dist/api/farms.d.ts.map +1 -1
- package/dist/api/farms.js +14 -14
- package/dist/api/farms.js.map +1 -1
- package/dist/api/field-operations-api.d.ts +88 -32
- package/dist/api/field-operations-api.d.ts.map +1 -1
- package/dist/api/field-operations-api.js +111 -49
- package/dist/api/field-operations-api.js.map +1 -1
- package/dist/api/fields.d.ts +9 -9
- package/dist/api/fields.d.ts.map +1 -1
- package/dist/api/fields.js +12 -12
- package/dist/api/fields.js.map +1 -1
- package/dist/api/files.d.ts +47 -0
- package/dist/api/files.d.ts.map +1 -1
- package/dist/api/files.js +65 -0
- package/dist/api/files.js.map +1 -1
- package/dist/api/flags.d.ts +100 -34
- package/dist/api/flags.d.ts.map +1 -1
- package/dist/api/flags.js +145 -49
- package/dist/api/flags.js.map +1 -1
- package/dist/api/machine-locations.d.ts +14 -0
- package/dist/api/machine-locations.d.ts.map +1 -1
- package/dist/api/machine-locations.js +22 -0
- package/dist/api/machine-locations.js.map +1 -1
- package/dist/api/map-layers.d.ts +83 -13
- package/dist/api/map-layers.d.ts.map +1 -1
- package/dist/api/map-layers.js +121 -19
- package/dist/api/map-layers.js.map +1 -1
- package/dist/api/notifications.d.ts +6 -6
- package/dist/api/notifications.d.ts.map +1 -1
- package/dist/api/notifications.js +9 -9
- package/dist/api/notifications.js.map +1 -1
- package/dist/api/products.d.ts +296 -10
- package/dist/api/products.d.ts.map +1 -1
- package/dist/api/products.js +423 -13
- package/dist/api/products.js.map +1 -1
- package/dist/api/webhook.d.ts +13 -0
- package/dist/api/webhook.d.ts.map +1 -1
- package/dist/api/webhook.js +19 -0
- package/dist/api/webhook.js.map +1 -1
- package/dist/api-servers.generated.d.ts +0 -1
- package/dist/api-servers.generated.d.ts.map +1 -1
- package/dist/api-servers.generated.js +0 -1
- package/dist/api-servers.generated.js.map +1 -1
- package/dist/hateoas-map.d.ts.map +1 -1
- package/dist/hateoas-map.js +65 -0
- package/dist/hateoas-map.js.map +1 -1
- package/dist/types/generated/assets.d.ts +256 -256
- package/dist/types/generated/assets.d.ts.map +1 -1
- package/dist/types/generated/boundaries.d.ts +475 -475
- package/dist/types/generated/boundaries.d.ts.map +1 -1
- package/dist/types/generated/clients.d.ts +163 -163
- package/dist/types/generated/clients.d.ts.map +1 -1
- package/dist/types/generated/connection-management.d.ts +21 -21
- package/dist/types/generated/connection-management.d.ts.map +1 -1
- package/dist/types/generated/crop-types.d.ts +30 -30
- package/dist/types/generated/crop-types.d.ts.map +1 -1
- package/dist/types/generated/equipment-measurement.d.ts +85 -85
- package/dist/types/generated/equipment-measurement.d.ts.map +1 -1
- package/dist/types/generated/equipment.d.ts +1202 -1202
- package/dist/types/generated/equipment.d.ts.map +1 -1
- package/dist/types/generated/farms.d.ts +122 -122
- package/dist/types/generated/farms.d.ts.map +1 -1
- package/dist/types/generated/field-operations-api.d.ts +1103 -846
- package/dist/types/generated/field-operations-api.d.ts.map +1 -1
- package/dist/types/generated/fields.d.ts +357 -357
- package/dist/types/generated/fields.d.ts.map +1 -1
- package/dist/types/generated/files.d.ts +435 -113
- package/dist/types/generated/files.d.ts.map +1 -1
- package/dist/types/generated/flags.d.ts +779 -77
- package/dist/types/generated/flags.d.ts.map +1 -1
- package/dist/types/generated/guidance-lines.d.ts +41 -41
- package/dist/types/generated/guidance-lines.d.ts.map +1 -1
- package/dist/types/generated/harvest-id.d.ts +137 -137
- package/dist/types/generated/harvest-id.d.ts.map +1 -1
- package/dist/types/generated/index.d.ts +1 -1
- package/dist/types/generated/index.js +1 -1
- package/dist/types/generated/machine-alerts.d.ts +114 -114
- package/dist/types/generated/machine-alerts.d.ts.map +1 -1
- package/dist/types/generated/machine-device-state-reports.d.ts +12 -12
- package/dist/types/generated/machine-device-state-reports.d.ts.map +1 -1
- package/dist/types/generated/machine-engine-hours.d.ts +19 -19
- package/dist/types/generated/machine-engine-hours.d.ts.map +1 -1
- package/dist/types/generated/machine-hours-of-operation.d.ts +20 -20
- package/dist/types/generated/machine-hours-of-operation.d.ts.map +1 -1
- package/dist/types/generated/machine-locations.d.ts +247 -1
- package/dist/types/generated/machine-locations.d.ts.map +1 -1
- package/dist/types/generated/map-layers.d.ts +957 -293
- package/dist/types/generated/map-layers.d.ts.map +1 -1
- package/dist/types/generated/notifications.d.ts +126 -126
- package/dist/types/generated/notifications.d.ts.map +1 -1
- package/dist/types/generated/operators.d.ts +21 -21
- package/dist/types/generated/operators.d.ts.map +1 -1
- package/dist/types/generated/organizations.d.ts +33 -33
- package/dist/types/generated/organizations.d.ts.map +1 -1
- package/dist/types/generated/partnerships.d.ts +61 -61
- package/dist/types/generated/partnerships.d.ts.map +1 -1
- package/dist/types/generated/products.d.ts +5162 -456
- package/dist/types/generated/products.d.ts.map +1 -1
- package/dist/types/generated/webhook.d.ts +299 -137
- package/dist/types/generated/webhook.d.ts.map +1 -1
- package/package.json +2 -1
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
* Do not make direct changes to the file.
|
|
4
4
|
*/
|
|
5
5
|
export interface paths {
|
|
6
|
-
'/
|
|
6
|
+
'/fileResources/{id}': {
|
|
7
7
|
parameters: {
|
|
8
8
|
query?: never;
|
|
9
9
|
header?: never;
|
|
@@ -11,54 +11,73 @@ export interface paths {
|
|
|
11
11
|
cookie?: never;
|
|
12
12
|
};
|
|
13
13
|
/**
|
|
14
|
-
*
|
|
15
|
-
* @description This resource
|
|
14
|
+
* View/Download a File Resource
|
|
15
|
+
* @description This resource allows the client to view or download a File Resource. To view a File Resource's metadata, set the application/vnd.deere.axiom.v3+json Accept Header. To download the File Resource itself, choose a zip or octet-stream Accept Header.
|
|
16
16
|
*/
|
|
17
17
|
get: {
|
|
18
18
|
parameters: {
|
|
19
|
-
query?:
|
|
20
|
-
/** @description Set includePartialSummaries to true to include Map Layer Summaries without File Resources. */
|
|
21
|
-
includePartialSummaries?: components['parameters']['includePartialSummaries'];
|
|
22
|
-
/** @description Takes these values mapLayers. */
|
|
23
|
-
embed?: components['parameters']['embed'];
|
|
24
|
-
};
|
|
19
|
+
query?: never;
|
|
25
20
|
header?: never;
|
|
26
21
|
path: {
|
|
27
|
-
/** @description
|
|
28
|
-
|
|
29
|
-
/** @description Field ID */
|
|
30
|
-
fieldId: components['parameters']['fieldId'];
|
|
22
|
+
/** @description File Resource ID */
|
|
23
|
+
id: components['parameters']['fileId_FileResources'];
|
|
31
24
|
};
|
|
32
25
|
cookie?: never;
|
|
33
26
|
};
|
|
34
27
|
requestBody?: never;
|
|
35
28
|
responses: {
|
|
36
|
-
200: components['schemas']['
|
|
29
|
+
200: components['schemas']['GetFileResponseDetails'];
|
|
37
30
|
};
|
|
38
31
|
};
|
|
39
|
-
put?: never;
|
|
40
32
|
/**
|
|
41
|
-
*
|
|
42
|
-
* @description
|
|
33
|
+
* Upload a File Resource
|
|
34
|
+
* @description Uploads a binary File Resource for a given Map Layer. The client must first create a File Resource ID by calling POST /mapLayers/{id}/fileResources API before uploading. Check the status of the upload by requesting the File Resource's targetResource Link.
|
|
43
35
|
*/
|
|
44
|
-
|
|
36
|
+
put: {
|
|
45
37
|
parameters: {
|
|
46
38
|
query?: never;
|
|
47
39
|
header?: never;
|
|
48
40
|
path: {
|
|
49
|
-
/** @description
|
|
50
|
-
|
|
51
|
-
/** @description Field ID */
|
|
52
|
-
fieldId: components['parameters']['fieldId'];
|
|
41
|
+
/** @description File Resource ID */
|
|
42
|
+
id: components['parameters']['fileId_FileResources'];
|
|
53
43
|
};
|
|
54
44
|
cookie?: never;
|
|
55
45
|
};
|
|
56
|
-
requestBody?:
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
46
|
+
requestBody?: never;
|
|
47
|
+
responses: {
|
|
48
|
+
/** @description Created */
|
|
49
|
+
200: {
|
|
50
|
+
headers: {
|
|
51
|
+
[name: string]: unknown;
|
|
52
|
+
};
|
|
53
|
+
content: {
|
|
54
|
+
'application/vnd.deere.axiom.v3+json': {
|
|
55
|
+
/**
|
|
56
|
+
* Format: int32
|
|
57
|
+
* @example 1
|
|
58
|
+
*/
|
|
59
|
+
total?: number;
|
|
60
|
+
};
|
|
61
|
+
};
|
|
62
|
+
};
|
|
63
|
+
};
|
|
64
|
+
};
|
|
65
|
+
post?: never;
|
|
66
|
+
/**
|
|
67
|
+
* Delete a File Resource
|
|
68
|
+
* @description Deletes a file resource.
|
|
69
|
+
*/
|
|
70
|
+
delete: {
|
|
71
|
+
parameters: {
|
|
72
|
+
query?: never;
|
|
73
|
+
header?: never;
|
|
74
|
+
path: {
|
|
75
|
+
/** @description File Resource ID */
|
|
76
|
+
id: components['parameters']['fileId_FileResources'];
|
|
60
77
|
};
|
|
78
|
+
cookie?: never;
|
|
61
79
|
};
|
|
80
|
+
requestBody?: never;
|
|
62
81
|
responses: {
|
|
63
82
|
/** @description Created */
|
|
64
83
|
200: {
|
|
@@ -66,19 +85,17 @@ export interface paths {
|
|
|
66
85
|
[name: string]: unknown;
|
|
67
86
|
};
|
|
68
87
|
content: {
|
|
69
|
-
'application/vnd.deere.axiom.v3+json':
|
|
88
|
+
'application/vnd.deere.axiom.v3+json': {
|
|
89
|
+
/**
|
|
90
|
+
* Format: int32
|
|
91
|
+
* @example 1
|
|
92
|
+
*/
|
|
93
|
+
total?: number;
|
|
94
|
+
};
|
|
70
95
|
};
|
|
71
96
|
};
|
|
72
|
-
400: components['responses']['400'];
|
|
73
|
-
401: components['responses']['401'];
|
|
74
|
-
403: components['responses']['403'];
|
|
75
|
-
404: components['responses']['404'];
|
|
76
|
-
406: components['responses']['406'];
|
|
77
|
-
415: components['responses']['415'];
|
|
78
|
-
429: components['responses']['429'];
|
|
79
97
|
};
|
|
80
98
|
};
|
|
81
|
-
delete?: never;
|
|
82
99
|
options?: never;
|
|
83
100
|
head?: never;
|
|
84
101
|
patch?: never;
|
|
@@ -171,57 +188,858 @@ export interface paths {
|
|
|
171
188
|
patch?: never;
|
|
172
189
|
trace?: never;
|
|
173
190
|
};
|
|
174
|
-
}
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
/** @example Link */
|
|
181
|
-
'@type'?: string;
|
|
182
|
-
/**
|
|
183
|
-
* @description The relation of the object to the linked resource.
|
|
184
|
-
* @example owningOrganization
|
|
185
|
-
*/
|
|
186
|
-
rel?: string;
|
|
187
|
-
/**
|
|
188
|
-
* Format: uri
|
|
189
|
-
* @description The URI to the related resource.
|
|
190
|
-
* @example https://api.deere.com/platform/organizations/61265
|
|
191
|
-
*/
|
|
192
|
-
uri?: string;
|
|
191
|
+
'/mapLayerSummaries/{id}/mapLayers': {
|
|
192
|
+
parameters: {
|
|
193
|
+
query?: never;
|
|
194
|
+
header?: never;
|
|
195
|
+
path?: never;
|
|
196
|
+
cookie?: never;
|
|
193
197
|
};
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
|
|
204
|
-
|
|
205
|
-
|
|
206
|
-
|
|
207
|
-
|
|
208
|
-
|
|
209
|
-
|
|
198
|
+
/**
|
|
199
|
+
* List Map Layers
|
|
200
|
+
* @description This resource lists all Map Layers for a specific Map Layer Summary. Note: This API does not support eTags.
|
|
201
|
+
*/
|
|
202
|
+
get: {
|
|
203
|
+
parameters: {
|
|
204
|
+
query?: {
|
|
205
|
+
/** @description Set includePartialLayers to true to include Map Layers without File Resources. */
|
|
206
|
+
includePartialLayers?: components['parameters']['includePartialLayers'];
|
|
207
|
+
};
|
|
208
|
+
header?: never;
|
|
209
|
+
path: {
|
|
210
|
+
/** @description Map Layer Summary ID */
|
|
211
|
+
id: components['parameters']['id_MapLayers'];
|
|
212
|
+
};
|
|
213
|
+
cookie?: never;
|
|
214
|
+
};
|
|
215
|
+
requestBody?: never;
|
|
216
|
+
responses: {
|
|
217
|
+
200: components['schemas']['MapLayerCollection_MapLayers'];
|
|
218
|
+
};
|
|
219
|
+
};
|
|
220
|
+
put?: never;
|
|
221
|
+
/**
|
|
222
|
+
* Create a Map Layer
|
|
223
|
+
* @description Creates a new Map Layer resource.
|
|
224
|
+
*/
|
|
225
|
+
post: {
|
|
226
|
+
parameters: {
|
|
227
|
+
query?: never;
|
|
228
|
+
header?: never;
|
|
229
|
+
path: {
|
|
230
|
+
/** @description Map Layer Summary ID */
|
|
231
|
+
id: components['parameters']['id_MapLayers'];
|
|
232
|
+
};
|
|
233
|
+
cookie?: never;
|
|
234
|
+
};
|
|
235
|
+
requestBody?: {
|
|
236
|
+
content: {
|
|
237
|
+
'application/vnd.deere.axiom.v3+json': components['schemas']['PostResponse_MapLayers'];
|
|
238
|
+
'Create Map Layer': unknown;
|
|
239
|
+
};
|
|
240
|
+
};
|
|
241
|
+
responses: {
|
|
242
|
+
/** @description Created */
|
|
243
|
+
200: {
|
|
244
|
+
headers: {
|
|
245
|
+
[name: string]: unknown;
|
|
246
|
+
};
|
|
247
|
+
content: {
|
|
248
|
+
'application/vnd.deere.axiom.v3+json': {
|
|
249
|
+
/**
|
|
250
|
+
* Format: int32
|
|
251
|
+
* @description Number of results in the list
|
|
252
|
+
* @example 761
|
|
253
|
+
*/
|
|
254
|
+
total?: number;
|
|
255
|
+
};
|
|
256
|
+
};
|
|
257
|
+
};
|
|
258
|
+
};
|
|
259
|
+
};
|
|
260
|
+
delete?: never;
|
|
261
|
+
options?: never;
|
|
262
|
+
head?: never;
|
|
263
|
+
patch?: never;
|
|
264
|
+
trace?: never;
|
|
265
|
+
};
|
|
266
|
+
'/mapLayers/{id}': {
|
|
267
|
+
parameters: {
|
|
268
|
+
query?: never;
|
|
269
|
+
header?: never;
|
|
270
|
+
path?: never;
|
|
271
|
+
cookie?: never;
|
|
272
|
+
};
|
|
273
|
+
/**
|
|
274
|
+
* View a Map Layer
|
|
275
|
+
* @description Returns a specific Map Layer resource.
|
|
276
|
+
*/
|
|
277
|
+
get: {
|
|
278
|
+
parameters: {
|
|
279
|
+
query?: never;
|
|
280
|
+
header?: never;
|
|
281
|
+
path: {
|
|
282
|
+
/** @description Map Layer ID */
|
|
283
|
+
id: components['parameters']['getId'];
|
|
284
|
+
};
|
|
285
|
+
cookie?: never;
|
|
286
|
+
};
|
|
287
|
+
requestBody?: never;
|
|
288
|
+
responses: {
|
|
289
|
+
/** @description Created */
|
|
290
|
+
200: {
|
|
291
|
+
headers: {
|
|
292
|
+
[name: string]: unknown;
|
|
293
|
+
};
|
|
294
|
+
content: {
|
|
295
|
+
'application/vnd.deere.axiom.v3+json': {
|
|
296
|
+
values?: unknown;
|
|
297
|
+
links?: unknown;
|
|
298
|
+
};
|
|
299
|
+
};
|
|
300
|
+
};
|
|
301
|
+
};
|
|
302
|
+
};
|
|
303
|
+
put?: never;
|
|
304
|
+
post?: never;
|
|
305
|
+
/**
|
|
306
|
+
* Delete a Map Layer
|
|
307
|
+
* @description Deletes a Map Layer and its underlying File Resource.
|
|
308
|
+
*/
|
|
309
|
+
delete: {
|
|
310
|
+
parameters: {
|
|
311
|
+
query?: never;
|
|
312
|
+
header?: never;
|
|
313
|
+
path: {
|
|
314
|
+
/** @description Map Layer ID */
|
|
315
|
+
id: components['parameters']['getMapId'];
|
|
316
|
+
};
|
|
317
|
+
cookie?: never;
|
|
318
|
+
};
|
|
319
|
+
requestBody?: never;
|
|
320
|
+
responses: {
|
|
321
|
+
/** @description Deleted */
|
|
322
|
+
200: {
|
|
323
|
+
headers: {
|
|
324
|
+
[name: string]: unknown;
|
|
325
|
+
};
|
|
326
|
+
content: {
|
|
327
|
+
'application/vnd.deere.axiom.v3+json': {
|
|
328
|
+
/**
|
|
329
|
+
* Format: int32
|
|
330
|
+
* @example 1
|
|
331
|
+
*/
|
|
332
|
+
total?: number;
|
|
333
|
+
};
|
|
334
|
+
};
|
|
335
|
+
};
|
|
336
|
+
};
|
|
337
|
+
};
|
|
338
|
+
options?: never;
|
|
339
|
+
head?: never;
|
|
340
|
+
patch?: never;
|
|
341
|
+
trace?: never;
|
|
342
|
+
};
|
|
343
|
+
'/mapLayers/{id}/fileResources': {
|
|
344
|
+
parameters: {
|
|
345
|
+
query?: never;
|
|
346
|
+
header?: never;
|
|
347
|
+
path?: never;
|
|
348
|
+
cookie?: never;
|
|
349
|
+
};
|
|
350
|
+
/**
|
|
351
|
+
* Get a Map Layer File Resource
|
|
352
|
+
* @description This resource will return the File Resource associated to the specified Map Layer. Note: This API does not support eTags.
|
|
353
|
+
*/
|
|
354
|
+
get: {
|
|
355
|
+
parameters: {
|
|
356
|
+
query?: never;
|
|
357
|
+
header?: never;
|
|
358
|
+
path: {
|
|
359
|
+
/** @description Map Layer ID */
|
|
360
|
+
id: components['parameters']['id_FileResources'];
|
|
361
|
+
};
|
|
362
|
+
cookie?: never;
|
|
363
|
+
};
|
|
364
|
+
requestBody?: never;
|
|
365
|
+
responses: {
|
|
366
|
+
200: components['schemas']['GetFileResponse'];
|
|
367
|
+
};
|
|
368
|
+
};
|
|
369
|
+
put?: never;
|
|
370
|
+
/**
|
|
371
|
+
* Create a Map Layer File Resource
|
|
372
|
+
* @description This resource will create a new File Resource for a Map Layer.
|
|
373
|
+
*/
|
|
374
|
+
post: {
|
|
375
|
+
parameters: {
|
|
376
|
+
query?: never;
|
|
377
|
+
header?: never;
|
|
378
|
+
path: {
|
|
379
|
+
/** @description Map Layer ID */
|
|
380
|
+
id: components['parameters']['id_FileResources'];
|
|
381
|
+
};
|
|
382
|
+
cookie?: never;
|
|
383
|
+
};
|
|
384
|
+
requestBody?: {
|
|
385
|
+
content: {
|
|
386
|
+
'application/vnd.deere.axiom.v3+json': components['schemas']['RequestDetails'];
|
|
387
|
+
'Create a new File Resource': unknown;
|
|
388
|
+
};
|
|
389
|
+
};
|
|
390
|
+
responses: {
|
|
391
|
+
200: components['schemas']['PostFileResponse'];
|
|
392
|
+
};
|
|
393
|
+
};
|
|
394
|
+
delete?: never;
|
|
395
|
+
options?: never;
|
|
396
|
+
head?: never;
|
|
397
|
+
patch?: never;
|
|
398
|
+
trace?: never;
|
|
399
|
+
};
|
|
400
|
+
'/mapLayers/{mapLayerId}': {
|
|
401
|
+
parameters: {
|
|
402
|
+
query?: never;
|
|
403
|
+
header?: never;
|
|
404
|
+
path?: never;
|
|
405
|
+
cookie?: never;
|
|
406
|
+
};
|
|
407
|
+
/**
|
|
408
|
+
* Extract Map Layer Image
|
|
409
|
+
* @description Returns the image file associated with the Map Layer resource.
|
|
410
|
+
*/
|
|
411
|
+
get: {
|
|
412
|
+
parameters: {
|
|
413
|
+
query?: never;
|
|
414
|
+
header?: never;
|
|
415
|
+
path: {
|
|
416
|
+
/** @description Map Layer ID */
|
|
417
|
+
id: components['parameters']['getMapId'];
|
|
418
|
+
};
|
|
419
|
+
cookie?: never;
|
|
420
|
+
};
|
|
421
|
+
requestBody?: never;
|
|
422
|
+
responses: {
|
|
423
|
+
/** @description Created */
|
|
424
|
+
200: {
|
|
425
|
+
headers: {
|
|
426
|
+
[name: string]: unknown;
|
|
427
|
+
};
|
|
428
|
+
content: {
|
|
429
|
+
'image/png OR application/octet-stream': unknown;
|
|
430
|
+
};
|
|
431
|
+
};
|
|
432
|
+
};
|
|
433
|
+
};
|
|
434
|
+
put?: never;
|
|
435
|
+
post?: never;
|
|
436
|
+
delete?: never;
|
|
437
|
+
options?: never;
|
|
438
|
+
head?: never;
|
|
439
|
+
patch?: never;
|
|
440
|
+
trace?: never;
|
|
441
|
+
};
|
|
442
|
+
'/organizations/{orgId}/fields/{id}/mapLayerSummaries': {
|
|
443
|
+
parameters: {
|
|
444
|
+
query?: never;
|
|
445
|
+
header?: never;
|
|
446
|
+
path?: never;
|
|
447
|
+
cookie?: never;
|
|
448
|
+
};
|
|
449
|
+
/**
|
|
450
|
+
* List Map Layer Summaries
|
|
451
|
+
* @description This resource will list all Map Layer Summaries for a specified field.
|
|
452
|
+
*/
|
|
453
|
+
get: {
|
|
454
|
+
parameters: {
|
|
455
|
+
query?: {
|
|
456
|
+
/** @description Set includePartialSummaries to true to include Map Layer Summaries without File Resources. */
|
|
457
|
+
includePartialSummaries?: components['parameters']['includePartialSummaries'];
|
|
458
|
+
/** @description Takes these values mapLayers. */
|
|
459
|
+
embed?: components['parameters']['embed'];
|
|
460
|
+
};
|
|
461
|
+
header?: never;
|
|
462
|
+
path: {
|
|
463
|
+
/** @description Organization ID */
|
|
464
|
+
orgId: components['parameters']['OrganizationId'];
|
|
465
|
+
/** @description Field ID */
|
|
466
|
+
fieldId: components['parameters']['fieldId'];
|
|
467
|
+
};
|
|
468
|
+
cookie?: never;
|
|
469
|
+
};
|
|
470
|
+
requestBody?: never;
|
|
471
|
+
responses: {
|
|
472
|
+
200: components['schemas']['MapLayerSummaryCollection'];
|
|
473
|
+
};
|
|
474
|
+
};
|
|
475
|
+
put?: never;
|
|
476
|
+
/**
|
|
477
|
+
* Create a map layer summary
|
|
478
|
+
* @description Creates a new Map Layer Summary resource.
|
|
479
|
+
*/
|
|
480
|
+
post: {
|
|
481
|
+
parameters: {
|
|
482
|
+
query?: never;
|
|
483
|
+
header?: never;
|
|
484
|
+
path: {
|
|
485
|
+
/** @description Organization ID */
|
|
486
|
+
orgId: components['parameters']['OrganizationId'];
|
|
487
|
+
/** @description Field ID */
|
|
488
|
+
fieldId: components['parameters']['fieldId'];
|
|
489
|
+
};
|
|
490
|
+
cookie?: never;
|
|
491
|
+
};
|
|
492
|
+
requestBody?: {
|
|
493
|
+
content: {
|
|
494
|
+
'application/vnd.deere.axiom.v3+json': components['schemas']['PostRequest'];
|
|
495
|
+
'Create Map Layer Summary': unknown;
|
|
496
|
+
};
|
|
497
|
+
};
|
|
498
|
+
responses: {
|
|
499
|
+
/** @description Created */
|
|
500
|
+
200: {
|
|
501
|
+
headers: {
|
|
502
|
+
[name: string]: unknown;
|
|
503
|
+
};
|
|
504
|
+
content: {
|
|
505
|
+
'application/vnd.deere.axiom.v3+json': unknown;
|
|
506
|
+
};
|
|
507
|
+
};
|
|
508
|
+
400: components['responses']['400'];
|
|
509
|
+
401: components['responses']['401'];
|
|
510
|
+
403: components['responses']['403'];
|
|
511
|
+
404: components['responses']['404'];
|
|
512
|
+
406: components['responses']['406'];
|
|
513
|
+
415: components['responses']['415'];
|
|
514
|
+
429: components['responses']['429'];
|
|
515
|
+
};
|
|
516
|
+
};
|
|
517
|
+
delete?: never;
|
|
518
|
+
options?: never;
|
|
519
|
+
head?: never;
|
|
520
|
+
patch?: never;
|
|
521
|
+
trace?: never;
|
|
522
|
+
};
|
|
523
|
+
}
|
|
524
|
+
export type webhooks = Record<string, never>;
|
|
525
|
+
export interface components {
|
|
526
|
+
schemas: {
|
|
527
|
+
'400Errors': {
|
|
528
|
+
/** @example Errors */
|
|
529
|
+
'@type'?: string;
|
|
530
|
+
errors?: {
|
|
531
|
+
/** @example Error */
|
|
532
|
+
'@type'?: string;
|
|
533
|
+
/**
|
|
534
|
+
* Format: uuid
|
|
535
|
+
* @example ed292512-1f3c-4285-83c3-1fb084423f9b
|
|
536
|
+
*/
|
|
537
|
+
guid?: string;
|
|
538
|
+
/** @example This field is required. */
|
|
539
|
+
message?: string;
|
|
540
|
+
/** @example validation_constraint_required_field */
|
|
541
|
+
code?: string;
|
|
542
|
+
/** @example title */
|
|
543
|
+
field?: string;
|
|
544
|
+
}[];
|
|
545
|
+
otherAttributes?: Record<string, never>;
|
|
546
|
+
};
|
|
547
|
+
AvailableLinks: {
|
|
548
|
+
/**
|
|
549
|
+
* @description This Map Layer List Link.
|
|
550
|
+
* @example https://sandboxapi.deere.com/platform/organizations/ORG_ID/fields/FIELD_ID/mapLayerSummaries
|
|
551
|
+
*/
|
|
552
|
+
'self (map layer summaries list)'?: unknown;
|
|
553
|
+
/**
|
|
554
|
+
* @description This Map Layer Summary Link.
|
|
555
|
+
* @example https://sandboxapi.deere.com/platform/mapLayerSummaries/MAP_LAYER_SUMMARY_ID
|
|
556
|
+
*/
|
|
557
|
+
'self (map layer summary)'?: unknown;
|
|
558
|
+
/**
|
|
559
|
+
* @description Organizations Link.
|
|
560
|
+
* @example https://sandboxapi.deere.com/platform/organizations/ORG_ID
|
|
561
|
+
*/
|
|
562
|
+
owningOrganization?: unknown;
|
|
563
|
+
/**
|
|
564
|
+
* @description Fields Link.
|
|
565
|
+
* @example https://sandboxapi.deere.com/platform/organizations/ORG_ID/fields/FIELD_ID
|
|
566
|
+
*/
|
|
567
|
+
targetResource?: unknown;
|
|
568
|
+
/**
|
|
569
|
+
* @description Map Layers Link.
|
|
570
|
+
* @example https://sandboxapi.deere.com/platform/mapLayerSummaries/MAP_LAYER_SUMMARY_ID/mapLayers
|
|
571
|
+
*/
|
|
572
|
+
mapLayers?: unknown;
|
|
573
|
+
/**
|
|
574
|
+
* @description Create Map Layers Link.
|
|
575
|
+
* @example https://sandboxapi.deere.com/platform/mapLayerSummaries/MAP_LAYER_SUMMARY_ID/mapLayers
|
|
576
|
+
*/
|
|
577
|
+
createMapLayer?: unknown;
|
|
578
|
+
};
|
|
579
|
+
AvailableLinks_FileResources: {
|
|
580
|
+
/**
|
|
581
|
+
* @description This File Resource Link.
|
|
582
|
+
* @example https://sandboxapi.deere.com/platform/fileResources/FILE_RESOURCE_ID
|
|
583
|
+
*/
|
|
584
|
+
self?: unknown;
|
|
585
|
+
/**
|
|
586
|
+
* @description Organizations Link.
|
|
587
|
+
* @example https://sandboxapi.deere.com/platform/organizations/ORG_ID
|
|
588
|
+
*/
|
|
589
|
+
owningOrganization?: unknown;
|
|
590
|
+
/**
|
|
591
|
+
* @description Map Layers Link.
|
|
592
|
+
* @example https://sandboxapi.deere.com/platform/mapLayers/MAP_LAYER_ID
|
|
593
|
+
*/
|
|
594
|
+
targetResource?: unknown;
|
|
595
|
+
};
|
|
596
|
+
AvailableLinks_MapLayers: {
|
|
597
|
+
/**
|
|
598
|
+
* @description This Map Layer List Link.
|
|
599
|
+
* @example https://sandboxapi.deere.com/platform/mapLayerSummaries/MAP_LAYER_SUMMARY_ID/mapLayers
|
|
600
|
+
*/
|
|
601
|
+
'self (map list)'?: unknown;
|
|
602
|
+
/**
|
|
603
|
+
* @description This Map Layer Link.
|
|
604
|
+
* @example https://sandboxapi.deere.com/platform/mapLayers/MAP_LAYER_ID
|
|
605
|
+
*/
|
|
606
|
+
'self (map layer)'?: unknown;
|
|
607
|
+
/**
|
|
608
|
+
* @description Organizations Link.
|
|
609
|
+
* @example https://sandboxapi.deere.com/platform/organizations/ORG_ID
|
|
610
|
+
*/
|
|
611
|
+
owningOrganization?: unknown;
|
|
612
|
+
/**
|
|
613
|
+
* @description Map Layer Summary Link.
|
|
614
|
+
* @example https://sandboxapi.deere.com/platform/mapLayerSummaries/MAP_LAYER_SUMMARY_ID
|
|
615
|
+
*/
|
|
616
|
+
mapLayerSummary?: unknown;
|
|
617
|
+
/**
|
|
618
|
+
* @description Map Layer's File Resources Link.
|
|
619
|
+
* @example https://sandboxapi.deere.com/platform/mapLayers/MAP_LAYER_ID/fileResources
|
|
620
|
+
*/
|
|
621
|
+
fileResources?: unknown;
|
|
622
|
+
/**
|
|
623
|
+
* @description Map Layer's PNG Image Link.
|
|
624
|
+
* @example https://sandboxapi.deere.com/platform/mapLayers/MAP_LAYER_ID/image
|
|
625
|
+
*/
|
|
626
|
+
image?: unknown;
|
|
627
|
+
/**
|
|
628
|
+
* @description Map Layer's File Resources Link.
|
|
629
|
+
* @example https://sandboxapi.deere.com/platform/mapLayers/MAP_LAYER_ID/fileResources
|
|
630
|
+
*/
|
|
631
|
+
createFileResource?: unknown;
|
|
632
|
+
};
|
|
633
|
+
CollectionBase: {
|
|
634
|
+
links?: {
|
|
635
|
+
/**
|
|
636
|
+
* @description Links relavent to exploring the collection.
|
|
637
|
+
* @example self
|
|
638
|
+
*/
|
|
639
|
+
rel?: string;
|
|
640
|
+
/**
|
|
641
|
+
* Format: uri
|
|
642
|
+
* @description The URI to the related resource.
|
|
643
|
+
* @example https://api.deere.com/platform/organizations/61265/fields/42849709-5d54-473a-9eba-adab6f4bc8a8/mapLayerSummaries
|
|
644
|
+
*/
|
|
645
|
+
uri?: string;
|
|
646
|
+
}[];
|
|
647
|
+
/** @example 1 */
|
|
648
|
+
total?: number;
|
|
649
|
+
};
|
|
650
|
+
ContributedMapLayer: {
|
|
651
|
+
/** @example ContributedMapLayer */
|
|
652
|
+
'@type'?: string;
|
|
653
|
+
/**
|
|
654
|
+
* @description The title on the map layer.
|
|
655
|
+
* @example Drone Flyover
|
|
656
|
+
*/
|
|
657
|
+
title: string;
|
|
658
|
+
extent?: components['schemas']['MapExtent'];
|
|
659
|
+
/**
|
|
660
|
+
* @description A value to sort the Map Layer by in Field Analyzer Beta. Defaults to `title` if not provided.
|
|
661
|
+
* @example 1
|
|
662
|
+
*/
|
|
663
|
+
sortName?: string;
|
|
664
|
+
legends: components['schemas']['MapLegend'];
|
|
665
|
+
/**
|
|
666
|
+
* @description Map layer status.
|
|
667
|
+
* @enum {string}
|
|
668
|
+
*/
|
|
669
|
+
readonly status?: 'VALID' | 'INVALID' | 'QUEUED' | 'NO_FILE_RESOURCE';
|
|
670
|
+
/**
|
|
671
|
+
* @description Description of the map layer.
|
|
672
|
+
* @example An aerial view of the building.
|
|
673
|
+
*/
|
|
674
|
+
text?: string;
|
|
675
|
+
metadata?: components['schemas']['Metadata'][];
|
|
676
|
+
/**
|
|
677
|
+
* @description The primary identifier for the operation.
|
|
678
|
+
* @example 8a0011f1-297e-48c2-a030-91a21287e721
|
|
679
|
+
*/
|
|
680
|
+
readonly id?: string;
|
|
681
|
+
links?: components['schemas']['Link'][];
|
|
682
|
+
};
|
|
683
|
+
ContributedMapLayerSummary: {
|
|
684
|
+
/**
|
|
685
|
+
* @description Links to other objects in the Deere ecosystem.
|
|
686
|
+
* @example See "Available Links" below
|
|
687
|
+
*/
|
|
688
|
+
links?: unknown[];
|
|
689
|
+
/**
|
|
690
|
+
* @description Count of Map Layer Summaries in response.
|
|
691
|
+
* @example 3
|
|
692
|
+
*/
|
|
693
|
+
total?: number;
|
|
694
|
+
/** @description The primary resource listing. */
|
|
695
|
+
values?: unknown[];
|
|
696
|
+
};
|
|
697
|
+
ContributedMapLayer_FileResources: {
|
|
698
|
+
/**
|
|
699
|
+
* @description Links to other objects in the Deere ecosystem.
|
|
700
|
+
* @example See "Available Links" below Readonly: Yes, except owningOrganization
|
|
701
|
+
*/
|
|
702
|
+
links?: unknown[];
|
|
703
|
+
/**
|
|
704
|
+
* @description File Resource ID
|
|
705
|
+
* @example 83ks9gh3-29fj-9302-837j-92jlsk92jd095kd Readonly: Yes
|
|
706
|
+
*/
|
|
707
|
+
id?: string;
|
|
708
|
+
/**
|
|
709
|
+
* @description An array of key value pair items about the File Resource.
|
|
710
|
+
* @example See sample response below Readonly: No
|
|
711
|
+
*/
|
|
712
|
+
metadata?: unknown[];
|
|
713
|
+
/**
|
|
714
|
+
* @description Valid values are image/png, image/tif, image/tiff and application/zip
|
|
715
|
+
* @example image/png Readonly: No
|
|
716
|
+
*/
|
|
717
|
+
mimeType?: string;
|
|
718
|
+
/**
|
|
719
|
+
* Format: date-time
|
|
720
|
+
* @description ISO 8601 Date and time in UTC this resource was created.
|
|
721
|
+
* @example 2019-03-02T16:14:23.421Z Readonly: No
|
|
722
|
+
*/
|
|
723
|
+
timestamp?: string;
|
|
724
|
+
};
|
|
725
|
+
ContributedMapLayer_MapLayers: {
|
|
726
|
+
/**
|
|
727
|
+
* @description Links to other objects in the Deere ecosystem.
|
|
728
|
+
* @example See "Available Links" below
|
|
729
|
+
*/
|
|
730
|
+
links?: unknown[];
|
|
731
|
+
/**
|
|
732
|
+
* @description Count of Map Layer Summaries in response.
|
|
733
|
+
* @example 3
|
|
734
|
+
*/
|
|
735
|
+
total?: number;
|
|
736
|
+
/** @description The primary resource listing. */
|
|
737
|
+
values?: Record<string, never>;
|
|
738
|
+
};
|
|
739
|
+
FileResource: {
|
|
740
|
+
/** @example FileResource */
|
|
741
|
+
'@type'?: string;
|
|
742
|
+
/**
|
|
743
|
+
* @description The mimeType of the FileResource.
|
|
744
|
+
* @enum {string}
|
|
745
|
+
*/
|
|
746
|
+
mimeType?: 'image/png' | 'image/tif' | 'image/tiff' | 'application/zip';
|
|
747
|
+
/** @description The name of the file */
|
|
748
|
+
metadata: {
|
|
749
|
+
/** @example filename */
|
|
750
|
+
name?: string;
|
|
751
|
+
/** @example a_green_tractor.png */
|
|
752
|
+
value?: string;
|
|
753
|
+
}[];
|
|
754
|
+
/**
|
|
755
|
+
* @description The primary identifier for the FileResource.
|
|
756
|
+
* @example 888d97c6-cd87-48de-88d5-3c2721250a5e
|
|
757
|
+
*/
|
|
758
|
+
readonly id?: string;
|
|
759
|
+
/** @description Links for self, targetResource, and owningOrganization */
|
|
760
|
+
links: components['schemas']['Link'][];
|
|
761
|
+
};
|
|
762
|
+
FileResourceAvailableLinks: {
|
|
763
|
+
/**
|
|
764
|
+
* @description Map Layers Link.
|
|
765
|
+
* @example https://sandboxapi.deere.com/platform/fileResources/FILE_RESOURCE_ID
|
|
766
|
+
*/
|
|
767
|
+
self?: unknown;
|
|
768
|
+
/**
|
|
769
|
+
* @description Organizations Link.
|
|
770
|
+
* @example https://sandboxapi.deere.com/platform/organizations/ORG_ID
|
|
771
|
+
*/
|
|
772
|
+
owningOrganization?: unknown;
|
|
773
|
+
/**
|
|
774
|
+
* @description Map Layers Link.
|
|
775
|
+
* @example https://sandboxapi.deere.com/platform/mapLayers/MAP_LAYER_ID
|
|
776
|
+
*/
|
|
777
|
+
targetResource?: unknown;
|
|
778
|
+
};
|
|
779
|
+
FileResourceGetResponse: {
|
|
780
|
+
/**
|
|
781
|
+
* @description Links to other objects in the Deere ecosystem.
|
|
782
|
+
* @example See "Available Links" below Readonly: Yes, except owningOrganization
|
|
783
|
+
*/
|
|
784
|
+
links?: unknown[];
|
|
785
|
+
/**
|
|
786
|
+
* @description Links to other objects in the Deere ecosystem.
|
|
787
|
+
* @example See "Available Links" below Readonly: Yes
|
|
788
|
+
*/
|
|
789
|
+
id?: string;
|
|
790
|
+
/**
|
|
791
|
+
* @description An array of key value pair items about the File Resource.
|
|
792
|
+
* @example See sample response below Readonly: No
|
|
793
|
+
*/
|
|
794
|
+
metadata?: unknown[];
|
|
795
|
+
/**
|
|
796
|
+
* @description Valid values are image/png, image/tif, image/tiff and application/zip
|
|
797
|
+
* @example image/png Readonly: No
|
|
798
|
+
*/
|
|
799
|
+
mimeType?: string;
|
|
800
|
+
/**
|
|
801
|
+
* Format: date-time
|
|
802
|
+
* @description ISO 8601 Date and time in UTC this resource was created.
|
|
803
|
+
* @example 2019-03-02T16:14:23.421Z Readonly: No
|
|
804
|
+
*/
|
|
805
|
+
timestamp?: string;
|
|
806
|
+
};
|
|
807
|
+
GenericErrors: {
|
|
808
|
+
/** @example Errors */
|
|
809
|
+
'@type'?: string;
|
|
810
|
+
errors?: {
|
|
811
|
+
/** @example Error */
|
|
812
|
+
'@type'?: string;
|
|
813
|
+
/**
|
|
814
|
+
* Format: uuid
|
|
815
|
+
* @example ed292512-1f3c-4285-83c3-1fb084423f9b
|
|
816
|
+
*/
|
|
817
|
+
guid?: string;
|
|
818
|
+
/** @example The requested resource was not found */
|
|
819
|
+
message?: string;
|
|
820
|
+
}[];
|
|
821
|
+
otherAttributes?: Record<string, never>;
|
|
822
|
+
};
|
|
823
|
+
GetAvailableLinks: {
|
|
824
|
+
/**
|
|
825
|
+
* @description This Map Layer Link.
|
|
826
|
+
* @example https://sandboxapi.deere.com/platform/mapLayers/MAP_LAYER_ID
|
|
827
|
+
*/
|
|
828
|
+
self?: unknown;
|
|
829
|
+
/**
|
|
830
|
+
* @description Organizations Link.
|
|
831
|
+
* @example https://sandboxapi.deere.com/platform/organizations/ORG_ID
|
|
832
|
+
*/
|
|
833
|
+
owningOrganization?: unknown;
|
|
834
|
+
/**
|
|
835
|
+
* @description Map Layer Summary Link.
|
|
836
|
+
* @example https://sandboxapi.deere.com/platform/mapLayerSummaries/MAP_LAYER_SUMMARY_ID
|
|
837
|
+
*/
|
|
838
|
+
mapLayerSummary?: unknown;
|
|
839
|
+
/**
|
|
840
|
+
* @description Map Layer's File Resources Link.
|
|
841
|
+
* @example https://sandboxapi.deere.com/platform/mapLayers/MAP_LAYER_ID/fileResources
|
|
842
|
+
*/
|
|
843
|
+
fileResources?: unknown;
|
|
844
|
+
/**
|
|
845
|
+
* @description Map Layer's PNG Image Link.
|
|
846
|
+
* @example https://sandboxapi.deere.com/platform/mapLayers/MAP_LAYER_ID/image
|
|
847
|
+
*/
|
|
848
|
+
image?: unknown;
|
|
849
|
+
/**
|
|
850
|
+
* @description Map Layer's File Resources Link.
|
|
851
|
+
* @example https://sandboxapi.deere.com/platform/mapLayers/MAP_LAYER_ID/fileResources
|
|
852
|
+
*/
|
|
853
|
+
createFileResource?: unknown;
|
|
854
|
+
};
|
|
855
|
+
GetFileResponse: unknown;
|
|
856
|
+
GetFileResponseDetails: unknown;
|
|
857
|
+
GetMapLayerSummaryAvailableLinks: {
|
|
858
|
+
/**
|
|
859
|
+
* @description This Map Layer Summary Link.
|
|
860
|
+
* @example https://sandboxapi.deere.com/platform/mapLayerSummaries/MAP_LAYER_SUMMARY_ID
|
|
861
|
+
*/
|
|
862
|
+
self?: unknown;
|
|
863
|
+
/**
|
|
864
|
+
* @description Organizations Link.
|
|
865
|
+
* @example https://sandboxapi.deere.com/platform/organizations/ORG_ID
|
|
866
|
+
*/
|
|
867
|
+
owningOrganization?: unknown;
|
|
868
|
+
/**
|
|
869
|
+
* @description Fields Link.
|
|
870
|
+
* @example https://sandboxapi.deere.com/platform/organizations/ORG_ID/fields/FIELD_ID
|
|
871
|
+
*/
|
|
872
|
+
targetResource?: unknown;
|
|
873
|
+
/**
|
|
874
|
+
* @description Map Layers Link.
|
|
875
|
+
* @example https://sandboxapi.deere.com/platform/mapLayerSummaries/MAP_LAYER_SUMMARY_ID/mapLayers
|
|
876
|
+
*/
|
|
877
|
+
mapLayers?: unknown;
|
|
878
|
+
/**
|
|
879
|
+
* @description Create Map Layers Link.
|
|
880
|
+
* @example https://sandboxapi.deere.com/platform/mapLayerSummaries/MAP_LAYER_SUMMARY_ID/mapLayers
|
|
881
|
+
*/
|
|
882
|
+
createMapLayer?: unknown;
|
|
883
|
+
};
|
|
884
|
+
GetResponseDetails: {
|
|
885
|
+
/**
|
|
886
|
+
* @description Links to other objects in the Deere ecosystem.
|
|
887
|
+
* @example See "Map Layer Available Links" below
|
|
888
|
+
*/
|
|
889
|
+
links?: unknown[];
|
|
890
|
+
/**
|
|
891
|
+
* Format: uuid
|
|
892
|
+
* @description Map Layer ID
|
|
893
|
+
* @example 83ks9gh3-29fj-9302-837j-92jlsk92jd095kd
|
|
894
|
+
*/
|
|
895
|
+
id?: string;
|
|
896
|
+
/**
|
|
897
|
+
* @description Top level name of the Map Layer
|
|
898
|
+
* @example NDVI Layer
|
|
899
|
+
*/
|
|
900
|
+
title?: string;
|
|
901
|
+
/**
|
|
902
|
+
* @description Describes Map Layer. Supports limited .
|
|
903
|
+
* @example NDVI Layer for mid-season plant health based on near infrared
|
|
904
|
+
*/
|
|
905
|
+
text?: string;
|
|
906
|
+
/**
|
|
907
|
+
* @description An array of key value pair items about the Map Layer. Supports limited .
|
|
908
|
+
* @example See sample request below
|
|
909
|
+
*/
|
|
910
|
+
metadata?: unknown[];
|
|
911
|
+
/**
|
|
912
|
+
* @description Maximum and minimum extent of the map.
|
|
913
|
+
* @example null
|
|
914
|
+
*/
|
|
915
|
+
extent?: Record<string, never>;
|
|
916
|
+
/**
|
|
917
|
+
* @description Determines the display alphabetical sort order between this Map Layer and its peers (all the Map Layers tied to the same Map Layer Summary). Defaults to the value of title.
|
|
918
|
+
* @example null
|
|
919
|
+
*/
|
|
920
|
+
sortName?: string;
|
|
921
|
+
/**
|
|
922
|
+
* @description Keys the Map Layer's image data by color. Should represent all possible values and colors found in the Map Layer's File Resource image.
|
|
923
|
+
* @example null
|
|
924
|
+
*/
|
|
925
|
+
legends?: Record<string, never>;
|
|
926
|
+
/**
|
|
927
|
+
* @description Map Layer image processing progress.
|
|
928
|
+
* @example VALID
|
|
929
|
+
*/
|
|
930
|
+
status?: Record<string, never>;
|
|
931
|
+
};
|
|
932
|
+
/** @description Provides a reference to an associated object or list. */
|
|
933
|
+
Link: {
|
|
934
|
+
/** @example Link */
|
|
935
|
+
'@type'?: string;
|
|
936
|
+
/**
|
|
937
|
+
* @description The relation of the object to the linked resource.
|
|
938
|
+
* @example owningOrganization
|
|
939
|
+
*/
|
|
940
|
+
rel?: string;
|
|
941
|
+
/**
|
|
942
|
+
* Format: uri
|
|
943
|
+
* @description The URI to the related resource.
|
|
944
|
+
* @example https://api.deere.com/platform/organizations/61265
|
|
945
|
+
*/
|
|
946
|
+
uri?: string;
|
|
947
|
+
};
|
|
948
|
+
/** @description Extents of the field. If not provided, the FileResource must be of type `image/tiff` or `application/zip` and contain the extents. */
|
|
949
|
+
MapExtent: {
|
|
950
|
+
/** @example MapExtent */
|
|
951
|
+
'@type'?: string;
|
|
952
|
+
/**
|
|
953
|
+
* Format: double
|
|
954
|
+
* @example 41.47187948123269
|
|
955
|
+
*/
|
|
956
|
+
minimumLatitude: number;
|
|
957
|
+
/**
|
|
958
|
+
* Format: double
|
|
959
|
+
* @example 41.48192734153501
|
|
960
|
+
*/
|
|
961
|
+
maximumLatitude: number;
|
|
962
|
+
/**
|
|
963
|
+
* Format: double
|
|
964
|
+
* @example -90.43179946950056
|
|
965
|
+
*/
|
|
966
|
+
minimumLongitude: number;
|
|
967
|
+
/**
|
|
968
|
+
* Format: double
|
|
969
|
+
* @example -90.4157062154112
|
|
970
|
+
*/
|
|
971
|
+
maximumLongitude: number;
|
|
972
|
+
};
|
|
973
|
+
MapLayerCollection: components['schemas']['CollectionBase'] & {
|
|
974
|
+
values?: components['schemas']['ContributedMapLayer'][];
|
|
975
|
+
};
|
|
976
|
+
MapLayerCollection_MapLayers: unknown;
|
|
977
|
+
MapLayerSummaryCollection: unknown;
|
|
978
|
+
MapLegend: {
|
|
979
|
+
/** @example MapLegend */
|
|
980
|
+
'@type'?: string;
|
|
981
|
+
/**
|
|
982
|
+
* @description The unit of Legand
|
|
983
|
+
* @example seeds1ha-1
|
|
984
|
+
*/
|
|
985
|
+
unitId?: string;
|
|
986
|
+
ranges?: components['schemas']['MapLegendItem'][];
|
|
987
|
+
};
|
|
988
|
+
MapLegendItem: {
|
|
989
|
+
/** @example MapLegendItem */
|
|
990
|
+
'@type'?: string;
|
|
991
|
+
/**
|
|
992
|
+
* @description A label for the color
|
|
993
|
+
* @example Most profitable
|
|
994
|
+
*/
|
|
995
|
+
label?: string;
|
|
996
|
+
/**
|
|
997
|
+
* Format: double
|
|
998
|
+
* @example 10.09
|
|
999
|
+
*/
|
|
1000
|
+
minimum?: number;
|
|
1001
|
+
/**
|
|
1002
|
+
* Format: double
|
|
1003
|
+
* @example 30.18
|
|
1004
|
+
*/
|
|
1005
|
+
maximum?: number;
|
|
1006
|
+
/**
|
|
1007
|
+
* @description The hex color code corresponding to a color in the map layer image
|
|
1008
|
+
* @example #0BA74A
|
|
1009
|
+
*/
|
|
1010
|
+
hexColor?: string;
|
|
1011
|
+
/**
|
|
1012
|
+
* Format: double
|
|
1013
|
+
* @example 3.5
|
|
1014
|
+
*/
|
|
1015
|
+
percent?: number;
|
|
1016
|
+
};
|
|
1017
|
+
Metadata: {
|
|
1018
|
+
/** @example Metadata */
|
|
1019
|
+
'@type'?: string;
|
|
1020
|
+
/** @example Location */
|
|
1021
|
+
name: string;
|
|
1022
|
+
/** @example Moline, IL */
|
|
1023
|
+
value: string;
|
|
210
1024
|
};
|
|
211
|
-
|
|
212
|
-
ContributedMapLayerSummary: {
|
|
1025
|
+
PostAvailableLinks: {
|
|
213
1026
|
/**
|
|
214
|
-
* @description
|
|
215
|
-
* @example
|
|
1027
|
+
* @description Organizations Link
|
|
1028
|
+
* @example https://sandboxapi.deere.com/platform/organizations/ORG_ID
|
|
216
1029
|
*/
|
|
217
|
-
|
|
1030
|
+
owningOrganization?: unknown;
|
|
218
1031
|
/**
|
|
219
|
-
* @description
|
|
220
|
-
* @example
|
|
1032
|
+
* @description Contribution Definitions Link.
|
|
1033
|
+
* @example https://sandboxapi.deere.com/platform/contributionDefinitions/DEFINITION_ID
|
|
221
1034
|
*/
|
|
222
|
-
|
|
223
|
-
|
|
224
|
-
|
|
1035
|
+
contributionDefinition?: unknown;
|
|
1036
|
+
};
|
|
1037
|
+
PostAvailableLinks_FileResources: {
|
|
1038
|
+
/**
|
|
1039
|
+
* @description Organizations Link.
|
|
1040
|
+
* @example https://sandboxapi.deere.com/platform/organizations/ORG_ID
|
|
1041
|
+
*/
|
|
1042
|
+
owningOrganization?: unknown;
|
|
225
1043
|
};
|
|
226
1044
|
PostContributedMapLayerSummary: {
|
|
227
1045
|
/**
|
|
@@ -268,38 +1086,7 @@ export interface components {
|
|
|
268
1086
|
*/
|
|
269
1087
|
lastModifiedDate?: string;
|
|
270
1088
|
};
|
|
271
|
-
|
|
272
|
-
/**
|
|
273
|
-
* @description This Map Layer List Link.
|
|
274
|
-
* @example https://sandboxapi.deere.com/platform/organizations/ORG_ID/fields/FIELD_ID/mapLayerSummaries
|
|
275
|
-
*/
|
|
276
|
-
'self (map layer summaries list)'?: unknown;
|
|
277
|
-
/**
|
|
278
|
-
* @description This Map Layer Summary Link.
|
|
279
|
-
* @example https://sandboxapi.deere.com/platform/mapLayerSummaries/MAP_LAYER_SUMMARY_ID
|
|
280
|
-
*/
|
|
281
|
-
'self (map layer summary)'?: unknown;
|
|
282
|
-
/**
|
|
283
|
-
* @description Organizations Link.
|
|
284
|
-
* @example https://sandboxapi.deere.com/platform/organizations/ORG_ID
|
|
285
|
-
*/
|
|
286
|
-
owningOrganization?: unknown;
|
|
287
|
-
/**
|
|
288
|
-
* @description Fields Link.
|
|
289
|
-
* @example https://sandboxapi.deere.com/platform/organizations/ORG_ID/fields/FIELD_ID
|
|
290
|
-
*/
|
|
291
|
-
targetResource?: unknown;
|
|
292
|
-
/**
|
|
293
|
-
* @description Map Layers Link.
|
|
294
|
-
* @example https://sandboxapi.deere.com/platform/mapLayerSummaries/MAP_LAYER_SUMMARY_ID/mapLayers
|
|
295
|
-
*/
|
|
296
|
-
mapLayers?: unknown;
|
|
297
|
-
/**
|
|
298
|
-
* @description Create Map Layers Link.
|
|
299
|
-
* @example https://sandboxapi.deere.com/platform/mapLayerSummaries/MAP_LAYER_SUMMARY_ID/mapLayers
|
|
300
|
-
*/
|
|
301
|
-
createMapLayer?: unknown;
|
|
302
|
-
};
|
|
1089
|
+
PostFileResponse: unknown;
|
|
303
1090
|
PostRequest: {
|
|
304
1091
|
/**
|
|
305
1092
|
* @description Links to other objects in the Deere ecosystem.
|
|
@@ -366,211 +1153,76 @@ export interface components {
|
|
|
366
1153
|
*/
|
|
367
1154
|
dateCreated?: string;
|
|
368
1155
|
};
|
|
369
|
-
|
|
370
|
-
/**
|
|
371
|
-
* @description Organizations Link
|
|
372
|
-
* @example https://sandboxapi.deere.com/platform/organizations/ORG_ID
|
|
373
|
-
*/
|
|
374
|
-
owningOrganization?: unknown;
|
|
375
|
-
/**
|
|
376
|
-
* @description Contribution Definitions Link.
|
|
377
|
-
* @example https://sandboxapi.deere.com/platform/contributionDefinitions/DEFINITION_ID
|
|
378
|
-
*/
|
|
379
|
-
contributionDefinition?: unknown;
|
|
380
|
-
};
|
|
381
|
-
GetMapLayerSummaryAvailableLinks: {
|
|
382
|
-
/**
|
|
383
|
-
* @description This Map Layer Summary Link.
|
|
384
|
-
* @example https://sandboxapi.deere.com/platform/mapLayerSummaries/MAP_LAYER_SUMMARY_ID
|
|
385
|
-
*/
|
|
386
|
-
self?: unknown;
|
|
387
|
-
/**
|
|
388
|
-
* @description Organizations Link.
|
|
389
|
-
* @example https://sandboxapi.deere.com/platform/organizations/ORG_ID
|
|
390
|
-
*/
|
|
391
|
-
owningOrganization?: unknown;
|
|
392
|
-
/**
|
|
393
|
-
* @description Fields Link.
|
|
394
|
-
* @example https://sandboxapi.deere.com/platform/organizations/ORG_ID/fields/FIELD_ID
|
|
395
|
-
*/
|
|
396
|
-
targetResource?: unknown;
|
|
397
|
-
/**
|
|
398
|
-
* @description Map Layers Link.
|
|
399
|
-
* @example https://sandboxapi.deere.com/platform/mapLayerSummaries/MAP_LAYER_SUMMARY_ID/mapLayers
|
|
400
|
-
*/
|
|
401
|
-
mapLayers?: unknown;
|
|
402
|
-
/**
|
|
403
|
-
* @description Create Map Layers Link.
|
|
404
|
-
* @example https://sandboxapi.deere.com/platform/mapLayerSummaries/MAP_LAYER_SUMMARY_ID/mapLayers
|
|
405
|
-
*/
|
|
406
|
-
createMapLayer?: unknown;
|
|
407
|
-
};
|
|
408
|
-
Metadata: {
|
|
409
|
-
/** @example Metadata */
|
|
410
|
-
'@type'?: string;
|
|
411
|
-
/** @example Location */
|
|
412
|
-
name: string;
|
|
413
|
-
/** @example Moline, IL */
|
|
414
|
-
value: string;
|
|
415
|
-
};
|
|
416
|
-
MapLayerCollection: components['schemas']['CollectionBase'] & {
|
|
417
|
-
values?: components['schemas']['ContributedMapLayer'][];
|
|
418
|
-
};
|
|
419
|
-
ContributedMapLayer: {
|
|
420
|
-
/** @example ContributedMapLayer */
|
|
421
|
-
'@type'?: string;
|
|
422
|
-
/**
|
|
423
|
-
* @description The title on the map layer.
|
|
424
|
-
* @example Drone Flyover
|
|
425
|
-
*/
|
|
426
|
-
title: string;
|
|
427
|
-
extent?: components['schemas']['MapExtent'];
|
|
1156
|
+
PostResponse_MapLayers: {
|
|
428
1157
|
/**
|
|
429
|
-
*
|
|
430
|
-
* @
|
|
1158
|
+
* Format: uuid
|
|
1159
|
+
* @description Map Layer ID
|
|
1160
|
+
* @example 83ks9gh3-29fj-9302-837j-92jlsk92jd095kd Readonly: Yes
|
|
431
1161
|
*/
|
|
432
|
-
|
|
433
|
-
legends: components['schemas']['MapLegend'];
|
|
1162
|
+
id?: string;
|
|
434
1163
|
/**
|
|
435
|
-
* @description Map
|
|
436
|
-
* @
|
|
1164
|
+
* @description Top level name of the Map Layer
|
|
1165
|
+
* @example NDVI Layer Readonly: No
|
|
437
1166
|
*/
|
|
438
|
-
|
|
1167
|
+
title?: string;
|
|
439
1168
|
/**
|
|
440
|
-
* @description
|
|
441
|
-
* @example
|
|
1169
|
+
* @description Describes Map Layer. Supports limited .
|
|
1170
|
+
* @example NDVI Layer for mid-season plant health based on near infrared Readonly: No
|
|
442
1171
|
*/
|
|
443
1172
|
text?: string;
|
|
444
|
-
metadata?: components['schemas']['Metadata'][];
|
|
445
|
-
/**
|
|
446
|
-
* @description The primary identifier for the operation.
|
|
447
|
-
* @example 8a0011f1-297e-48c2-a030-91a21287e721
|
|
448
|
-
*/
|
|
449
|
-
readonly id?: string;
|
|
450
|
-
links?: components['schemas']['Link'][];
|
|
451
|
-
};
|
|
452
|
-
/** @description Extents of the field. If not provided, the FileResource must be of type `image/tiff` or `application/zip` and contain the extents. */
|
|
453
|
-
MapExtent: {
|
|
454
|
-
/** @example MapExtent */
|
|
455
|
-
'@type'?: string;
|
|
456
1173
|
/**
|
|
457
|
-
*
|
|
458
|
-
* @example
|
|
1174
|
+
* @description An array of key value pair items about the Map Layer. Supports limited
|
|
1175
|
+
* @example See sample request below Readonly: No
|
|
459
1176
|
*/
|
|
460
|
-
|
|
1177
|
+
metadata?: unknown[];
|
|
461
1178
|
/**
|
|
462
|
-
*
|
|
463
|
-
* @example
|
|
1179
|
+
* @description Maximum and minimum extent of the map.
|
|
1180
|
+
* @example See sample request below Readonly: No
|
|
464
1181
|
*/
|
|
465
|
-
|
|
1182
|
+
extent?: Record<string, never>;
|
|
466
1183
|
/**
|
|
467
|
-
*
|
|
468
|
-
* @example
|
|
1184
|
+
* @description Determines the display alphabetical sort order between this Map Layer and its peers (all the Map Layers tied to the same Map Layer Summary). Defaults to the value of title.
|
|
1185
|
+
* @example 02 Readonly: No
|
|
469
1186
|
*/
|
|
470
|
-
|
|
1187
|
+
sortName?: string;
|
|
471
1188
|
/**
|
|
472
|
-
*
|
|
473
|
-
* @example
|
|
1189
|
+
* @description Keys the Map Layer's image data by color. Should represent all possible values and colors found in the Map Layer's File Resource image.
|
|
1190
|
+
* @example --- Readonly: No
|
|
474
1191
|
*/
|
|
475
|
-
|
|
476
|
-
};
|
|
477
|
-
MapLegend: {
|
|
478
|
-
/** @example MapLegend */
|
|
479
|
-
'@type'?: string;
|
|
1192
|
+
legends?: Record<string, never>;
|
|
480
1193
|
/**
|
|
481
|
-
* @description
|
|
482
|
-
* @example
|
|
1194
|
+
* @description Map Layer image processing progress.
|
|
1195
|
+
* @example VALID Readonly: Yes
|
|
483
1196
|
*/
|
|
484
|
-
|
|
485
|
-
ranges?: components['schemas']['MapLegendItem'][];
|
|
1197
|
+
status?: string;
|
|
486
1198
|
};
|
|
487
|
-
|
|
488
|
-
/** @example MapLegendItem */
|
|
489
|
-
'@type'?: string;
|
|
490
|
-
/**
|
|
491
|
-
* @description A label for the color
|
|
492
|
-
* @example Most profitable
|
|
493
|
-
*/
|
|
494
|
-
label?: string;
|
|
495
|
-
/**
|
|
496
|
-
* Format: double
|
|
497
|
-
* @example 10.09
|
|
498
|
-
*/
|
|
499
|
-
minimum?: number;
|
|
1199
|
+
RequestDetails: {
|
|
500
1200
|
/**
|
|
501
|
-
*
|
|
502
|
-
* @example
|
|
1201
|
+
* @description Links to other objects in the Deere ecosystem.
|
|
1202
|
+
* @example See "Available Links" below Readonly: Yes, except owningOrganization
|
|
503
1203
|
*/
|
|
504
|
-
|
|
1204
|
+
links?: unknown[];
|
|
505
1205
|
/**
|
|
506
|
-
* @description
|
|
507
|
-
* @example
|
|
1206
|
+
* @description File Resource ID
|
|
1207
|
+
* @example 83ks9gh3-29fj-9302-837j-92jlsk92jd095kd Readonly: Yes
|
|
508
1208
|
*/
|
|
509
|
-
|
|
1209
|
+
id?: string;
|
|
510
1210
|
/**
|
|
511
|
-
*
|
|
512
|
-
* @example
|
|
1211
|
+
* @description An array of key value pair items about the File Resource.
|
|
1212
|
+
* @example See sample response below Readonly: No
|
|
513
1213
|
*/
|
|
514
|
-
|
|
515
|
-
};
|
|
516
|
-
FileResource: {
|
|
517
|
-
/** @example FileResource */
|
|
518
|
-
'@type'?: string;
|
|
1214
|
+
metadata?: unknown[];
|
|
519
1215
|
/**
|
|
520
|
-
* @description
|
|
521
|
-
* @
|
|
1216
|
+
* @description Valid values are image/png, image/tif, image/tiff and application/zip
|
|
1217
|
+
* @example image/png Readonly: No
|
|
522
1218
|
*/
|
|
523
|
-
mimeType?:
|
|
524
|
-
/** @description The name of the file */
|
|
525
|
-
metadata: {
|
|
526
|
-
/** @example filename */
|
|
527
|
-
name?: string;
|
|
528
|
-
/** @example a_green_tractor.png */
|
|
529
|
-
value?: string;
|
|
530
|
-
}[];
|
|
1219
|
+
mimeType?: string;
|
|
531
1220
|
/**
|
|
532
|
-
*
|
|
533
|
-
* @
|
|
1221
|
+
* Format: date-time
|
|
1222
|
+
* @description ISO 8601 Date and time in UTC this resource was created.
|
|
1223
|
+
* @example 2019-03-02T16:14:23.421Z Readonly: No
|
|
534
1224
|
*/
|
|
535
|
-
|
|
536
|
-
/** @description Links for self, targetResource, and owningOrganization */
|
|
537
|
-
links: components['schemas']['Link'][];
|
|
538
|
-
};
|
|
539
|
-
'400Errors': {
|
|
540
|
-
/** @example Errors */
|
|
541
|
-
'@type'?: string;
|
|
542
|
-
errors?: {
|
|
543
|
-
/** @example Error */
|
|
544
|
-
'@type'?: string;
|
|
545
|
-
/**
|
|
546
|
-
* Format: uuid
|
|
547
|
-
* @example ed292512-1f3c-4285-83c3-1fb084423f9b
|
|
548
|
-
*/
|
|
549
|
-
guid?: string;
|
|
550
|
-
/** @example This field is required. */
|
|
551
|
-
message?: string;
|
|
552
|
-
/** @example validation_constraint_required_field */
|
|
553
|
-
code?: string;
|
|
554
|
-
/** @example title */
|
|
555
|
-
field?: string;
|
|
556
|
-
}[];
|
|
557
|
-
otherAttributes?: Record<string, never>;
|
|
558
|
-
};
|
|
559
|
-
GenericErrors: {
|
|
560
|
-
/** @example Errors */
|
|
561
|
-
'@type'?: string;
|
|
562
|
-
errors?: {
|
|
563
|
-
/** @example Error */
|
|
564
|
-
'@type'?: string;
|
|
565
|
-
/**
|
|
566
|
-
* Format: uuid
|
|
567
|
-
* @example ed292512-1f3c-4285-83c3-1fb084423f9b
|
|
568
|
-
*/
|
|
569
|
-
guid?: string;
|
|
570
|
-
/** @example The requested resource was not found */
|
|
571
|
-
message?: string;
|
|
572
|
-
}[];
|
|
573
|
-
otherAttributes?: Record<string, never>;
|
|
1225
|
+
timestamp?: string;
|
|
574
1226
|
};
|
|
575
1227
|
};
|
|
576
1228
|
responses: {
|
|
@@ -640,16 +1292,28 @@ export interface components {
|
|
|
640
1292
|
parameters: {
|
|
641
1293
|
/** @description Organization ID */
|
|
642
1294
|
OrganizationId: string;
|
|
643
|
-
/** @description Field ID */
|
|
644
|
-
fileId: string;
|
|
645
|
-
/** @description Set includePartialSummaries to true to include Map Layer Summaries without File Resources. */
|
|
646
|
-
includePartialSummaries: boolean;
|
|
647
1295
|
/** @description Takes these values mapLayers. */
|
|
648
1296
|
embed: string;
|
|
649
1297
|
/** @description Field ID */
|
|
650
1298
|
fieldId: string;
|
|
1299
|
+
/** @description Field ID */
|
|
1300
|
+
fileId: string;
|
|
1301
|
+
/** @description File Resource ID */
|
|
1302
|
+
fileId_FileResources: string;
|
|
1303
|
+
/** @description Map Layer ID */
|
|
1304
|
+
getId: string;
|
|
1305
|
+
/** @description Map Layer ID */
|
|
1306
|
+
getMapId: string;
|
|
651
1307
|
/** @description Map Layer Summary ID */
|
|
652
1308
|
id: string;
|
|
1309
|
+
/** @description Map Layer ID */
|
|
1310
|
+
id_FileResources: string;
|
|
1311
|
+
/** @description Map Layer Summary ID */
|
|
1312
|
+
id_MapLayers: string;
|
|
1313
|
+
/** @description Set includePartialLayers to true to include Map Layers without File Resources. */
|
|
1314
|
+
includePartialLayers: boolean;
|
|
1315
|
+
/** @description Set includePartialSummaries to true to include Map Layer Summaries without File Resources. */
|
|
1316
|
+
includePartialSummaries: boolean;
|
|
653
1317
|
};
|
|
654
1318
|
requestBodies: never;
|
|
655
1319
|
headers: never;
|