deere-sdk 2.3.0 → 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 +61 -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 +74 -74
- 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 +1201 -1201
- 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,6 +3,45 @@
|
|
|
3
3
|
* Do not make direct changes to the file.
|
|
4
4
|
*/
|
|
5
5
|
export interface paths {
|
|
6
|
+
'/organizations/{orgID}/fields/{id}/clients': {
|
|
7
|
+
parameters: {
|
|
8
|
+
query?: never;
|
|
9
|
+
header?: never;
|
|
10
|
+
path?: never;
|
|
11
|
+
cookie?: never;
|
|
12
|
+
};
|
|
13
|
+
/**
|
|
14
|
+
* View Clients that Own a Field
|
|
15
|
+
* @description View details about the client that owns the field. The response will link to the following resources: fields: View the field the client belongs to. farms: View the farms belonging to the client. owningOrganization: View the org that owns the field.
|
|
16
|
+
*/
|
|
17
|
+
get: {
|
|
18
|
+
parameters: {
|
|
19
|
+
query?: never;
|
|
20
|
+
header?: {
|
|
21
|
+
/** @description x-deere-signature should be managed by the client per user per API. For a new user/new API, the first request will have a blank value for x-deere-signature. Changes can be tracked with the x-deere-signature returned in the response. If the response has not changed since the last API call, the value of x-deere-signature is not changed and the client should use the same String Token next time. */
|
|
22
|
+
'x-deere-signature'?: components['parameters']['X-deere-signature'];
|
|
23
|
+
};
|
|
24
|
+
path: {
|
|
25
|
+
/** @description The ID of the organization */
|
|
26
|
+
orgId: components['parameters']['OrgId'];
|
|
27
|
+
/** @description field guid */
|
|
28
|
+
fieldId: components['parameters']['FieldId'];
|
|
29
|
+
};
|
|
30
|
+
cookie?: never;
|
|
31
|
+
};
|
|
32
|
+
requestBody?: never;
|
|
33
|
+
responses: {
|
|
34
|
+
200: components['responses']['getFieldResponse'];
|
|
35
|
+
};
|
|
36
|
+
};
|
|
37
|
+
put?: never;
|
|
38
|
+
post?: never;
|
|
39
|
+
delete?: never;
|
|
40
|
+
options?: never;
|
|
41
|
+
head?: never;
|
|
42
|
+
patch?: never;
|
|
43
|
+
trace?: never;
|
|
44
|
+
};
|
|
6
45
|
'/organizations/{orgId}/fields': {
|
|
7
46
|
parameters: {
|
|
8
47
|
query?: never;
|
|
@@ -212,195 +251,263 @@ export interface paths {
|
|
|
212
251
|
patch?: never;
|
|
213
252
|
trace?: never;
|
|
214
253
|
};
|
|
215
|
-
'/organizations/{orgID}/fields/{id}/clients': {
|
|
216
|
-
parameters: {
|
|
217
|
-
query?: never;
|
|
218
|
-
header?: never;
|
|
219
|
-
path?: never;
|
|
220
|
-
cookie?: never;
|
|
221
|
-
};
|
|
222
|
-
/**
|
|
223
|
-
* View Clients that Own a Field
|
|
224
|
-
* @description View details about the client that owns the field. The response will link to the following resources: fields: View the field the client belongs to. farms: View the farms belonging to the client. owningOrganization: View the org that owns the field.
|
|
225
|
-
*/
|
|
226
|
-
get: {
|
|
227
|
-
parameters: {
|
|
228
|
-
query?: never;
|
|
229
|
-
header?: {
|
|
230
|
-
/** @description x-deere-signature should be managed by the client per user per API. For a new user/new API, the first request will have a blank value for x-deere-signature. Changes can be tracked with the x-deere-signature returned in the response. If the response has not changed since the last API call, the value of x-deere-signature is not changed and the client should use the same String Token next time. */
|
|
231
|
-
'x-deere-signature'?: components['parameters']['X-deere-signature'];
|
|
232
|
-
};
|
|
233
|
-
path: {
|
|
234
|
-
/** @description The ID of the organization */
|
|
235
|
-
orgId: components['parameters']['OrgId'];
|
|
236
|
-
/** @description field guid */
|
|
237
|
-
fieldId: components['parameters']['FieldId'];
|
|
238
|
-
};
|
|
239
|
-
cookie?: never;
|
|
240
|
-
};
|
|
241
|
-
requestBody?: never;
|
|
242
|
-
responses: {
|
|
243
|
-
200: components['responses']['getFieldResponse'];
|
|
244
|
-
};
|
|
245
|
-
};
|
|
246
|
-
put?: never;
|
|
247
|
-
post?: never;
|
|
248
|
-
delete?: never;
|
|
249
|
-
options?: never;
|
|
250
|
-
head?: never;
|
|
251
|
-
patch?: never;
|
|
252
|
-
trace?: never;
|
|
253
|
-
};
|
|
254
254
|
}
|
|
255
255
|
export type webhooks = Record<string, never>;
|
|
256
256
|
export interface components {
|
|
257
257
|
schemas: {
|
|
258
|
-
|
|
258
|
+
ABLine: {
|
|
259
|
+
/** @example AbLine */
|
|
260
|
+
'@Type'?: string;
|
|
261
|
+
/** @example 356.5847091769351 */
|
|
262
|
+
heading?: number;
|
|
263
|
+
aPoint?: components['schemas']['Point'];
|
|
264
|
+
};
|
|
265
|
+
AccessPoint: {
|
|
266
|
+
/** Format: uri */
|
|
267
|
+
id?: string;
|
|
268
|
+
description?: string;
|
|
269
|
+
direction?: string;
|
|
270
|
+
isEntry?: boolean;
|
|
271
|
+
isExit?: boolean;
|
|
272
|
+
location?: components['schemas']['Point'];
|
|
273
|
+
name?: string;
|
|
259
274
|
links?: components['schemas']['Link'][];
|
|
260
|
-
totals?: number;
|
|
261
|
-
values?: components['schemas']['FieldResponse'][];
|
|
262
275
|
};
|
|
263
|
-
|
|
264
|
-
/** @example
|
|
276
|
+
Author: {
|
|
277
|
+
/** @example User */
|
|
265
278
|
'@Type'?: string;
|
|
266
|
-
/** @example
|
|
279
|
+
/** @example scoutcarla1 */
|
|
280
|
+
accountName?: string;
|
|
281
|
+
/** @example scoutcarla1 */
|
|
282
|
+
givenName?: string;
|
|
283
|
+
/** @example scoutcarla1 */
|
|
284
|
+
familyName?: string;
|
|
285
|
+
};
|
|
286
|
+
Boundary: {
|
|
287
|
+
/** @example Boundary */
|
|
288
|
+
'@Type'?: string;
|
|
289
|
+
/** @example Auto-Generated 2014 Harvest */
|
|
267
290
|
name?: string;
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
|
|
272
|
-
|
|
273
|
-
|
|
274
|
-
|
|
275
|
-
|
|
291
|
+
/** @example Auto */
|
|
292
|
+
sourceType?: string;
|
|
293
|
+
/**
|
|
294
|
+
* Format: date-time
|
|
295
|
+
* @example 2016-11-17T11:53:00.000Z
|
|
296
|
+
*/
|
|
297
|
+
modifiedTime?: string;
|
|
298
|
+
area?: components['schemas']['MeasurementAsDouble'];
|
|
299
|
+
workableArea?: components['schemas']['MeasurementAsDouble'];
|
|
300
|
+
multipolygons?: components['schemas']['Polygon'][];
|
|
301
|
+
extent?: components['schemas']['Extent'];
|
|
276
302
|
/**
|
|
277
303
|
* Format: uuid
|
|
278
304
|
* @example 9369f3f6-2428-4bba-bf64-0a19cdaf007d
|
|
279
305
|
*/
|
|
280
306
|
id?: string;
|
|
281
307
|
links?: components['schemas']['Link'][];
|
|
308
|
+
/** @description Whether or not this boundary is currently in use. A field with associated boundaries will have exactly one active boundary; however, a field may also exist with no boundaries. */
|
|
309
|
+
active?: boolean;
|
|
310
|
+
/** @description Indicates whether the contained area is irrigated */
|
|
311
|
+
irrigated?: boolean;
|
|
282
312
|
};
|
|
283
|
-
|
|
284
|
-
/** @example
|
|
285
|
-
'@Type'?: string;
|
|
286
|
-
farms?: components['schemas']['Farm'][];
|
|
287
|
-
};
|
|
288
|
-
Farm: {
|
|
289
|
-
/** @example Farm */
|
|
313
|
+
Client: {
|
|
314
|
+
/** @example Client */
|
|
290
315
|
'@Type'?: string;
|
|
291
316
|
/** @example --- */
|
|
292
317
|
name?: string;
|
|
293
318
|
/**
|
|
294
319
|
* Format: uri
|
|
295
|
-
* @example
|
|
320
|
+
* @example 68b887c7-1ac2-40a4-b70b-117a8ec34abf
|
|
296
321
|
*/
|
|
297
322
|
id?: string;
|
|
298
323
|
links?: components['schemas']['Link'][];
|
|
299
324
|
};
|
|
325
|
+
Clients: {
|
|
326
|
+
/** @example Clients */
|
|
327
|
+
'@Type'?: string;
|
|
328
|
+
clients?: components['schemas']['Client'][];
|
|
329
|
+
};
|
|
330
|
+
CreateUpdateClient: {
|
|
331
|
+
/** @example Client */
|
|
332
|
+
'@Type'?: string;
|
|
333
|
+
/** @example SouthEast End_Client */
|
|
334
|
+
name?: string;
|
|
335
|
+
};
|
|
300
336
|
CreateUpdateFarm: {
|
|
301
337
|
/** @example Farm */
|
|
302
338
|
'@Type'?: string;
|
|
303
339
|
/** @example SouthEast End */
|
|
304
340
|
name?: string;
|
|
305
341
|
};
|
|
306
|
-
|
|
307
|
-
|
|
342
|
+
/** @description Place holder for Matt to create the field object to be created or updated. */
|
|
343
|
+
CreateUpdateField: {
|
|
344
|
+
/** @example Field */
|
|
308
345
|
'@Type'?: string;
|
|
309
|
-
|
|
346
|
+
/** @example Land_Demo_1 */
|
|
347
|
+
name?: string;
|
|
348
|
+
/** @example true */
|
|
349
|
+
archived?: boolean;
|
|
350
|
+
Farms?: {
|
|
351
|
+
/** @example Farms */
|
|
352
|
+
'@Type'?: string;
|
|
353
|
+
farms?: components['schemas']['CreateUpdateFarm'][];
|
|
354
|
+
};
|
|
355
|
+
Clients?: {
|
|
356
|
+
/** @example Clients */
|
|
357
|
+
'@Type'?: string;
|
|
358
|
+
clients?: components['schemas']['CreateUpdateClient'][];
|
|
359
|
+
};
|
|
310
360
|
};
|
|
311
|
-
|
|
312
|
-
/** @example
|
|
361
|
+
Extent: {
|
|
362
|
+
/** @example Extent */
|
|
363
|
+
'@Type'?: string;
|
|
364
|
+
topLeft?: components['schemas']['Point'];
|
|
365
|
+
bottomRight?: components['schemas']['Point'];
|
|
366
|
+
};
|
|
367
|
+
Farm: {
|
|
368
|
+
/** @example Farm */
|
|
313
369
|
'@Type'?: string;
|
|
314
370
|
/** @example --- */
|
|
315
371
|
name?: string;
|
|
316
372
|
/**
|
|
317
373
|
* Format: uri
|
|
318
|
-
* @example
|
|
374
|
+
* @example 1efb4de1-fe41-42bc-bbb3-d128a432cafd
|
|
319
375
|
*/
|
|
320
376
|
id?: string;
|
|
321
377
|
links?: components['schemas']['Link'][];
|
|
322
378
|
};
|
|
323
|
-
|
|
324
|
-
|
|
379
|
+
Farms: {
|
|
380
|
+
/** @example Farms */
|
|
381
|
+
'@Type'?: string;
|
|
382
|
+
farms?: components['schemas']['Farm'][];
|
|
383
|
+
};
|
|
384
|
+
FieldGuidSearches: {
|
|
385
|
+
/** @example FieldGuidSearches */
|
|
386
|
+
'@Type'?: string;
|
|
387
|
+
fieldIds?: string[];
|
|
388
|
+
/** @example client */
|
|
389
|
+
clientName?: string;
|
|
390
|
+
/** @example farm */
|
|
391
|
+
farmName?: string;
|
|
392
|
+
/** @example field */
|
|
393
|
+
fieldName?: string;
|
|
394
|
+
embeds?: ('farms' | 'clients' | 'boundaries' | 'activeBoundary' | 'simplifiedBoundaries' | 'metadataOnlyBoundaries' | 'guidanceLines' | 'shapes' | 'accessPoints' | 'notes')[];
|
|
395
|
+
/** @enum {string} */
|
|
396
|
+
status?: 'AVAILABLE' | 'ARCHIVED' | 'ALL';
|
|
397
|
+
};
|
|
398
|
+
FieldResponse: {
|
|
399
|
+
/** @example Field */
|
|
400
|
+
'@Type'?: string;
|
|
401
|
+
/** @example --- */
|
|
402
|
+
name?: string;
|
|
403
|
+
farms?: components['schemas']['Farms'];
|
|
404
|
+
clients?: components['schemas']['Clients'];
|
|
405
|
+
boundaries?: components['schemas']['Boundary'][];
|
|
406
|
+
accessPoints?: components['schemas']['AccessPoint'][];
|
|
407
|
+
guidanceLines?: components['schemas']['GuidanceLines'][];
|
|
408
|
+
/** @example true */
|
|
409
|
+
archived?: boolean;
|
|
410
|
+
flags?: components['schemas']['Flag'][];
|
|
325
411
|
/**
|
|
326
|
-
*
|
|
327
|
-
* @example
|
|
412
|
+
* Format: uuid
|
|
413
|
+
* @example 9369f3f6-2428-4bba-bf64-0a19cdaf007d
|
|
328
414
|
*/
|
|
329
|
-
|
|
415
|
+
id?: string;
|
|
416
|
+
links?: components['schemas']['Link'][];
|
|
417
|
+
};
|
|
418
|
+
FieldsPost: {
|
|
330
419
|
/**
|
|
331
|
-
* @description
|
|
332
|
-
* @example
|
|
420
|
+
* @description New Field Name
|
|
421
|
+
* @example UniqueFieldName
|
|
333
422
|
*/
|
|
334
|
-
|
|
423
|
+
name?: string;
|
|
335
424
|
/**
|
|
336
|
-
* @description
|
|
337
|
-
* @example
|
|
425
|
+
* @description Archived status (false = active)
|
|
426
|
+
* @example false
|
|
338
427
|
*/
|
|
339
|
-
|
|
428
|
+
archived?: string;
|
|
340
429
|
/**
|
|
341
|
-
* @description
|
|
342
|
-
* @example
|
|
430
|
+
* @description Existing or Unique (new) farm name
|
|
431
|
+
* @example FarmName
|
|
343
432
|
*/
|
|
344
|
-
|
|
433
|
+
'farms.name'?: string;
|
|
345
434
|
/**
|
|
346
|
-
*
|
|
347
|
-
* @
|
|
435
|
+
* Format: uuid
|
|
436
|
+
* @description Farm ID
|
|
437
|
+
* @example e61b83f4-3a12-431e-8010-596f2466dc27
|
|
348
438
|
*/
|
|
349
|
-
|
|
350
|
-
/**
|
|
351
|
-
* @description Boundaries Link.
|
|
352
|
-
* @example https://sandboxapi.deere.com/platform/organizations/123456/fields/d61b83f4-3a12-431e-8010-596f2466dc27/boundaries?simple=true
|
|
353
|
-
*/
|
|
354
|
-
simplifiedBoundaries?: unknown;
|
|
355
|
-
/**
|
|
356
|
-
* @description Field Operations Link.
|
|
357
|
-
* @example https://sandboxapi.deere.com/platform/organizations/123456/fields/d61b83f4-3a12-431e-8010-596f2466dc27/fieldOperations
|
|
358
|
-
*/
|
|
359
|
-
fieldOperation?: unknown;
|
|
439
|
+
'farms.id'?: string;
|
|
360
440
|
/**
|
|
361
|
-
* @description
|
|
362
|
-
* @example
|
|
441
|
+
* @description Existing or Unique (new) client name
|
|
442
|
+
* @example ClientName
|
|
363
443
|
*/
|
|
364
|
-
|
|
444
|
+
'clients.name'?: string;
|
|
365
445
|
/**
|
|
366
|
-
*
|
|
367
|
-
* @
|
|
446
|
+
* Format: uuid
|
|
447
|
+
* @description Client ID
|
|
448
|
+
* @example e61b83f4-3a12-431e-8010-596f2466dc27
|
|
368
449
|
*/
|
|
369
|
-
|
|
450
|
+
'clients.id'?: string;
|
|
370
451
|
};
|
|
371
|
-
|
|
372
|
-
|
|
373
|
-
|
|
374
|
-
|
|
375
|
-
|
|
376
|
-
|
|
377
|
-
/**
|
|
378
|
-
|
|
379
|
-
* @example false
|
|
380
|
-
*/
|
|
381
|
-
archived?: string;
|
|
452
|
+
FieldsResponse: {
|
|
453
|
+
links?: components['schemas']['Link'][];
|
|
454
|
+
totals?: number;
|
|
455
|
+
values?: components['schemas']['FieldResponse'][];
|
|
456
|
+
};
|
|
457
|
+
Flag: {
|
|
458
|
+
/** @example GenericNote */
|
|
459
|
+
'@Type'?: string;
|
|
382
460
|
/**
|
|
383
|
-
*
|
|
384
|
-
* @example
|
|
461
|
+
* Format: date-time
|
|
462
|
+
* @example 2016-08-19T18:48:48.886Z
|
|
385
463
|
*/
|
|
386
|
-
|
|
464
|
+
createdDate?: string;
|
|
387
465
|
/**
|
|
388
|
-
* Format:
|
|
389
|
-
* @
|
|
390
|
-
* @example e61b83f4-3a12-431e-8010-596f2466dc27
|
|
466
|
+
* Format: date-time
|
|
467
|
+
* @example 2016-08-19T18:48:48.886Z
|
|
391
468
|
*/
|
|
392
|
-
|
|
469
|
+
lastModifiedDate?: string;
|
|
470
|
+
/** @example some text */
|
|
471
|
+
text?: string;
|
|
472
|
+
metadata?: components['schemas']['MetaData'][];
|
|
473
|
+
author?: components['schemas']['Author'][];
|
|
474
|
+
geometry?: components['schemas']['Geometry'];
|
|
475
|
+
/** @example SCOUT */
|
|
476
|
+
noteType?: string;
|
|
393
477
|
/**
|
|
394
|
-
*
|
|
395
|
-
* @example
|
|
478
|
+
* Format: uri
|
|
479
|
+
* @example 4e7a1fa7-9db9-45ea-94d3-e45b2fa43c2a
|
|
396
480
|
*/
|
|
397
|
-
|
|
481
|
+
id?: string;
|
|
482
|
+
links?: components['schemas']['Link'][];
|
|
483
|
+
};
|
|
484
|
+
Geometry: {
|
|
485
|
+
coordinates?: string[];
|
|
486
|
+
/** @example Point */
|
|
487
|
+
type?: string;
|
|
488
|
+
};
|
|
489
|
+
GetFarm: {
|
|
490
|
+
/** @example Farm */
|
|
491
|
+
'@type'?: string;
|
|
492
|
+
/** @example John Doe */
|
|
493
|
+
name?: string;
|
|
398
494
|
/**
|
|
399
495
|
* Format: uuid
|
|
400
|
-
* @
|
|
401
|
-
* @example e61b83f4-3a12-431e-8010-596f2466dc27
|
|
496
|
+
* @example 9369f3f6-2428-4bba-bf64-0a19cdaf007d
|
|
402
497
|
*/
|
|
403
|
-
|
|
498
|
+
readonly id?: string;
|
|
499
|
+
/** @example false */
|
|
500
|
+
archived?: boolean;
|
|
501
|
+
/** @example https://apiqa.tal.deere.com/platform/organizations/5555/clients/22b84b4c-b651-d554-a02b-89829cd5239c */
|
|
502
|
+
clientUri?: string;
|
|
503
|
+
readonly links?: {
|
|
504
|
+
/** @example Link */
|
|
505
|
+
'@type'?: string;
|
|
506
|
+
/** @example self */
|
|
507
|
+
rel?: string;
|
|
508
|
+
/** @example https://apiqa.tal.deere.com/platform/organizations/5555/farms/9369f3f6-2428-4bba-bf64-0a19cdaf007d */
|
|
509
|
+
uri?: string;
|
|
510
|
+
}[];
|
|
404
511
|
};
|
|
405
512
|
GetFarms: {
|
|
406
513
|
/**
|
|
@@ -419,49 +526,53 @@ export interface components {
|
|
|
419
526
|
}[];
|
|
420
527
|
values?: components['schemas']['GetFarm'][];
|
|
421
528
|
};
|
|
422
|
-
|
|
423
|
-
|
|
424
|
-
'@Type'?: string;
|
|
425
|
-
/** @example SouthEast End_Client */
|
|
426
|
-
name?: string;
|
|
427
|
-
};
|
|
428
|
-
Boundary: {
|
|
429
|
-
/** @example Boundary */
|
|
430
|
-
'@Type'?: string;
|
|
431
|
-
/** @example Auto-Generated 2014 Harvest */
|
|
432
|
-
name?: string;
|
|
433
|
-
/** @example Auto */
|
|
434
|
-
sourceType?: string;
|
|
529
|
+
/** @description Link to another resource */
|
|
530
|
+
GroupLink: {
|
|
435
531
|
/**
|
|
436
|
-
*
|
|
437
|
-
* @example
|
|
532
|
+
* @description Boundaries Link.
|
|
533
|
+
* @example https://sandboxapi.deere.com/platform/organizations/123456/fields/e61b83f4-3a12-431e-8010-596f2466dc27/boundaries
|
|
438
534
|
*/
|
|
439
|
-
|
|
440
|
-
area?: components['schemas']['MeasurementAsDouble'];
|
|
441
|
-
workableArea?: components['schemas']['MeasurementAsDouble'];
|
|
442
|
-
multipolygons?: components['schemas']['Polygon'][];
|
|
443
|
-
extent?: components['schemas']['Extent'];
|
|
535
|
+
boundaries?: unknown;
|
|
444
536
|
/**
|
|
445
|
-
*
|
|
446
|
-
* @example
|
|
537
|
+
* @description Clients Link.
|
|
538
|
+
* @example https://sandboxapi.deere.com/platform/organizations/123456/fields/e61b83f4-3a12-431e-8010-596f2466dc27/clients
|
|
447
539
|
*/
|
|
448
|
-
|
|
449
|
-
|
|
450
|
-
|
|
451
|
-
|
|
452
|
-
|
|
453
|
-
|
|
454
|
-
|
|
455
|
-
|
|
456
|
-
|
|
457
|
-
|
|
458
|
-
|
|
459
|
-
|
|
460
|
-
|
|
461
|
-
|
|
462
|
-
|
|
463
|
-
|
|
464
|
-
|
|
540
|
+
clients?: unknown;
|
|
541
|
+
/**
|
|
542
|
+
* @description Farms Link.
|
|
543
|
+
* @example https://sandboxapi.deere.com/platform/organizations/123456/fields/e61b83f4-3a12-431e-8010-596f2466dc27/farms
|
|
544
|
+
*/
|
|
545
|
+
farms?: unknown;
|
|
546
|
+
/**
|
|
547
|
+
* @description Organizations Link.
|
|
548
|
+
* @example https://sandboxapi.deere.com/platform/organizations/123456
|
|
549
|
+
*/
|
|
550
|
+
owningOrganization?: unknown;
|
|
551
|
+
/**
|
|
552
|
+
* @description Notes Link.
|
|
553
|
+
* @example https://sandboxapi.deere.com/platform/organizations/123456/fields/d61b83f4-3a12-431e-8010-596f2466dc27/notes
|
|
554
|
+
*/
|
|
555
|
+
notes?: unknown;
|
|
556
|
+
/**
|
|
557
|
+
* @description Boundaries Link.
|
|
558
|
+
* @example https://sandboxapi.deere.com/platform/organizations/123456/fields/d61b83f4-3a12-431e-8010-596f2466dc27/boundaries?simple=true
|
|
559
|
+
*/
|
|
560
|
+
simplifiedBoundaries?: unknown;
|
|
561
|
+
/**
|
|
562
|
+
* @description Field Operations Link.
|
|
563
|
+
* @example https://sandboxapi.deere.com/platform/organizations/123456/fields/d61b83f4-3a12-431e-8010-596f2466dc27/fieldOperations
|
|
564
|
+
*/
|
|
565
|
+
fieldOperation?: unknown;
|
|
566
|
+
/**
|
|
567
|
+
* @description Map Layer Summaries Link.
|
|
568
|
+
* @example https://sandboxapi.deere.com/platform/organizations/123456/fields/d61b83f4-3a12-431e-8010-596f2466dc27/mapLayerSummaries
|
|
569
|
+
*/
|
|
570
|
+
mapLayerSummaries?: unknown;
|
|
571
|
+
/**
|
|
572
|
+
* @description Contribution Definition Link
|
|
573
|
+
* @example https://sandboxapi.deere.com/platform/contributionDefinitions/32a256ea-0000-4756-b000-b6dabda856ef
|
|
574
|
+
*/
|
|
575
|
+
contributionDefinition?: unknown;
|
|
465
576
|
};
|
|
466
577
|
GuidanceLines: components['schemas']['ABLine'] & {
|
|
467
578
|
bPoint?: components['schemas']['Point'];
|
|
@@ -495,32 +606,28 @@ export interface components {
|
|
|
495
606
|
locked?: boolean;
|
|
496
607
|
links?: components['schemas']['Link'][];
|
|
497
608
|
};
|
|
498
|
-
|
|
499
|
-
|
|
609
|
+
/** @description Link to another resource */
|
|
610
|
+
Link: {
|
|
611
|
+
/** @example self */
|
|
612
|
+
rel?: string;
|
|
613
|
+
/** @example https://sandboxapi.deere.com/platform/users/USER */
|
|
614
|
+
uri?: string;
|
|
615
|
+
};
|
|
616
|
+
MeasurementAsDouble: {
|
|
617
|
+
/** @example MeasurementAsDouble */
|
|
500
618
|
'@Type'?: string;
|
|
501
619
|
/**
|
|
502
|
-
* Format:
|
|
503
|
-
* @example
|
|
504
|
-
*/
|
|
505
|
-
createdDate?: string;
|
|
506
|
-
/**
|
|
507
|
-
* Format: date-time
|
|
508
|
-
* @example 2016-08-19T18:48:48.886Z
|
|
620
|
+
* Format: double
|
|
621
|
+
* @example 7.502938
|
|
509
622
|
*/
|
|
510
|
-
|
|
511
|
-
/** @example
|
|
512
|
-
|
|
513
|
-
metadata?: components['schemas']['MetaData'][];
|
|
514
|
-
author?: components['schemas']['Author'][];
|
|
515
|
-
geometry?: components['schemas']['Geometry'];
|
|
516
|
-
/** @example SCOUT */
|
|
517
|
-
noteType?: string;
|
|
623
|
+
valueAsDouble?: number;
|
|
624
|
+
/** @example vrEastShiftComponent */
|
|
625
|
+
vrDomainId?: string;
|
|
518
626
|
/**
|
|
519
|
-
*
|
|
520
|
-
* @example
|
|
627
|
+
* @description The unit of measure for this value
|
|
628
|
+
* @example ha
|
|
521
629
|
*/
|
|
522
|
-
|
|
523
|
-
links?: components['schemas']['Link'][];
|
|
630
|
+
unit?: string;
|
|
524
631
|
};
|
|
525
632
|
MetaData: {
|
|
526
633
|
/** @example Metadata */
|
|
@@ -530,41 +637,6 @@ export interface components {
|
|
|
530
637
|
/** @example 9 */
|
|
531
638
|
value?: number;
|
|
532
639
|
};
|
|
533
|
-
Author: {
|
|
534
|
-
/** @example User */
|
|
535
|
-
'@Type'?: string;
|
|
536
|
-
/** @example scoutcarla1 */
|
|
537
|
-
accountName?: string;
|
|
538
|
-
/** @example scoutcarla1 */
|
|
539
|
-
givenName?: string;
|
|
540
|
-
/** @example scoutcarla1 */
|
|
541
|
-
familyName?: string;
|
|
542
|
-
};
|
|
543
|
-
Geometry: {
|
|
544
|
-
coordinates?: string[];
|
|
545
|
-
/** @example Point */
|
|
546
|
-
type?: string;
|
|
547
|
-
};
|
|
548
|
-
ABLine: {
|
|
549
|
-
/** @example AbLine */
|
|
550
|
-
'@Type'?: string;
|
|
551
|
-
/** @example 356.5847091769351 */
|
|
552
|
-
heading?: number;
|
|
553
|
-
aPoint?: components['schemas']['Point'];
|
|
554
|
-
};
|
|
555
|
-
Polygon: {
|
|
556
|
-
/** @example Polygon */
|
|
557
|
-
'@Type'?: string;
|
|
558
|
-
rings?: components['schemas']['Ring'][];
|
|
559
|
-
};
|
|
560
|
-
Ring: {
|
|
561
|
-
/** @example Ring */
|
|
562
|
-
'@Type'?: string;
|
|
563
|
-
points?: components['schemas']['Point'][];
|
|
564
|
-
/** @example exterior */
|
|
565
|
-
type?: string;
|
|
566
|
-
passable?: boolean;
|
|
567
|
-
};
|
|
568
640
|
Point: {
|
|
569
641
|
/** @example Point */
|
|
570
642
|
'@Type'?: string;
|
|
@@ -581,93 +653,46 @@ export interface components {
|
|
|
581
653
|
*/
|
|
582
654
|
lon?: number;
|
|
583
655
|
};
|
|
584
|
-
|
|
585
|
-
/** @example
|
|
586
|
-
'@Type'?: string;
|
|
587
|
-
topLeft?: components['schemas']['Point'];
|
|
588
|
-
bottomRight?: components['schemas']['Point'];
|
|
589
|
-
};
|
|
590
|
-
MeasurementAsDouble: {
|
|
591
|
-
/** @example MeasurementAsDouble */
|
|
656
|
+
Polygon: {
|
|
657
|
+
/** @example Polygon */
|
|
592
658
|
'@Type'?: string;
|
|
593
|
-
|
|
594
|
-
* Format: double
|
|
595
|
-
* @example 7.502938
|
|
596
|
-
*/
|
|
597
|
-
valueAsDouble?: number;
|
|
598
|
-
/** @example vrEastShiftComponent */
|
|
599
|
-
vrDomainId?: string;
|
|
600
|
-
/**
|
|
601
|
-
* @description The unit of measure for this value
|
|
602
|
-
* @example ha
|
|
603
|
-
*/
|
|
604
|
-
unit?: string;
|
|
605
|
-
};
|
|
606
|
-
/** @description Link to another resource */
|
|
607
|
-
Link: {
|
|
608
|
-
/** @example self */
|
|
609
|
-
rel?: string;
|
|
610
|
-
/** @example https://sandboxapi.deere.com/platform/users/USER */
|
|
611
|
-
uri?: string;
|
|
659
|
+
rings?: components['schemas']['Ring'][];
|
|
612
660
|
};
|
|
613
|
-
|
|
614
|
-
/** @example
|
|
661
|
+
Ring: {
|
|
662
|
+
/** @example Ring */
|
|
615
663
|
'@Type'?: string;
|
|
616
|
-
|
|
617
|
-
/** @example
|
|
618
|
-
|
|
619
|
-
|
|
620
|
-
farmName?: string;
|
|
621
|
-
/** @example field */
|
|
622
|
-
fieldName?: string;
|
|
623
|
-
embeds?: ('farms' | 'clients' | 'boundaries' | 'activeBoundary' | 'simplifiedBoundaries' | 'metadataOnlyBoundaries' | 'guidanceLines' | 'shapes' | 'accessPoints' | 'notes')[];
|
|
624
|
-
/** @enum {string} */
|
|
625
|
-
status?: 'AVAILABLE' | 'ARCHIVED' | 'ALL';
|
|
664
|
+
points?: components['schemas']['Point'][];
|
|
665
|
+
/** @example exterior */
|
|
666
|
+
type?: string;
|
|
667
|
+
passable?: boolean;
|
|
626
668
|
};
|
|
627
|
-
|
|
628
|
-
|
|
629
|
-
|
|
630
|
-
|
|
631
|
-
|
|
632
|
-
|
|
633
|
-
|
|
634
|
-
|
|
635
|
-
|
|
636
|
-
|
|
637
|
-
/** @example false */
|
|
638
|
-
archived?: boolean;
|
|
639
|
-
/** @example https://apiqa.tal.deere.com/platform/organizations/5555/clients/22b84b4c-b651-d554-a02b-89829cd5239c */
|
|
640
|
-
clientUri?: string;
|
|
641
|
-
readonly links?: {
|
|
642
|
-
/** @example Link */
|
|
643
|
-
'@type'?: string;
|
|
644
|
-
/** @example self */
|
|
645
|
-
rel?: string;
|
|
646
|
-
/** @example https://apiqa.tal.deere.com/platform/organizations/5555/farms/9369f3f6-2428-4bba-bf64-0a19cdaf007d */
|
|
647
|
-
uri?: string;
|
|
648
|
-
}[];
|
|
669
|
+
};
|
|
670
|
+
responses: {
|
|
671
|
+
/** @description Field successfully created */
|
|
672
|
+
Created: {
|
|
673
|
+
headers: {
|
|
674
|
+
/** @description The uri of the newly created resource */
|
|
675
|
+
Location?: string;
|
|
676
|
+
[name: string]: unknown;
|
|
677
|
+
};
|
|
678
|
+
content?: never;
|
|
649
679
|
};
|
|
650
|
-
/** @description
|
|
651
|
-
|
|
652
|
-
|
|
653
|
-
|
|
654
|
-
/** @example Land_Demo_1 */
|
|
655
|
-
name?: string;
|
|
656
|
-
/** @example true */
|
|
657
|
-
archived?: boolean;
|
|
658
|
-
Farms?: {
|
|
659
|
-
/** @example Farms */
|
|
660
|
-
'@Type'?: string;
|
|
661
|
-
farms?: components['schemas']['CreateUpdateFarm'][];
|
|
680
|
+
/** @description Field deleted. If the client and farm has only this field the client and farm will be deleted */
|
|
681
|
+
Deleted: {
|
|
682
|
+
headers: {
|
|
683
|
+
[name: string]: unknown;
|
|
662
684
|
};
|
|
663
|
-
|
|
664
|
-
|
|
665
|
-
'@Type'?: string;
|
|
666
|
-
clients?: components['schemas']['CreateUpdateClient'][];
|
|
685
|
+
content: {
|
|
686
|
+
'application/vnd:deere:axiom:v3+json': unknown;
|
|
667
687
|
};
|
|
668
688
|
};
|
|
669
|
-
|
|
670
|
-
|
|
689
|
+
/** @description Invalid access to organization */
|
|
690
|
+
DoesNotHaveAccessToOrg: {
|
|
691
|
+
headers: {
|
|
692
|
+
[name: string]: unknown;
|
|
693
|
+
};
|
|
694
|
+
content?: never;
|
|
695
|
+
};
|
|
671
696
|
/** @description Array of farms */
|
|
672
697
|
FarmsReturned: {
|
|
673
698
|
headers: {
|
|
@@ -677,30 +702,22 @@ export interface components {
|
|
|
677
702
|
'application/vnd.deere.axiom.v3+json': components['schemas']['GetFarms'];
|
|
678
703
|
};
|
|
679
704
|
};
|
|
680
|
-
/** @description
|
|
681
|
-
|
|
705
|
+
/** @description Success */
|
|
706
|
+
FieldReturned: {
|
|
682
707
|
headers: {
|
|
683
708
|
[name: string]: unknown;
|
|
684
709
|
};
|
|
685
710
|
content: {
|
|
686
|
-
'application/vnd.deere.axiom.v3+json': components['schemas']['
|
|
711
|
+
'application/vnd.deere.axiom.v3+json': components['schemas']['FieldResponse'];
|
|
687
712
|
};
|
|
688
713
|
};
|
|
689
|
-
/** @description
|
|
690
|
-
|
|
714
|
+
/** @description Array of fields containing links related to fields */
|
|
715
|
+
FieldsReturned: {
|
|
691
716
|
headers: {
|
|
692
717
|
[name: string]: unknown;
|
|
693
718
|
};
|
|
694
719
|
content: {
|
|
695
|
-
'application/vnd.deere.axiom.v3+json':
|
|
696
|
-
links?: components['schemas']['GroupLink'][];
|
|
697
|
-
/**
|
|
698
|
-
* Format: int32
|
|
699
|
-
* @example 1
|
|
700
|
-
*/
|
|
701
|
-
total?: number;
|
|
702
|
-
values?: components['schemas']['FieldResponse'][];
|
|
703
|
-
};
|
|
720
|
+
'application/vnd.deere.axiom.v3+json': components['schemas']['FieldsResponse'];
|
|
704
721
|
};
|
|
705
722
|
};
|
|
706
723
|
/** @description Array of fields with header for partial success. */
|
|
@@ -714,22 +731,6 @@ export interface components {
|
|
|
714
731
|
'application/vnd.deere.axiom.v3+json': components['schemas']['FieldsResponse'];
|
|
715
732
|
};
|
|
716
733
|
};
|
|
717
|
-
/** @description Success */
|
|
718
|
-
FieldReturned: {
|
|
719
|
-
headers: {
|
|
720
|
-
[name: string]: unknown;
|
|
721
|
-
};
|
|
722
|
-
content: {
|
|
723
|
-
'application/vnd.deere.axiom.v3+json': components['schemas']['FieldResponse'];
|
|
724
|
-
};
|
|
725
|
-
};
|
|
726
|
-
/** @description Invalid access to organization */
|
|
727
|
-
DoesNotHaveAccessToOrg: {
|
|
728
|
-
headers: {
|
|
729
|
-
[name: string]: unknown;
|
|
730
|
-
};
|
|
731
|
-
content?: never;
|
|
732
|
-
};
|
|
733
734
|
/** @description Organization not found */
|
|
734
735
|
OrgNotFound: {
|
|
735
736
|
headers: {
|
|
@@ -744,15 +745,6 @@ export interface components {
|
|
|
744
745
|
};
|
|
745
746
|
content?: never;
|
|
746
747
|
};
|
|
747
|
-
/** @description Field successfully created */
|
|
748
|
-
Created: {
|
|
749
|
-
headers: {
|
|
750
|
-
/** @description The uri of the newly created resource */
|
|
751
|
-
Location?: string;
|
|
752
|
-
[name: string]: unknown;
|
|
753
|
-
};
|
|
754
|
-
content?: never;
|
|
755
|
-
};
|
|
756
748
|
/** @description Field successfully updated */
|
|
757
749
|
Updated: {
|
|
758
750
|
headers: {
|
|
@@ -762,14 +754,12 @@ export interface components {
|
|
|
762
754
|
'application/vnd.deere.axiom.v3+json': components['schemas']['FieldsPost'];
|
|
763
755
|
};
|
|
764
756
|
};
|
|
765
|
-
/** @description
|
|
766
|
-
|
|
757
|
+
/** @description The possible errors are: * CFF_CLIENT_ID_ALREADY_EXISTS * CFF_BAD_CLIENT_ID * CFF_CLIENT_ID_NAME_CONFLICT * CFF_CLIENT_ID_NOT_FOUND * CFF_CLIENT_NAME_ALREADY_EXISTS * CFF_EMPTY_CLIENT_NAME * CFF_CLIENT_NAME_EXCEEDS_255_CHARS * CFF_DUPLICATE_GUID_WITHIN_DOCUMENT * CFF_FARM_EXISTS_UNDER_DIFFERENT_CLIENT * CFF_FARM_ID_ALREADY_EXISTS * CFF_BAD_FARM_ID * CFF_FARM_ID_NAME_CONFLICT * CFF_FARM_ID_NOT_FOUND * CFF_FARM_NAME_ALREADY_EXISTS * CFF_EMPTY_FARM_NAME * CFF_FARM_NAME_EXCEEDS_255_CHARS * CFF_ALREADY_EXISTS_ACTIVE * CFF_ALREADY_EXISTS_ARCHIVED * CFF_ALREADY_EXISTS_MERGED * CFF_FIELD_ID_ALREADY_EXISTS * CFF_BAD_FIELD_ID * CFF_FIELD_NAME_ALREADY_EXISTS * CFF_EMPTY_FIELD_NAME * CFF_FIELD_NAME_EXCEEDS_255_CHARS * CFF_MISSING_REQUEST_BODY * CFF_OUTDATED_REQUEST * CFF_USER_LAST_MODIFIED_CLIPPED */
|
|
758
|
+
ValidationErrorForCreate: {
|
|
767
759
|
headers: {
|
|
768
760
|
[name: string]: unknown;
|
|
769
761
|
};
|
|
770
|
-
content
|
|
771
|
-
'application/vnd:deere:axiom:v3+json': unknown;
|
|
772
|
-
};
|
|
762
|
+
content?: never;
|
|
773
763
|
};
|
|
774
764
|
/** @description The possible errors are: * CFF_CLIENT_ID_ALREADY_EXISTS * CFF_BAD_CLIENT_ID * CFF_CLIENT_ID_NAME_CONFLICT * CFF_CLIENT_ID_NOT_FOUND * CFF_CLIENT_NAME_ALREADY_EXISTS * CFF_EMPTY_CLIENT_NAME * CFF_CLIENT_NAME_EXCEEDS_255_CHARS * CFF_DUPLICATE_GUID_WITHIN_DOCUMENT * CFF_FARM_EXISTS_UNDER_DIFFERENT_CLIENT * CFF_FARM_ID_ALREADY_EXISTS * CFF_BAD_FARM_ID * CFF_FARM_ID_NAME_CONFLICT * CFF_FARM_ID_NOT_FOUND * CFF_FARM_NAME_ALREADY_EXISTS * CFF_EMPTY_FARM_NAME * CFF_FARM_NAME_EXCEEDS_255_CHARS * CFF_ALREADY_EXISTS_ACTIVE * CFF_ALREADY_EXISTS_ARCHIVED * CFF_ALREADY_EXISTS_MERGED * CFF_FIELD_ID_ALREADY_EXISTS * CFF_BAD_FIELD_ID * CFF_FIELD_NAME_ALREADY_EXISTS * CFF_EMPTY_FIELD_NAME * CFF_FIELD_NAME_EXCEEDS_255_CHARS * CFF_MISSING_REQUEST_BODY * CFF_OUTDATED_REQUEST * CFF_USER_LAST_MODIFIED_CLIPPED */
|
|
775
765
|
ValidationErrorForUpdate: {
|
|
@@ -778,37 +768,47 @@ export interface components {
|
|
|
778
768
|
};
|
|
779
769
|
content?: never;
|
|
780
770
|
};
|
|
781
|
-
/** @description
|
|
782
|
-
|
|
771
|
+
/** @description Get Field by client Id */
|
|
772
|
+
getFieldResponse: {
|
|
783
773
|
headers: {
|
|
784
774
|
[name: string]: unknown;
|
|
785
775
|
};
|
|
786
|
-
content
|
|
776
|
+
content: {
|
|
777
|
+
'application/vnd.deere.axiom.v3+json': {
|
|
778
|
+
links?: components['schemas']['GroupLink'][];
|
|
779
|
+
/**
|
|
780
|
+
* Format: int32
|
|
781
|
+
* @example 1
|
|
782
|
+
*/
|
|
783
|
+
total?: number;
|
|
784
|
+
values?: components['schemas']['FieldResponse'][];
|
|
785
|
+
};
|
|
786
|
+
};
|
|
787
787
|
};
|
|
788
788
|
};
|
|
789
789
|
parameters: {
|
|
790
|
-
/** @description The ID of the organization */
|
|
791
|
-
OrgId: number;
|
|
792
|
-
/** @description x-deere-signature should be managed by the client per user per API. For a new user/new API, the first request will have a blank value for x-deere-signature. Changes can be tracked with the x-deere-signature returned in the response. If the response has not changed since the last API call, the value of x-deere-signature is not changed and the client should use the same String Token next time. */
|
|
793
|
-
'X-deere-signature': string;
|
|
794
790
|
/** @description client name */
|
|
795
791
|
ClientName: string;
|
|
792
|
+
/** @description Context Organization ID */
|
|
793
|
+
ContextOrganizationId: string;
|
|
796
794
|
/** @description farm name */
|
|
797
795
|
FarmName: string;
|
|
798
|
-
/** @description field name */
|
|
799
|
-
FieldName: string;
|
|
800
|
-
/** @description Filters by resource state (whether or not the resource is archived) */
|
|
801
|
-
recordFilter: 'AVAILABLE' | 'ARCHIVED' | 'ALL';
|
|
802
|
-
/** @description list of objects to include */
|
|
803
|
-
FieldsEmbed: ('farms' | 'clients' | 'boundaries' | 'activeBoundary' | 'simplifiedBoundaries' | 'guidanceLines' | 'accessPoints' | 'notes')[];
|
|
804
796
|
/** @description list of objects to include */
|
|
805
797
|
FieldEmbed: ('farms' | 'clients' | 'guidanceLines' | 'accessPoints')[];
|
|
806
|
-
/** @description Context Organization ID */
|
|
807
|
-
ContextOrganizationId: string;
|
|
808
798
|
/** @description field guid */
|
|
809
799
|
FieldId: string;
|
|
800
|
+
/** @description field name */
|
|
801
|
+
FieldName: string;
|
|
802
|
+
/** @description list of objects to include */
|
|
803
|
+
FieldsEmbed: ('farms' | 'clients' | 'boundaries' | 'activeBoundary' | 'simplifiedBoundaries' | 'guidanceLines' | 'accessPoints' | 'notes')[];
|
|
804
|
+
/** @description The ID of the organization */
|
|
805
|
+
OrgId: number;
|
|
810
806
|
/** @description Indicates a preference for returned measurements to be in English vs Metric */
|
|
811
807
|
UnitOfMeasureHeader: 'METRIC' | 'ENGLISH';
|
|
808
|
+
/** @description x-deere-signature should be managed by the client per user per API. For a new user/new API, the first request will have a blank value for x-deere-signature. Changes can be tracked with the x-deere-signature returned in the response. If the response has not changed since the last API call, the value of x-deere-signature is not changed and the client should use the same String Token next time. */
|
|
809
|
+
'X-deere-signature': string;
|
|
810
|
+
/** @description Filters by resource state (whether or not the resource is archived) */
|
|
811
|
+
recordFilter: 'AVAILABLE' | 'ARCHIVED' | 'ALL';
|
|
812
812
|
};
|
|
813
813
|
requestBodies: {
|
|
814
814
|
ASingleField: {
|