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,39 @@
|
|
|
3
3
|
* Do not make direct changes to the file.
|
|
4
4
|
*/
|
|
5
5
|
export interface paths {
|
|
6
|
+
'/fieldOperations/{operationId}/boundary': {
|
|
7
|
+
parameters: {
|
|
8
|
+
query?: never;
|
|
9
|
+
header?: never;
|
|
10
|
+
path?: never;
|
|
11
|
+
cookie?: never;
|
|
12
|
+
};
|
|
13
|
+
/**
|
|
14
|
+
* Generate a Boundary from a FieldOperation
|
|
15
|
+
* @description Given a , this endpoint will generate and return a boundary that surrounds the area worked by that field operation. Any gaps in that field operation will be treated as interior rings. This endpoint returns the generated boundary, giving you the opportunity to change the boundary name, clean up any unwanted interiors, etc. before back into Operations Center. There are two cases where this API will return an HTTP 400 - Bad Request: If the field already has an active boundary. In this case, please use the existing boundary - it is likely more accurate than a generated boundary. If the field has been merged. In this case, a FieldOperation may only cover one part of the merged field, resulting in an inaccurate boundary.
|
|
16
|
+
*/
|
|
17
|
+
get: {
|
|
18
|
+
parameters: {
|
|
19
|
+
query?: never;
|
|
20
|
+
header?: never;
|
|
21
|
+
path?: never;
|
|
22
|
+
cookie?: never;
|
|
23
|
+
};
|
|
24
|
+
requestBody?: never;
|
|
25
|
+
responses: {
|
|
26
|
+
200: components['responses']['BoundariesResponse2'];
|
|
27
|
+
403: components['responses']['Forbidden'];
|
|
28
|
+
404: components['responses']['NotFound'];
|
|
29
|
+
};
|
|
30
|
+
};
|
|
31
|
+
put?: never;
|
|
32
|
+
post?: never;
|
|
33
|
+
delete?: never;
|
|
34
|
+
options?: never;
|
|
35
|
+
head?: never;
|
|
36
|
+
patch?: never;
|
|
37
|
+
trace?: never;
|
|
38
|
+
};
|
|
6
39
|
'/organizations/{orgId}/boundaries': {
|
|
7
40
|
parameters: {
|
|
8
41
|
query?: never;
|
|
@@ -114,39 +147,6 @@ export interface paths {
|
|
|
114
147
|
patch?: never;
|
|
115
148
|
trace?: never;
|
|
116
149
|
};
|
|
117
|
-
'/fieldOperations/{operationId}/boundary': {
|
|
118
|
-
parameters: {
|
|
119
|
-
query?: never;
|
|
120
|
-
header?: never;
|
|
121
|
-
path?: never;
|
|
122
|
-
cookie?: never;
|
|
123
|
-
};
|
|
124
|
-
/**
|
|
125
|
-
* Generate a Boundary from a FieldOperation
|
|
126
|
-
* @description Given a , this endpoint will generate and return a boundary that surrounds the area worked by that field operation. Any gaps in that field operation will be treated as interior rings. This endpoint returns the generated boundary, giving you the opportunity to change the boundary name, clean up any unwanted interiors, etc. before back into Operations Center. There are two cases where this API will return an HTTP 400 - Bad Request: If the field already has an active boundary. In this case, please use the existing boundary - it is likely more accurate than a generated boundary. If the field has been merged. In this case, a FieldOperation may only cover one part of the merged field, resulting in an inaccurate boundary.
|
|
127
|
-
*/
|
|
128
|
-
get: {
|
|
129
|
-
parameters: {
|
|
130
|
-
query?: never;
|
|
131
|
-
header?: never;
|
|
132
|
-
path?: never;
|
|
133
|
-
cookie?: never;
|
|
134
|
-
};
|
|
135
|
-
requestBody?: never;
|
|
136
|
-
responses: {
|
|
137
|
-
200: components['responses']['BoundariesResponse2'];
|
|
138
|
-
403: components['responses']['Forbidden'];
|
|
139
|
-
404: components['responses']['NotFound'];
|
|
140
|
-
};
|
|
141
|
-
};
|
|
142
|
-
put?: never;
|
|
143
|
-
post?: never;
|
|
144
|
-
delete?: never;
|
|
145
|
-
options?: never;
|
|
146
|
-
head?: never;
|
|
147
|
-
patch?: never;
|
|
148
|
-
trace?: never;
|
|
149
|
-
};
|
|
150
150
|
'/organizations/{orgId}/fields/{fieldId}/boundaries/{boundaryId}': {
|
|
151
151
|
parameters: {
|
|
152
152
|
query?: never;
|
|
@@ -245,304 +245,249 @@ export interface paths {
|
|
|
245
245
|
export type webhooks = Record<string, never>;
|
|
246
246
|
export interface components {
|
|
247
247
|
schemas: {
|
|
248
|
-
|
|
249
|
-
RecordMetadata: {
|
|
248
|
+
AccuracyData: {
|
|
250
249
|
/**
|
|
251
|
-
* @
|
|
252
|
-
* @example
|
|
250
|
+
* @description Identifies the class
|
|
251
|
+
* @example Accuracy Data
|
|
253
252
|
*/
|
|
254
|
-
'@type'
|
|
253
|
+
'@type'?: string;
|
|
254
|
+
datums?: components['schemas']['DatumRange'][];
|
|
255
|
+
locationSources?: components['schemas']['LocationSourceRange'][];
|
|
256
|
+
signalTypes?: components['schemas']['SignalTypeRange'][];
|
|
257
|
+
horizontalErrorEstimates_mm?: components['schemas']['MeasurementAsDouble'];
|
|
258
|
+
snapDistanceRanges?: components['schemas']['SnapDistanceRange'][];
|
|
255
259
|
/**
|
|
256
|
-
* @description
|
|
257
|
-
* @example
|
|
260
|
+
* @description This indicates the style of simplification applied to a boundary.
|
|
261
|
+
* @example dtiBoundaryDP5InchNoMetadata
|
|
258
262
|
*/
|
|
259
|
-
|
|
263
|
+
simplificationAlgorithm?: string;
|
|
264
|
+
maxSnapDistance?: components['schemas']['MeasurementAsDouble'];
|
|
265
|
+
};
|
|
266
|
+
/** @description Indicates whether or not this boundary is Autonomous Ready. */
|
|
267
|
+
AutonomousReady: {
|
|
260
268
|
/**
|
|
261
|
-
* @description
|
|
262
|
-
* @
|
|
269
|
+
* @description Flag indicating if the boundary is ready for autonomous operations
|
|
270
|
+
* @default false
|
|
263
271
|
*/
|
|
264
|
-
|
|
272
|
+
boundaryAutonomousReady: boolean;
|
|
273
|
+
};
|
|
274
|
+
BoundariesLink: {
|
|
265
275
|
/**
|
|
266
|
-
* @description
|
|
267
|
-
* @example
|
|
276
|
+
* @description Fields Link.
|
|
277
|
+
* @example https://sandboxapi.deere.com/platform/organizations/123456/fields/209b3c20-f33a-4c96-9a2c-613def198e0c
|
|
268
278
|
*/
|
|
269
|
-
|
|
279
|
+
field?: unknown;
|
|
270
280
|
/**
|
|
271
|
-
* @description
|
|
272
|
-
* @example
|
|
281
|
+
* @description Organizations Link.
|
|
282
|
+
* @example https://sandboxapi.deere.com/platform/organizations/1234
|
|
273
283
|
*/
|
|
274
|
-
|
|
284
|
+
owningOrganization?: unknown;
|
|
285
|
+
};
|
|
286
|
+
Boundary: {
|
|
275
287
|
/**
|
|
276
|
-
*
|
|
277
|
-
* @
|
|
278
|
-
* @example 0235d40e-02d0-44cb-a126-fff21173fc1f
|
|
288
|
+
* @description Identifies the type Boundary
|
|
289
|
+
* @example Boundary
|
|
279
290
|
*/
|
|
280
|
-
|
|
291
|
+
'@type'?: string;
|
|
281
292
|
/**
|
|
282
293
|
* Format: uuid
|
|
283
|
-
* @description
|
|
284
|
-
* @example
|
|
294
|
+
* @description An identifier for this boundary, which is unique within a field context
|
|
295
|
+
* @example bed69949-df25-4319-8f6c-94c62b466126
|
|
285
296
|
*/
|
|
286
|
-
readonly
|
|
297
|
+
readonly id?: string;
|
|
298
|
+
/** @example unique_boundary_name */
|
|
299
|
+
name?: string;
|
|
287
300
|
/**
|
|
288
|
-
*
|
|
289
|
-
* @example
|
|
301
|
+
* Format: date-time
|
|
302
|
+
* @example 2018-07-01T21:00:11Z
|
|
290
303
|
*/
|
|
291
|
-
readonly
|
|
304
|
+
readonly createdTime?: string;
|
|
292
305
|
/**
|
|
293
|
-
*
|
|
294
|
-
* @
|
|
306
|
+
* Format: date-time
|
|
307
|
+
* @description An ISO-8601 formatted timestamp of the last modification made to this boundary
|
|
308
|
+
* @example 2016-11-17T11:53:00.000Z
|
|
295
309
|
*/
|
|
296
|
-
|
|
297
|
-
|
|
298
|
-
|
|
310
|
+
modifiedTime?: string;
|
|
311
|
+
area?: components['schemas']['MeasurementAsDouble'];
|
|
312
|
+
workableArea?: components['schemas']['MeasurementAsDouble'];
|
|
313
|
+
/** @description A collection of polygons */
|
|
314
|
+
multipolygons?: components['schemas']['Polygon'][];
|
|
315
|
+
extent?: components['schemas']['Extent'];
|
|
316
|
+
/** @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. */
|
|
317
|
+
active?: boolean;
|
|
318
|
+
/** @description Indicates whether or not this boundary is archived. */
|
|
319
|
+
archived?: boolean;
|
|
320
|
+
/** @description Indicates what signalType was used to capture boundary information */
|
|
321
|
+
signalType?: string;
|
|
322
|
+
/** @description Indicates whether the contained area is irrigated */
|
|
323
|
+
irrigated?: boolean;
|
|
299
324
|
/**
|
|
300
|
-
* @description
|
|
301
|
-
* @example
|
|
325
|
+
* @description sourceType of the boundary
|
|
326
|
+
* @example driven
|
|
302
327
|
*/
|
|
303
|
-
|
|
304
|
-
|
|
305
|
-
|
|
306
|
-
|
|
307
|
-
/** @example serialNumber */
|
|
308
|
-
serialNumber: string;
|
|
328
|
+
sourceType?: string;
|
|
329
|
+
readonly links?: components['schemas']['Link'][];
|
|
330
|
+
autonomousReady?: components['schemas']['AutonomousReady'];
|
|
331
|
+
recordMetadata?: components['schemas']['RecordMetadata'];
|
|
309
332
|
};
|
|
310
|
-
|
|
333
|
+
BoundaryOrgId: {
|
|
311
334
|
/**
|
|
312
|
-
*
|
|
313
|
-
* @
|
|
335
|
+
* Format: uuid
|
|
336
|
+
* @description Boundary ID
|
|
337
|
+
* @example 6232611a-0303-0234-8g7d-e1e1e11871b8
|
|
314
338
|
*/
|
|
315
|
-
|
|
316
|
-
/** @example currentActiveDatum */
|
|
317
|
-
currentActiveDatum: string;
|
|
318
|
-
currentActiveEpochTime?: components['schemas']['MeasurementAsDouble'];
|
|
319
|
-
baseLocation?: components['schemas']['ThreeDPoint'];
|
|
320
|
-
/** @example status */
|
|
321
|
-
status: string;
|
|
322
|
-
/** @example referenceDatumValue */
|
|
323
|
-
referenceDatum: string;
|
|
324
|
-
referenceEpochTime?: components['schemas']['MeasurementAsDouble'];
|
|
325
|
-
referencePositionOffsets?: components['schemas']['ThreeDPoint'];
|
|
326
|
-
datumCreationTime?: components['schemas']['MeasurementAsDouble'];
|
|
339
|
+
id?: string;
|
|
327
340
|
/**
|
|
328
|
-
* @description
|
|
329
|
-
* @example
|
|
341
|
+
* @description Boundary name
|
|
342
|
+
* @example Unique_Boundary_name
|
|
330
343
|
*/
|
|
331
|
-
|
|
332
|
-
};
|
|
333
|
-
ThreeDPoint: {
|
|
344
|
+
name?: string;
|
|
334
345
|
/**
|
|
335
|
-
* @description
|
|
336
|
-
* @example
|
|
346
|
+
* @description Boundary area
|
|
347
|
+
* @example See sample response below.
|
|
337
348
|
*/
|
|
338
|
-
|
|
349
|
+
area?: unknown;
|
|
339
350
|
/**
|
|
340
|
-
*
|
|
341
|
-
* @
|
|
342
|
-
* @example 32.118552
|
|
351
|
+
* @description Exteriors-interiors of the boundary.
|
|
352
|
+
* @example See sample response below.
|
|
343
353
|
*/
|
|
344
|
-
|
|
354
|
+
workableArea?: unknown;
|
|
345
355
|
/**
|
|
346
|
-
*
|
|
347
|
-
* @
|
|
348
|
-
* @example -81.260776
|
|
356
|
+
* @description Describes the source of boundary (requires license to set).
|
|
357
|
+
* @example HandDrawn
|
|
349
358
|
*/
|
|
350
|
-
|
|
359
|
+
sourceType?: string;
|
|
351
360
|
/**
|
|
352
|
-
*
|
|
353
|
-
* @
|
|
354
|
-
* @example 1
|
|
361
|
+
* @description Boundary shape and exact location.
|
|
362
|
+
* @example See sample response below
|
|
355
363
|
*/
|
|
356
|
-
|
|
357
|
-
};
|
|
358
|
-
DatumRange: {
|
|
364
|
+
multipolygons?: unknown;
|
|
359
365
|
/**
|
|
360
|
-
* @description
|
|
361
|
-
* @example
|
|
366
|
+
* @description Boundary type
|
|
367
|
+
* @example exterior
|
|
362
368
|
*/
|
|
363
|
-
|
|
369
|
+
type?: string;
|
|
364
370
|
/**
|
|
365
|
-
*
|
|
366
|
-
* @
|
|
367
|
-
* @example 0
|
|
371
|
+
* @description "True" indicates that the boundary can be crossed (Ex: a waterway). "False" indicates that the boundary cannot be crossed (ex: a boulder).
|
|
372
|
+
* @example true
|
|
368
373
|
*/
|
|
369
|
-
|
|
374
|
+
passable?: boolean;
|
|
370
375
|
/**
|
|
371
|
-
*
|
|
372
|
-
* @
|
|
373
|
-
* @example 127
|
|
376
|
+
* @description Coordinates of the extent of the boundary.
|
|
377
|
+
* @example See sample response below.
|
|
374
378
|
*/
|
|
375
|
-
|
|
376
|
-
datum?: components['schemas']['GPSDatum'];
|
|
377
|
-
};
|
|
378
|
-
LocationSourceRange: {
|
|
379
|
+
extent?: unknown;
|
|
379
380
|
/**
|
|
380
|
-
* @description
|
|
381
|
-
* @example
|
|
381
|
+
* @description Indicates whether or not the boundary is active.
|
|
382
|
+
* @example true
|
|
382
383
|
*/
|
|
383
|
-
|
|
384
|
+
active?: boolean;
|
|
384
385
|
/**
|
|
385
|
-
*
|
|
386
|
-
* @
|
|
387
|
-
* @example 0
|
|
386
|
+
* @description Indicates whether or not the boundary is archived.
|
|
387
|
+
* @example true
|
|
388
388
|
*/
|
|
389
|
-
|
|
389
|
+
archived?: boolean;
|
|
390
390
|
/**
|
|
391
|
-
*
|
|
392
|
-
* @
|
|
393
|
-
* @example 127
|
|
391
|
+
* @description Signal Type used when defining boundary. See “dtSignalType” in the John Deere representation system for possible values.
|
|
392
|
+
* @example dtiSignalTypeRTK
|
|
394
393
|
*/
|
|
395
|
-
|
|
394
|
+
signalType?: string;
|
|
396
395
|
/**
|
|
397
|
-
*
|
|
398
|
-
* @
|
|
396
|
+
* Format: date-time
|
|
397
|
+
* @description An ISO-8601 formatted timestamp of the last modification made to this boundary.
|
|
398
|
+
* @example 2017-11-16T15:43:27.496Z
|
|
399
399
|
*/
|
|
400
|
-
|
|
401
|
-
};
|
|
402
|
-
SignalTypeRange: {
|
|
400
|
+
modifiedTime?: string;
|
|
403
401
|
/**
|
|
404
|
-
*
|
|
405
|
-
* @
|
|
402
|
+
* Format: date-time
|
|
403
|
+
* @description An ISO-8601 formatted timestamp of the time this boundary was created.
|
|
404
|
+
* @example 2017-11-16T15:43:27.496Z
|
|
406
405
|
*/
|
|
407
|
-
|
|
406
|
+
createdTime?: string;
|
|
408
407
|
/**
|
|
409
|
-
* @description
|
|
410
|
-
* @example
|
|
408
|
+
* @description Indicates whether the contained area is irrigated.
|
|
409
|
+
* @example true
|
|
411
410
|
*/
|
|
412
|
-
|
|
411
|
+
irrigated?: boolean;
|
|
412
|
+
};
|
|
413
|
+
BoundaryOrgId2: {
|
|
413
414
|
/**
|
|
414
|
-
*
|
|
415
|
-
* @
|
|
415
|
+
* Format: uuid
|
|
416
|
+
* @description Boundary ID
|
|
417
|
+
* @example 6232611a-0303-0234-8g7d-e1e1e11871b8
|
|
416
418
|
*/
|
|
417
|
-
|
|
419
|
+
id?: string;
|
|
418
420
|
/**
|
|
419
|
-
* @description
|
|
420
|
-
* @example
|
|
421
|
+
* @description Boundary name
|
|
422
|
+
* @example AutoGenerated 2020 Seeding
|
|
421
423
|
*/
|
|
422
|
-
|
|
423
|
-
};
|
|
424
|
-
SnapDistanceRange: {
|
|
424
|
+
name?: string;
|
|
425
425
|
/**
|
|
426
|
-
* @description
|
|
427
|
-
* @example
|
|
426
|
+
* @description Describes the source of boundary (requires license to set).
|
|
427
|
+
* @example Auto
|
|
428
428
|
*/
|
|
429
|
-
|
|
429
|
+
sourceType?: string;
|
|
430
430
|
/**
|
|
431
|
-
* @description
|
|
432
|
-
* @example
|
|
431
|
+
* @description Boundary shape and exact location.
|
|
432
|
+
* @example See sample response below
|
|
433
433
|
*/
|
|
434
|
-
|
|
434
|
+
multipolygons?: unknown;
|
|
435
435
|
/**
|
|
436
|
-
* @description
|
|
437
|
-
* @example
|
|
436
|
+
* @description Boundary type
|
|
437
|
+
* @example exterior
|
|
438
438
|
*/
|
|
439
|
-
|
|
440
|
-
snapDistance?: components['schemas']['MeasurementAsDouble'];
|
|
441
|
-
};
|
|
442
|
-
AccuracyData: {
|
|
439
|
+
type?: string;
|
|
443
440
|
/**
|
|
444
|
-
* @description
|
|
445
|
-
* @example
|
|
441
|
+
* @description "True" indicates that the boundary can be crossed (Ex: a waterway). "False" indicates that the boundary cannot be crossed (ex: a boulder).
|
|
442
|
+
* @example true
|
|
446
443
|
*/
|
|
447
|
-
|
|
448
|
-
datums?: components['schemas']['DatumRange'][];
|
|
449
|
-
locationSources?: components['schemas']['LocationSourceRange'][];
|
|
450
|
-
signalTypes?: components['schemas']['SignalTypeRange'][];
|
|
451
|
-
horizontalErrorEstimates_mm?: components['schemas']['MeasurementAsDouble'];
|
|
452
|
-
snapDistanceRanges?: components['schemas']['SnapDistanceRange'][];
|
|
444
|
+
passable?: boolean;
|
|
453
445
|
/**
|
|
454
|
-
* @description
|
|
455
|
-
* @example
|
|
446
|
+
* @description Coordinates of the extent of the boundary.
|
|
447
|
+
* @example See sample response below.
|
|
456
448
|
*/
|
|
457
|
-
|
|
458
|
-
maxSnapDistance?: components['schemas']['MeasurementAsDouble'];
|
|
459
|
-
};
|
|
460
|
-
Headland: {
|
|
461
|
-
/** @example headland_name */
|
|
462
|
-
name: string;
|
|
463
|
-
points?: components['schemas']['Point'][];
|
|
464
|
-
/** @description indicates if this is the active headland in a collection */
|
|
465
|
-
active: boolean;
|
|
466
|
-
};
|
|
467
|
-
Point: {
|
|
449
|
+
extent?: unknown;
|
|
468
450
|
/**
|
|
469
|
-
* @description
|
|
470
|
-
* @example
|
|
451
|
+
* @description Indicates whether or not the boundary is active.
|
|
452
|
+
* @example true
|
|
471
453
|
*/
|
|
472
|
-
|
|
454
|
+
active?: boolean;
|
|
473
455
|
/**
|
|
474
|
-
*
|
|
475
|
-
* @
|
|
476
|
-
* @example 32.118552
|
|
456
|
+
* @description Signal Type used when defining boundary. See “dtSignalType” in the John Deere representation system for possible values.
|
|
457
|
+
* @example dtiSignalTypeRTK
|
|
477
458
|
*/
|
|
478
|
-
|
|
459
|
+
signalType?: string;
|
|
479
460
|
/**
|
|
480
|
-
* Format:
|
|
481
|
-
* @description
|
|
482
|
-
* @example -
|
|
461
|
+
* Format: date-time
|
|
462
|
+
* @description An ISO-8601 formatted timestamp of the last modification made to this boundary.
|
|
463
|
+
* @example 2017-11-16T15:43:27.496Z
|
|
483
464
|
*/
|
|
484
|
-
|
|
485
|
-
};
|
|
486
|
-
Extent: {
|
|
465
|
+
modifiedTime?: string;
|
|
487
466
|
/**
|
|
488
|
-
* @description
|
|
489
|
-
* @example
|
|
467
|
+
* @description Indicates whether the contained area is irrigated.
|
|
468
|
+
* @example true
|
|
490
469
|
*/
|
|
491
|
-
|
|
492
|
-
topLeft?: components['schemas']['Point'];
|
|
493
|
-
bottomRight?: components['schemas']['Point'];
|
|
470
|
+
irrigated?: boolean;
|
|
494
471
|
};
|
|
495
|
-
|
|
472
|
+
DatumRange: {
|
|
496
473
|
/**
|
|
497
474
|
* @description Identifies the class
|
|
498
|
-
* @example
|
|
475
|
+
* @example Datum Range
|
|
499
476
|
*/
|
|
500
477
|
'@type'?: string;
|
|
501
478
|
/**
|
|
502
|
-
* Format:
|
|
503
|
-
* @
|
|
479
|
+
* Format: int32
|
|
480
|
+
* @description starting point index this datum applies to relative to the boundary
|
|
481
|
+
* @example 0
|
|
504
482
|
*/
|
|
505
|
-
|
|
483
|
+
startPointIndex?: number;
|
|
506
484
|
/**
|
|
507
|
-
*
|
|
508
|
-
* @
|
|
485
|
+
* Format: int32
|
|
486
|
+
* @description ending point index this datum applies to relative to the boundary
|
|
487
|
+
* @example 127
|
|
509
488
|
*/
|
|
510
|
-
|
|
511
|
-
|
|
512
|
-
Polygon: {
|
|
513
|
-
rings?: {
|
|
514
|
-
/**
|
|
515
|
-
* @description identifier for polygon
|
|
516
|
-
* @example 1
|
|
517
|
-
*/
|
|
518
|
-
id?: number;
|
|
519
|
-
/**
|
|
520
|
-
* @description id of associated ring
|
|
521
|
-
* @example 5
|
|
522
|
-
*/
|
|
523
|
-
parentId?: number;
|
|
524
|
-
points?: components['schemas']['Point'][];
|
|
525
|
-
/**
|
|
526
|
-
* @description Describes whether this geometry is interior (e.g. a pond contained within a field) or exterior (e.g. a fence around the field)
|
|
527
|
-
* @enum {string}
|
|
528
|
-
*/
|
|
529
|
-
type?: 'interior' | 'exterior';
|
|
530
|
-
/** @description Describes whether or not a machine may travel through this geometry (e.g. a road vs a stream) */
|
|
531
|
-
passable?: boolean;
|
|
532
|
-
/** @description A collection of headlands */
|
|
533
|
-
headlands?: components['schemas']['Headland'][];
|
|
534
|
-
accuracyData?: components['schemas']['AccuracyData'];
|
|
535
|
-
/**
|
|
536
|
-
* @description value of signal type used
|
|
537
|
-
* @example dtiSignalTypeRTK
|
|
538
|
-
*/
|
|
539
|
-
signalType?: string;
|
|
540
|
-
/**
|
|
541
|
-
* @description To determine how their boundary was generated
|
|
542
|
-
* @example dtiBoundaryFromWebCoverage
|
|
543
|
-
*/
|
|
544
|
-
creationMethod?: string;
|
|
545
|
-
}[];
|
|
489
|
+
endPointIndex?: number;
|
|
490
|
+
datum?: components['schemas']['GPSDatum'];
|
|
546
491
|
};
|
|
547
492
|
/** Format: Errors/DataValidationException */
|
|
548
493
|
Errors: {
|
|
@@ -577,213 +522,202 @@ export interface components {
|
|
|
577
522
|
invalidValue?: string;
|
|
578
523
|
}[];
|
|
579
524
|
};
|
|
580
|
-
|
|
581
|
-
Link: {
|
|
582
|
-
/**
|
|
583
|
-
* @description The identifier for the associated resource. If the resource is embeddable, this is also the "embed" value.
|
|
584
|
-
* @example self
|
|
585
|
-
*/
|
|
586
|
-
rel: string;
|
|
525
|
+
Extent: {
|
|
587
526
|
/**
|
|
588
|
-
*
|
|
589
|
-
* @
|
|
590
|
-
* @example https://partnerapi.deere.com/platform/organizations/1/boundaries/00000000-0000-0000-0000-000000000000
|
|
527
|
+
* @description Identifies the class
|
|
528
|
+
* @example Extent
|
|
591
529
|
*/
|
|
592
|
-
|
|
530
|
+
'@type'?: string;
|
|
531
|
+
topLeft?: components['schemas']['Point'];
|
|
532
|
+
bottomRight?: components['schemas']['Point'];
|
|
593
533
|
};
|
|
594
|
-
|
|
595
|
-
AutonomousReady: {
|
|
534
|
+
GPSDatum: {
|
|
596
535
|
/**
|
|
597
|
-
* @description
|
|
598
|
-
* @
|
|
536
|
+
* @description Identifies the class
|
|
537
|
+
* @example GPS Datum
|
|
599
538
|
*/
|
|
600
|
-
|
|
539
|
+
'@type'?: string;
|
|
540
|
+
gpsDatumValue?: components['schemas']['GPSDatumValue'];
|
|
541
|
+
horizontalUncertainty?: components['schemas']['MeasurementAsDouble'];
|
|
542
|
+
verticalUncertainty?: components['schemas']['MeasurementAsDouble'];
|
|
543
|
+
/** @example serialNumber */
|
|
544
|
+
serialNumber: string;
|
|
601
545
|
};
|
|
602
|
-
|
|
546
|
+
GPSDatumValue: {
|
|
603
547
|
/**
|
|
604
|
-
* @description Identifies the
|
|
605
|
-
* @example
|
|
548
|
+
* @description Identifies the class
|
|
549
|
+
* @example GPS Datum values
|
|
606
550
|
*/
|
|
607
551
|
'@type'?: string;
|
|
552
|
+
/** @example currentActiveDatum */
|
|
553
|
+
currentActiveDatum: string;
|
|
554
|
+
currentActiveEpochTime?: components['schemas']['MeasurementAsDouble'];
|
|
555
|
+
baseLocation?: components['schemas']['ThreeDPoint'];
|
|
556
|
+
/** @example status */
|
|
557
|
+
status: string;
|
|
558
|
+
/** @example referenceDatumValue */
|
|
559
|
+
referenceDatum: string;
|
|
560
|
+
referenceEpochTime?: components['schemas']['MeasurementAsDouble'];
|
|
561
|
+
referencePositionOffsets?: components['schemas']['ThreeDPoint'];
|
|
562
|
+
datumCreationTime?: components['schemas']['MeasurementAsDouble'];
|
|
608
563
|
/**
|
|
609
|
-
*
|
|
610
|
-
* @
|
|
611
|
-
* @example bed69949-df25-4319-8f6c-94c62b466126
|
|
612
|
-
*/
|
|
613
|
-
readonly id?: string;
|
|
614
|
-
/** @example unique_boundary_name */
|
|
615
|
-
name?: string;
|
|
616
|
-
/**
|
|
617
|
-
* Format: date-time
|
|
618
|
-
* @example 2018-07-01T21:00:11Z
|
|
619
|
-
*/
|
|
620
|
-
readonly createdTime?: string;
|
|
621
|
-
/**
|
|
622
|
-
* Format: date-time
|
|
623
|
-
* @description An ISO-8601 formatted timestamp of the last modification made to this boundary
|
|
624
|
-
* @example 2016-11-17T11:53:00.000Z
|
|
625
|
-
*/
|
|
626
|
-
modifiedTime?: string;
|
|
627
|
-
area?: components['schemas']['MeasurementAsDouble'];
|
|
628
|
-
workableArea?: components['schemas']['MeasurementAsDouble'];
|
|
629
|
-
/** @description A collection of polygons */
|
|
630
|
-
multipolygons?: components['schemas']['Polygon'][];
|
|
631
|
-
extent?: components['schemas']['Extent'];
|
|
632
|
-
/** @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. */
|
|
633
|
-
active?: boolean;
|
|
634
|
-
/** @description Indicates whether or not this boundary is archived. */
|
|
635
|
-
archived?: boolean;
|
|
636
|
-
/** @description Indicates what signalType was used to capture boundary information */
|
|
637
|
-
signalType?: string;
|
|
638
|
-
/** @description Indicates whether the contained area is irrigated */
|
|
639
|
-
irrigated?: boolean;
|
|
640
|
-
/**
|
|
641
|
-
* @description sourceType of the boundary
|
|
642
|
-
* @example driven
|
|
564
|
+
* @description Unique id for this datum
|
|
565
|
+
* @example 205ff5ba-8d63-4a66-bbfe-b2a31ebad0d3
|
|
643
566
|
*/
|
|
644
|
-
|
|
645
|
-
readonly links?: components['schemas']['Link'][];
|
|
646
|
-
autonomousReady?: components['schemas']['AutonomousReady'];
|
|
647
|
-
recordMetadata?: components['schemas']['RecordMetadata'];
|
|
567
|
+
datumUuid: string;
|
|
648
568
|
};
|
|
649
|
-
|
|
650
|
-
/**
|
|
651
|
-
|
|
652
|
-
|
|
653
|
-
|
|
654
|
-
|
|
655
|
-
|
|
656
|
-
|
|
657
|
-
|
|
658
|
-
* @example Unique_Boundary_name
|
|
659
|
-
*/
|
|
660
|
-
name?: string;
|
|
661
|
-
/**
|
|
662
|
-
* @description Boundary area
|
|
663
|
-
* @example See sample response below.
|
|
664
|
-
*/
|
|
665
|
-
area?: unknown;
|
|
569
|
+
Headland: {
|
|
570
|
+
/** @example headland_name */
|
|
571
|
+
name: string;
|
|
572
|
+
points?: components['schemas']['Point'][];
|
|
573
|
+
/** @description indicates if this is the active headland in a collection */
|
|
574
|
+
active: boolean;
|
|
575
|
+
};
|
|
576
|
+
/** @description Provides a reference to an associated object or list */
|
|
577
|
+
Link: {
|
|
666
578
|
/**
|
|
667
|
-
* @description
|
|
668
|
-
* @example
|
|
579
|
+
* @description The identifier for the associated resource. If the resource is embeddable, this is also the "embed" value.
|
|
580
|
+
* @example self
|
|
669
581
|
*/
|
|
670
|
-
|
|
582
|
+
rel: string;
|
|
671
583
|
/**
|
|
672
|
-
*
|
|
673
|
-
* @
|
|
584
|
+
* Format: uri
|
|
585
|
+
* @description The location of the resource
|
|
586
|
+
* @example https://partnerapi.deere.com/platform/organizations/1/boundaries/00000000-0000-0000-0000-000000000000
|
|
674
587
|
*/
|
|
675
|
-
|
|
588
|
+
uri: string;
|
|
589
|
+
};
|
|
590
|
+
LocationSourceRange: {
|
|
676
591
|
/**
|
|
677
|
-
* @description
|
|
678
|
-
* @example
|
|
592
|
+
* @description Identifies the class
|
|
593
|
+
* @example Location Source Range
|
|
679
594
|
*/
|
|
680
|
-
|
|
595
|
+
'@type'?: string;
|
|
681
596
|
/**
|
|
682
|
-
*
|
|
683
|
-
* @
|
|
597
|
+
* Format: int32
|
|
598
|
+
* @description starting point index this location source applies to relative to the boundary
|
|
599
|
+
* @example 0
|
|
684
600
|
*/
|
|
685
|
-
|
|
601
|
+
startPointIndex?: number;
|
|
686
602
|
/**
|
|
687
|
-
*
|
|
688
|
-
* @
|
|
603
|
+
* Format: int32
|
|
604
|
+
* @description ending point index this location source applies to relative to the boundary
|
|
605
|
+
* @example 127
|
|
689
606
|
*/
|
|
690
|
-
|
|
607
|
+
endPointIndex?: number;
|
|
691
608
|
/**
|
|
692
|
-
* @description
|
|
693
|
-
* @example
|
|
609
|
+
* @description value of location source used
|
|
610
|
+
* @example "locationSource": "Computed from Rigid Kinematics"
|
|
694
611
|
*/
|
|
695
|
-
|
|
612
|
+
locationSource?: string;
|
|
613
|
+
};
|
|
614
|
+
MeasurementAsDouble: {
|
|
696
615
|
/**
|
|
697
|
-
* @description
|
|
698
|
-
* @example
|
|
616
|
+
* @description Identifies the class
|
|
617
|
+
* @example MeasurementAsDouble
|
|
699
618
|
*/
|
|
700
|
-
|
|
619
|
+
'@type'?: string;
|
|
701
620
|
/**
|
|
702
|
-
*
|
|
703
|
-
* @example
|
|
621
|
+
* Format: double
|
|
622
|
+
* @example 7.502938
|
|
704
623
|
*/
|
|
705
|
-
|
|
624
|
+
valueAsDouble?: number;
|
|
706
625
|
/**
|
|
707
|
-
* @description
|
|
708
|
-
* @example
|
|
626
|
+
* @description The unit of measure for this value
|
|
627
|
+
* @example ha
|
|
709
628
|
*/
|
|
710
|
-
|
|
629
|
+
unit?: string;
|
|
630
|
+
};
|
|
631
|
+
Point: {
|
|
711
632
|
/**
|
|
712
|
-
*
|
|
713
|
-
* @
|
|
714
|
-
* @example 2017-11-16T15:43:27.496Z
|
|
633
|
+
* @description Identifies the class
|
|
634
|
+
* @example Point
|
|
715
635
|
*/
|
|
716
|
-
|
|
636
|
+
'@type'?: string;
|
|
717
637
|
/**
|
|
718
|
-
* Format:
|
|
719
|
-
* @description
|
|
720
|
-
* @example
|
|
638
|
+
* Format: double
|
|
639
|
+
* @description The latitude of the point
|
|
640
|
+
* @example 32.118552
|
|
721
641
|
*/
|
|
722
|
-
|
|
642
|
+
lat?: number;
|
|
723
643
|
/**
|
|
724
|
-
*
|
|
725
|
-
* @
|
|
644
|
+
* Format: double
|
|
645
|
+
* @description The longitude of the point
|
|
646
|
+
* @example -81.260776
|
|
726
647
|
*/
|
|
727
|
-
|
|
648
|
+
lon?: number;
|
|
728
649
|
};
|
|
729
|
-
|
|
730
|
-
|
|
731
|
-
|
|
732
|
-
|
|
733
|
-
|
|
734
|
-
|
|
735
|
-
|
|
736
|
-
|
|
737
|
-
|
|
738
|
-
|
|
739
|
-
|
|
740
|
-
|
|
650
|
+
Polygon: {
|
|
651
|
+
rings?: {
|
|
652
|
+
/**
|
|
653
|
+
* @description identifier for polygon
|
|
654
|
+
* @example 1
|
|
655
|
+
*/
|
|
656
|
+
id?: number;
|
|
657
|
+
/**
|
|
658
|
+
* @description id of associated ring
|
|
659
|
+
* @example 5
|
|
660
|
+
*/
|
|
661
|
+
parentId?: number;
|
|
662
|
+
points?: components['schemas']['Point'][];
|
|
663
|
+
/**
|
|
664
|
+
* @description Describes whether this geometry is interior (e.g. a pond contained within a field) or exterior (e.g. a fence around the field)
|
|
665
|
+
* @enum {string}
|
|
666
|
+
*/
|
|
667
|
+
type?: 'interior' | 'exterior';
|
|
668
|
+
/** @description Describes whether or not a machine may travel through this geometry (e.g. a road vs a stream) */
|
|
669
|
+
passable?: boolean;
|
|
670
|
+
/** @description A collection of headlands */
|
|
671
|
+
headlands?: components['schemas']['Headland'][];
|
|
672
|
+
accuracyData?: components['schemas']['AccuracyData'];
|
|
673
|
+
/**
|
|
674
|
+
* @description value of signal type used
|
|
675
|
+
* @example dtiSignalTypeRTK
|
|
676
|
+
*/
|
|
677
|
+
signalType?: string;
|
|
678
|
+
/**
|
|
679
|
+
* @description To determine how their boundary was generated
|
|
680
|
+
* @example dtiBoundaryFromWebCoverage
|
|
681
|
+
*/
|
|
682
|
+
creationMethod?: string;
|
|
683
|
+
}[];
|
|
684
|
+
};
|
|
685
|
+
PostBoundary: {
|
|
741
686
|
/**
|
|
742
|
-
* @description
|
|
743
|
-
* @example
|
|
687
|
+
* @description Boundary Name.
|
|
688
|
+
* @example Boundary_Unique_Name
|
|
744
689
|
*/
|
|
745
|
-
|
|
690
|
+
name?: string;
|
|
746
691
|
/**
|
|
747
|
-
* @description
|
|
748
|
-
* @example
|
|
692
|
+
* @description Indicates whether the boundary is active in this field.
|
|
693
|
+
* @example false
|
|
749
694
|
*/
|
|
750
|
-
|
|
695
|
+
active?: boolean;
|
|
751
696
|
/**
|
|
752
|
-
* @description
|
|
753
|
-
* @example
|
|
697
|
+
* @description Indicates whether the boundary is archived.
|
|
698
|
+
* @example false
|
|
754
699
|
*/
|
|
755
|
-
|
|
700
|
+
archive?: boolean;
|
|
756
701
|
/**
|
|
757
|
-
* @description
|
|
758
|
-
* @example
|
|
702
|
+
* @description Indicates whether the boundary is irrigated.
|
|
703
|
+
* @example false
|
|
759
704
|
*/
|
|
760
|
-
|
|
705
|
+
irrigated?: boolean;
|
|
761
706
|
/**
|
|
762
|
-
* @description
|
|
763
|
-
* @example See sample
|
|
707
|
+
* @description Polygon representation of the new boundary.
|
|
708
|
+
* @example See sample request below.
|
|
764
709
|
*/
|
|
765
|
-
|
|
710
|
+
multipolygons?: unknown;
|
|
766
711
|
/**
|
|
767
|
-
* @description
|
|
768
|
-
* @example
|
|
712
|
+
* @description Describes the source of boundary (requires license to set).
|
|
713
|
+
* @example External
|
|
769
714
|
*/
|
|
770
|
-
|
|
715
|
+
sourceType?: string;
|
|
771
716
|
/**
|
|
772
717
|
* @description Signal Type used when defining boundary. See “dtSignalType” in the John Deere representation system for possible values.
|
|
773
718
|
* @example dtiSignalTypeRTK
|
|
774
719
|
*/
|
|
775
720
|
signalType?: string;
|
|
776
|
-
/**
|
|
777
|
-
* Format: date-time
|
|
778
|
-
* @description An ISO-8601 formatted timestamp of the last modification made to this boundary.
|
|
779
|
-
* @example 2017-11-16T15:43:27.496Z
|
|
780
|
-
*/
|
|
781
|
-
modifiedTime?: string;
|
|
782
|
-
/**
|
|
783
|
-
* @description Indicates whether the contained area is irrigated.
|
|
784
|
-
* @example true
|
|
785
|
-
*/
|
|
786
|
-
irrigated?: boolean;
|
|
787
721
|
};
|
|
788
722
|
PostBoundaryGet: {
|
|
789
723
|
/**
|
|
@@ -865,10 +799,10 @@ export interface components {
|
|
|
865
799
|
*/
|
|
866
800
|
passable?: boolean;
|
|
867
801
|
};
|
|
868
|
-
|
|
802
|
+
PutBoundary: {
|
|
869
803
|
/**
|
|
870
804
|
* @description Boundary Name.
|
|
871
|
-
* @example
|
|
805
|
+
* @example Boundary01
|
|
872
806
|
*/
|
|
873
807
|
name?: string;
|
|
874
808
|
/**
|
|
@@ -902,57 +836,132 @@ export interface components {
|
|
|
902
836
|
*/
|
|
903
837
|
signalType?: string;
|
|
904
838
|
};
|
|
905
|
-
|
|
839
|
+
/** @description Data structure for record metadata capturing information about the creation and last update of an entity. For more information on Record Metadata visit [this confluence page](https://confluence.deere.com/x/eSGLDg). NOTES * Some attributes are only visible if the API Client has the required license. * Attributes dealing with modification will be null if the entity has been created but not modified. (Some legacy data may have set the create and modify timestamp at time of creation.) */
|
|
840
|
+
RecordMetadata: {
|
|
906
841
|
/**
|
|
907
|
-
* @
|
|
908
|
-
* @example
|
|
842
|
+
* @default RecordMetadata
|
|
843
|
+
* @example RecordMetadata
|
|
909
844
|
*/
|
|
910
|
-
|
|
845
|
+
'@type': string;
|
|
911
846
|
/**
|
|
912
|
-
* @description
|
|
913
|
-
* @example
|
|
847
|
+
* @description User involved in creating the entity. Only viewable with the RECORD_METADATA license
|
|
848
|
+
* @example XYZ_USER
|
|
914
849
|
*/
|
|
915
|
-
|
|
850
|
+
createdByUser?: string;
|
|
916
851
|
/**
|
|
917
|
-
* @description
|
|
918
|
-
* @example
|
|
852
|
+
* @description User involved in modifying the entity. Only viewable with the RECORD_METADATA license
|
|
853
|
+
* @example XYZ_USER
|
|
919
854
|
*/
|
|
920
|
-
|
|
855
|
+
lastModifiedByUser?: string;
|
|
921
856
|
/**
|
|
922
|
-
* @description
|
|
923
|
-
* @example
|
|
857
|
+
* @description Timestamp of entity creation
|
|
858
|
+
* @example 2018-04-30T10:23:50.000Z
|
|
924
859
|
*/
|
|
925
|
-
|
|
860
|
+
readonly userCreationTimestamp?: string;
|
|
926
861
|
/**
|
|
927
|
-
* @description
|
|
928
|
-
* @example
|
|
862
|
+
* @description Timestamp of entity modification
|
|
863
|
+
* @example 2018-05-01T08:11:23.000Z
|
|
929
864
|
*/
|
|
930
|
-
|
|
865
|
+
readonly userLastModifiedTimestamp?: string;
|
|
931
866
|
/**
|
|
932
|
-
*
|
|
933
|
-
* @
|
|
867
|
+
* Format: uuid
|
|
868
|
+
* @description This is the specific instance of an application that created the entity. At this time, it only applies to Displays. Only viewable with the RECORD_METADATA license.
|
|
869
|
+
* @example 0235d40e-02d0-44cb-a126-fff21173fc1f
|
|
934
870
|
*/
|
|
935
|
-
|
|
871
|
+
readonly createdBySourceNode?: string;
|
|
936
872
|
/**
|
|
937
|
-
*
|
|
938
|
-
* @
|
|
873
|
+
* Format: uuid
|
|
874
|
+
* @description This is the specific instance of an application that modified the entity. At this time, it only applies to Displays. Only viewable with the RECORD_METADATA license
|
|
875
|
+
* @example 0235d40e-02d0-44cb-a126-fff21173fc1f
|
|
876
|
+
*/
|
|
877
|
+
readonly lastModifiedSourceNode?: string;
|
|
878
|
+
/**
|
|
879
|
+
* @description Derived off of a client key (application that created) via Application Registry lookup. The Application Registry ID for the Ops Center Unknown Application (43796410-2f2c-4321-a259-8dd8af04e973) will be used if no source application exists. Only viewable with the RECORD_METADATA license.
|
|
880
|
+
* @example https://api.deere.com/platform/connectedApplications/63bb4efd-0ec5-47d3-9092-7693909134f5
|
|
881
|
+
*/
|
|
882
|
+
readonly createdBySourceSystemUri?: string;
|
|
883
|
+
/**
|
|
884
|
+
* @description Derived off of a client key (application that did last modification) via Application Registry lookup. The Application Registry ID for the Ops Center Unknown Application (43796410-2f2c-4321-a259-8dd8af04e973) will be used if no source application exists. Only viewable with the RECORD_METADATA license.
|
|
885
|
+
* @example https://api.deere.com/platform/connectedApplications/63bb4efd-0ec5-47d3-9092-7693909134f5
|
|
886
|
+
*/
|
|
887
|
+
readonly lastModifiedBySourceSystemUri?: string;
|
|
888
|
+
};
|
|
889
|
+
SignalTypeRange: {
|
|
890
|
+
/**
|
|
891
|
+
* @description Identifies the class
|
|
892
|
+
* @example Signal Type Range
|
|
893
|
+
*/
|
|
894
|
+
'@type'?: string;
|
|
895
|
+
/**
|
|
896
|
+
* @description starting point index this signal type applies to relative to the boundary
|
|
897
|
+
* @example 0
|
|
898
|
+
*/
|
|
899
|
+
startPointIndex?: number;
|
|
900
|
+
/**
|
|
901
|
+
* @description ending point index this signal type applies to relative to the boundary
|
|
902
|
+
* @example 127
|
|
903
|
+
*/
|
|
904
|
+
endPointIndex?: number;
|
|
905
|
+
/**
|
|
906
|
+
* @description value of signal type used
|
|
907
|
+
* @example "signalType": "SFRTK"
|
|
939
908
|
*/
|
|
940
909
|
signalType?: string;
|
|
941
910
|
};
|
|
942
|
-
|
|
911
|
+
SnapDistanceRange: {
|
|
943
912
|
/**
|
|
944
|
-
* @description
|
|
945
|
-
* @example
|
|
913
|
+
* @description Identifies the class
|
|
914
|
+
* @example Snap Distance Range
|
|
946
915
|
*/
|
|
947
|
-
|
|
916
|
+
'@type'?: string;
|
|
948
917
|
/**
|
|
949
|
-
* @description
|
|
950
|
-
* @example
|
|
918
|
+
* @description starting point index this snap distance applies to relative to the boundary
|
|
919
|
+
* @example 0
|
|
951
920
|
*/
|
|
952
|
-
|
|
921
|
+
startIndex?: number;
|
|
922
|
+
/**
|
|
923
|
+
* @description ending point index this snap distance applies to relative to the boundary
|
|
924
|
+
* @example 127
|
|
925
|
+
*/
|
|
926
|
+
endIndex?: number;
|
|
927
|
+
snapDistance?: components['schemas']['MeasurementAsDouble'];
|
|
928
|
+
};
|
|
929
|
+
ThreeDPoint: {
|
|
930
|
+
/**
|
|
931
|
+
* @description Identifies the class
|
|
932
|
+
* @example 3-dimensional point
|
|
933
|
+
*/
|
|
934
|
+
'@type'?: string;
|
|
935
|
+
/**
|
|
936
|
+
* Format: double
|
|
937
|
+
* @description The latitude of the point
|
|
938
|
+
* @example 32.118552
|
|
939
|
+
*/
|
|
940
|
+
lat?: number;
|
|
941
|
+
/**
|
|
942
|
+
* Format: double
|
|
943
|
+
* @description The longitude of the point
|
|
944
|
+
* @example -81.260776
|
|
945
|
+
*/
|
|
946
|
+
lon?: number;
|
|
947
|
+
/**
|
|
948
|
+
* Format: double
|
|
949
|
+
* @description The z-axis of the point
|
|
950
|
+
* @example 1
|
|
951
|
+
*/
|
|
952
|
+
height?: number;
|
|
953
953
|
};
|
|
954
954
|
};
|
|
955
955
|
responses: {
|
|
956
|
+
/** @description Request Validation failure. The boundary name must be between 1-20 characters. There must be at least one exterior ring. Each ring must have 4 or more points. The first and last point must be the same for each ring. */
|
|
957
|
+
BadRequest: {
|
|
958
|
+
headers: {
|
|
959
|
+
[name: string]: unknown;
|
|
960
|
+
};
|
|
961
|
+
content: {
|
|
962
|
+
'application/vnd.deere.axiom.v3+json': components['schemas']['Errors'];
|
|
963
|
+
};
|
|
964
|
+
};
|
|
956
965
|
/** @description A collection of boundaries */
|
|
957
966
|
BoundariesResponse: {
|
|
958
967
|
headers: {
|
|
@@ -1005,7 +1014,7 @@ export interface components {
|
|
|
1005
1014
|
};
|
|
1006
1015
|
};
|
|
1007
1016
|
/** @description Created, with a Location header containing the URI of the newly created resource */
|
|
1008
|
-
|
|
1017
|
+
Create: {
|
|
1009
1018
|
headers: {
|
|
1010
1019
|
[name: string]: unknown;
|
|
1011
1020
|
};
|
|
@@ -1016,12 +1025,11 @@ export interface components {
|
|
|
1016
1025
|
* @example 1
|
|
1017
1026
|
*/
|
|
1018
1027
|
total?: number;
|
|
1019
|
-
values?: components['schemas']['PostBoundary'][];
|
|
1020
1028
|
};
|
|
1021
1029
|
};
|
|
1022
1030
|
};
|
|
1023
1031
|
/** @description Created, with a Location header containing the URI of the newly created resource */
|
|
1024
|
-
|
|
1032
|
+
Created: {
|
|
1025
1033
|
headers: {
|
|
1026
1034
|
[name: string]: unknown;
|
|
1027
1035
|
};
|
|
@@ -1032,23 +1040,16 @@ export interface components {
|
|
|
1032
1040
|
* @example 1
|
|
1033
1041
|
*/
|
|
1034
1042
|
total?: number;
|
|
1043
|
+
values?: components['schemas']['PostBoundary'][];
|
|
1035
1044
|
};
|
|
1036
1045
|
};
|
|
1037
1046
|
};
|
|
1038
|
-
/** @description
|
|
1039
|
-
|
|
1047
|
+
/** @description The user does not have sufficient privileges to access this organization's boundaries. */
|
|
1048
|
+
Forbidden: {
|
|
1040
1049
|
headers: {
|
|
1041
1050
|
[name: string]: unknown;
|
|
1042
1051
|
};
|
|
1043
|
-
content
|
|
1044
|
-
'application/vnd.deere.axiom.v3+json': {
|
|
1045
|
-
/**
|
|
1046
|
-
* Format: int32
|
|
1047
|
-
* @example 1
|
|
1048
|
-
*/
|
|
1049
|
-
total?: number;
|
|
1050
|
-
};
|
|
1051
|
-
};
|
|
1052
|
+
content?: never;
|
|
1052
1053
|
};
|
|
1053
1054
|
/** @description No Content. Request Completed Succesfully. */
|
|
1054
1055
|
NoContent: {
|
|
@@ -1059,55 +1060,54 @@ export interface components {
|
|
|
1059
1060
|
'No Content': unknown;
|
|
1060
1061
|
};
|
|
1061
1062
|
};
|
|
1062
|
-
/** @description
|
|
1063
|
-
|
|
1064
|
-
headers: {
|
|
1065
|
-
[name: string]: unknown;
|
|
1066
|
-
};
|
|
1067
|
-
content: {
|
|
1068
|
-
'application/vnd.deere.axiom.v3+json': components['schemas']['Errors'];
|
|
1069
|
-
};
|
|
1070
|
-
};
|
|
1071
|
-
/** @description The user does not have sufficient privileges to access this organization's boundaries. */
|
|
1072
|
-
Forbidden: {
|
|
1063
|
+
/** @description The specified resource does not exist */
|
|
1064
|
+
NotFound: {
|
|
1073
1065
|
headers: {
|
|
1074
1066
|
[name: string]: unknown;
|
|
1075
1067
|
};
|
|
1076
1068
|
content?: never;
|
|
1077
1069
|
};
|
|
1078
|
-
/** @description
|
|
1079
|
-
|
|
1070
|
+
/** @description Updated, with a Location header containing the URI of the newly created resource */
|
|
1071
|
+
Update: {
|
|
1080
1072
|
headers: {
|
|
1081
1073
|
[name: string]: unknown;
|
|
1082
1074
|
};
|
|
1083
|
-
content
|
|
1075
|
+
content: {
|
|
1076
|
+
'application/vnd.deere.axiom.v3+json': {
|
|
1077
|
+
/**
|
|
1078
|
+
* Format: int32
|
|
1079
|
+
* @example 1
|
|
1080
|
+
*/
|
|
1081
|
+
total?: number;
|
|
1082
|
+
};
|
|
1083
|
+
};
|
|
1084
1084
|
};
|
|
1085
1085
|
};
|
|
1086
1086
|
parameters: {
|
|
1087
|
-
/** @description Organization */
|
|
1088
|
-
OrgId: string;
|
|
1089
|
-
/** @description Organization */
|
|
1090
|
-
OrgId3: string;
|
|
1091
1087
|
/** @description Takes METRIC and ENGLISH. Converts measurements to the chosen system. */
|
|
1092
1088
|
'Accept-UOM-System': string;
|
|
1093
|
-
/** @description
|
|
1094
|
-
|
|
1089
|
+
/** @description Takes METRIC and ENGLISH. Converts measurements to the chosen system. */
|
|
1090
|
+
AcceptUOMSystem: 'ENGLISH' | 'METRIC';
|
|
1091
|
+
/** @description Allows filtering based on active boundaries */
|
|
1092
|
+
Active: boolean;
|
|
1093
|
+
/** @description Boundary Id */
|
|
1094
|
+
BoundaryId: string;
|
|
1095
1095
|
/** @description Populates response with data lineage information */
|
|
1096
1096
|
Embed: string;
|
|
1097
|
-
/** @description Filter results based on status; defaults to active */
|
|
1098
|
-
RecordFilter: string;
|
|
1099
|
-
/** @description Field ID */
|
|
1100
|
-
Id: string;
|
|
1101
1097
|
/** @description Field GUID */
|
|
1102
1098
|
FieldId: string;
|
|
1103
1099
|
/** @description Field Id */
|
|
1104
1100
|
FieldId2: string;
|
|
1105
|
-
/** @description
|
|
1106
|
-
|
|
1107
|
-
/** @description
|
|
1108
|
-
|
|
1109
|
-
/** @description
|
|
1110
|
-
|
|
1101
|
+
/** @description Field ID */
|
|
1102
|
+
Id: string;
|
|
1103
|
+
/** @description Organization */
|
|
1104
|
+
OrgId: string;
|
|
1105
|
+
/** @description Organization ID */
|
|
1106
|
+
OrgId2: string;
|
|
1107
|
+
/** @description Organization */
|
|
1108
|
+
OrgId3: string;
|
|
1109
|
+
/** @description Filter results based on status; defaults to active */
|
|
1110
|
+
RecordFilter: string;
|
|
1111
1111
|
};
|
|
1112
1112
|
requestBodies: {
|
|
1113
1113
|
/** @description Specifies Boundary details */
|