deere-sdk 2.3.1 → 3.0.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 +131 -0
- package/README.md +0 -3
- 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/organizations.d.ts +0 -7
- package/dist/api/organizations.d.ts.map +1 -1
- package/dist/api/organizations.js +0 -10
- package/dist/api/organizations.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 +21 -1
- package/dist/api-servers.generated.d.ts.map +1 -1
- package/dist/api-servers.generated.js +34 -1
- package/dist/api-servers.generated.js.map +1 -1
- package/dist/client.d.ts.map +1 -1
- package/dist/client.js +4 -15
- package/dist/client.js.map +1 -1
- package/dist/environment-resolver.d.ts.map +1 -1
- package/dist/environment-resolver.js +26 -2
- package/dist/environment-resolver.js.map +1 -1
- package/dist/hateoas-map.d.ts.map +1 -1
- package/dist/hateoas-map.js +65 -5
- package/dist/hateoas-map.js.map +1 -1
- package/dist/path-pattern.d.ts +30 -0
- package/dist/path-pattern.d.ts.map +1 -0
- package/dist/path-pattern.js +45 -0
- package/dist/path-pattern.js.map +1 -0
- 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 -114
- 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 +6 -1
|
@@ -77,26 +77,6 @@ export interface paths {
|
|
|
77
77
|
patch?: never;
|
|
78
78
|
trace?: never;
|
|
79
79
|
};
|
|
80
|
-
'/organizations/{organizationId}/equipment': {
|
|
81
|
-
parameters: {
|
|
82
|
-
query?: never;
|
|
83
|
-
header?: never;
|
|
84
|
-
path?: never;
|
|
85
|
-
cookie?: never;
|
|
86
|
-
};
|
|
87
|
-
get?: never;
|
|
88
|
-
put?: never;
|
|
89
|
-
/**
|
|
90
|
-
* Create equipment
|
|
91
|
-
* @description This resource allows the client to create a piece of equipment within a user’s organization. Getting Started The process of contributing equipment to John Deere can be broken down into three primary steps. Determine the Equipment’s model IDs Create the Equipment Contribute Measurements. Please see the for more information on uploading measurements for the created equipment. Determining the Equipment’s model Call the GET /equipmentMakes API endpoint to get a list of all equipment makes and a respective “id” of the equipment make you require. Call the GET /equipmentMakes/{id}/equipmentISGTypes endpoint to get a list of associated equipment ISG types for that specific equipment make and obtain a respective “id” for a specific ISG type you require. Call the GET /equipmentMakes/{id}/equipmentISGTypes/{id}/equipmentModels to obtain the final “id” of the equipment model you require. Alternatively, you may call the GET /equipmentModels endpoint if you know the model name you are searching for. For example /equipmentModels?equipmentModelName=9RX*&embed=make,isgType which will include all models with search string results and include make and isgType “id” as well as model “id”. Creating the Equipment Make a POST request to the /organizations/{orgId}/equipment API to create the piece of equipment in the user’s org. In this request you will provide the type of the equipment, a serialNumber (optional), name (displayed to the user in Operations Center), and the equipment model IDs. type: Machine or Implement serialNumber: A string identifier that is 30 characters or fewer. Must be unique within an organization. name: The name displayed in Operation Center, 30 characters or fewer. Must be unique within an organization. model: The id for the Model of the vehicle, found from the API in the previous step of this document. A successful POST will result in a 201 Created response. The “location” header in the response will contain the URI to the new equipment, with the final segment being the organization specific machine ID (ie “https://equipmentapi.deere.com/isg/equipment/12345” is a link to the machine 12345). If you attempt to create a machine with a serialNumber that already exists in that organization, you get a response code 400 Bad Request. The body will include the error information.
|
|
92
|
-
*/
|
|
93
|
-
post: operations['createEquipment'];
|
|
94
|
-
delete?: never;
|
|
95
|
-
options?: never;
|
|
96
|
-
head?: never;
|
|
97
|
-
patch?: never;
|
|
98
|
-
trace?: never;
|
|
99
|
-
};
|
|
100
80
|
'/equipment/{id}': {
|
|
101
81
|
parameters: {
|
|
102
82
|
query?: never;
|
|
@@ -157,6 +137,26 @@ export interface paths {
|
|
|
157
137
|
patch?: never;
|
|
158
138
|
trace?: never;
|
|
159
139
|
};
|
|
140
|
+
'/equipmentISGTypes': {
|
|
141
|
+
parameters: {
|
|
142
|
+
query?: never;
|
|
143
|
+
header?: never;
|
|
144
|
+
path?: never;
|
|
145
|
+
cookie?: never;
|
|
146
|
+
};
|
|
147
|
+
/**
|
|
148
|
+
* Get equipment ISG types
|
|
149
|
+
* @description This operation retrieves a list of Equipment ISG Types based on the supplied query parameters.
|
|
150
|
+
*/
|
|
151
|
+
get: operations['getEquipmentISGTypes'];
|
|
152
|
+
put?: never;
|
|
153
|
+
post?: never;
|
|
154
|
+
delete?: never;
|
|
155
|
+
options?: never;
|
|
156
|
+
head?: never;
|
|
157
|
+
patch?: never;
|
|
158
|
+
trace?: never;
|
|
159
|
+
};
|
|
160
160
|
'/equipmentMakes': {
|
|
161
161
|
parameters: {
|
|
162
162
|
query?: never;
|
|
@@ -197,7 +197,7 @@ export interface paths {
|
|
|
197
197
|
patch?: never;
|
|
198
198
|
trace?: never;
|
|
199
199
|
};
|
|
200
|
-
'/equipmentMakes/{equipmentMakeId}/
|
|
200
|
+
'/equipmentMakes/{equipmentMakeId}/equipmentISGTypes': {
|
|
201
201
|
parameters: {
|
|
202
202
|
query?: never;
|
|
203
203
|
header?: never;
|
|
@@ -205,11 +205,10 @@ export interface paths {
|
|
|
205
205
|
cookie?: never;
|
|
206
206
|
};
|
|
207
207
|
/**
|
|
208
|
-
* Get equipment types by make id
|
|
209
|
-
* @
|
|
210
|
-
* @description This resource allows the client to view equipment types by providing an equipment make ID.
|
|
208
|
+
* Get equipment ISG types by make id
|
|
209
|
+
* @description This operation retrieves a list of Equipment ISG Types for given makeId.
|
|
211
210
|
*/
|
|
212
|
-
get: operations['
|
|
211
|
+
get: operations['getEquipmentISGTypesByMakeId'];
|
|
213
212
|
put?: never;
|
|
214
213
|
post?: never;
|
|
215
214
|
delete?: never;
|
|
@@ -218,7 +217,7 @@ export interface paths {
|
|
|
218
217
|
patch?: never;
|
|
219
218
|
trace?: never;
|
|
220
219
|
};
|
|
221
|
-
'/
|
|
220
|
+
'/equipmentMakes/{equipmentMakeId}/equipmentISGTypes/{equipmentISGTypeId}': {
|
|
222
221
|
parameters: {
|
|
223
222
|
query?: never;
|
|
224
223
|
header?: never;
|
|
@@ -226,11 +225,10 @@ export interface paths {
|
|
|
226
225
|
cookie?: never;
|
|
227
226
|
};
|
|
228
227
|
/**
|
|
229
|
-
* Get equipment
|
|
230
|
-
* @
|
|
231
|
-
* @description This resource allows the client to view equipment types and their associated IDs and names.
|
|
228
|
+
* Get equipment ISG type by make id and ISG type id
|
|
229
|
+
* @description This operation retrieves a single Equipment ISG Type for given makeId and isgTypeId..
|
|
232
230
|
*/
|
|
233
|
-
get: operations['
|
|
231
|
+
get: operations['getEquipmentISGTypeByMakeIdAndISGTypeId'];
|
|
234
232
|
put?: never;
|
|
235
233
|
post?: never;
|
|
236
234
|
delete?: never;
|
|
@@ -239,7 +237,7 @@ export interface paths {
|
|
|
239
237
|
patch?: never;
|
|
240
238
|
trace?: never;
|
|
241
239
|
};
|
|
242
|
-
'/equipmentModels': {
|
|
240
|
+
'/equipmentMakes/{equipmentMakeId}/equipmentISGTypes/{equipmentISGTypeId}/equipmentModels': {
|
|
243
241
|
parameters: {
|
|
244
242
|
query?: never;
|
|
245
243
|
header?: never;
|
|
@@ -247,10 +245,10 @@ export interface paths {
|
|
|
247
245
|
cookie?: never;
|
|
248
246
|
};
|
|
249
247
|
/**
|
|
250
|
-
* Get equipment models
|
|
251
|
-
* @description This
|
|
248
|
+
* Get equipment models by make id and ISG type id
|
|
249
|
+
* @description This operation retrieves a list of Equipment Models based on given makeId and ISGtypeId.
|
|
252
250
|
*/
|
|
253
|
-
get: operations['
|
|
251
|
+
get: operations['getEquipmentModelsByMakeIdAndISGTypeId'];
|
|
254
252
|
put?: never;
|
|
255
253
|
post?: never;
|
|
256
254
|
delete?: never;
|
|
@@ -259,7 +257,7 @@ export interface paths {
|
|
|
259
257
|
patch?: never;
|
|
260
258
|
trace?: never;
|
|
261
259
|
};
|
|
262
|
-
'/equipmentISGTypes': {
|
|
260
|
+
'/equipmentMakes/{equipmentMakeId}/equipmentISGTypes/{equipmentISGTypeId}/equipmentModels/{equipmentModelId}': {
|
|
263
261
|
parameters: {
|
|
264
262
|
query?: never;
|
|
265
263
|
header?: never;
|
|
@@ -267,10 +265,10 @@ export interface paths {
|
|
|
267
265
|
cookie?: never;
|
|
268
266
|
};
|
|
269
267
|
/**
|
|
270
|
-
* Get equipment ISG
|
|
271
|
-
* @description This operation retrieves a
|
|
268
|
+
* Get equipment model by make id, ISG type id and model id
|
|
269
|
+
* @description This operation retrieves a single Equipment Model based on given makeId, isgTypeId and modelId.
|
|
272
270
|
*/
|
|
273
|
-
get: operations['
|
|
271
|
+
get: operations['getEquipmentModelsByMakeIdAndISGTypeIdAndModelId'];
|
|
274
272
|
put?: never;
|
|
275
273
|
post?: never;
|
|
276
274
|
delete?: never;
|
|
@@ -279,7 +277,7 @@ export interface paths {
|
|
|
279
277
|
patch?: never;
|
|
280
278
|
trace?: never;
|
|
281
279
|
};
|
|
282
|
-
'/equipmentMakes/{equipmentMakeId}/
|
|
280
|
+
'/equipmentMakes/{equipmentMakeId}/equipmentTypes': {
|
|
283
281
|
parameters: {
|
|
284
282
|
query?: never;
|
|
285
283
|
header?: never;
|
|
@@ -287,10 +285,11 @@ export interface paths {
|
|
|
287
285
|
cookie?: never;
|
|
288
286
|
};
|
|
289
287
|
/**
|
|
290
|
-
* Get equipment
|
|
291
|
-
* @
|
|
288
|
+
* Get equipment types by make id
|
|
289
|
+
* @deprecated
|
|
290
|
+
* @description This resource allows the client to view equipment types by providing an equipment make ID.
|
|
292
291
|
*/
|
|
293
|
-
get: operations['
|
|
292
|
+
get: operations['getEquipmentTypesByMakeId'];
|
|
294
293
|
put?: never;
|
|
295
294
|
post?: never;
|
|
296
295
|
delete?: never;
|
|
@@ -299,7 +298,7 @@ export interface paths {
|
|
|
299
298
|
patch?: never;
|
|
300
299
|
trace?: never;
|
|
301
300
|
};
|
|
302
|
-
'/
|
|
301
|
+
'/equipmentModels': {
|
|
303
302
|
parameters: {
|
|
304
303
|
query?: never;
|
|
305
304
|
header?: never;
|
|
@@ -307,10 +306,10 @@ export interface paths {
|
|
|
307
306
|
cookie?: never;
|
|
308
307
|
};
|
|
309
308
|
/**
|
|
310
|
-
* Get equipment
|
|
311
|
-
* @description This
|
|
309
|
+
* Get equipment models
|
|
310
|
+
* @description This resource allows the client to view equipment models in our reference database and their associated IDs and names.
|
|
312
311
|
*/
|
|
313
|
-
get: operations['
|
|
312
|
+
get: operations['getEquipmentModels'];
|
|
314
313
|
put?: never;
|
|
315
314
|
post?: never;
|
|
316
315
|
delete?: never;
|
|
@@ -319,7 +318,7 @@ export interface paths {
|
|
|
319
318
|
patch?: never;
|
|
320
319
|
trace?: never;
|
|
321
320
|
};
|
|
322
|
-
'/
|
|
321
|
+
'/equipmentTypes': {
|
|
323
322
|
parameters: {
|
|
324
323
|
query?: never;
|
|
325
324
|
header?: never;
|
|
@@ -327,10 +326,11 @@ export interface paths {
|
|
|
327
326
|
cookie?: never;
|
|
328
327
|
};
|
|
329
328
|
/**
|
|
330
|
-
* Get equipment
|
|
331
|
-
* @
|
|
329
|
+
* Get equipment types
|
|
330
|
+
* @deprecated
|
|
331
|
+
* @description This resource allows the client to view equipment types and their associated IDs and names.
|
|
332
332
|
*/
|
|
333
|
-
get: operations['
|
|
333
|
+
get: operations['getEquipmentTypes'];
|
|
334
334
|
put?: never;
|
|
335
335
|
post?: never;
|
|
336
336
|
delete?: never;
|
|
@@ -339,20 +339,20 @@ export interface paths {
|
|
|
339
339
|
patch?: never;
|
|
340
340
|
trace?: never;
|
|
341
341
|
};
|
|
342
|
-
'/
|
|
342
|
+
'/organizations/{organizationId}/equipment': {
|
|
343
343
|
parameters: {
|
|
344
344
|
query?: never;
|
|
345
345
|
header?: never;
|
|
346
346
|
path?: never;
|
|
347
347
|
cookie?: never;
|
|
348
348
|
};
|
|
349
|
+
get?: never;
|
|
350
|
+
put?: never;
|
|
349
351
|
/**
|
|
350
|
-
*
|
|
351
|
-
* @description This
|
|
352
|
+
* Create equipment
|
|
353
|
+
* @description This resource allows the client to create a piece of equipment within a user’s organization. Getting Started The process of contributing equipment to John Deere can be broken down into three primary steps. Determine the Equipment’s model IDs Create the Equipment Contribute Measurements. Please see the for more information on uploading measurements for the created equipment. Determining the Equipment’s model Call the GET /equipmentMakes API endpoint to get a list of all equipment makes and a respective “id” of the equipment make you require. Call the GET /equipmentMakes/{id}/equipmentISGTypes endpoint to get a list of associated equipment ISG types for that specific equipment make and obtain a respective “id” for a specific ISG type you require. Call the GET /equipmentMakes/{id}/equipmentISGTypes/{id}/equipmentModels to obtain the final “id” of the equipment model you require. Alternatively, you may call the GET /equipmentModels endpoint if you know the model name you are searching for. For example /equipmentModels?equipmentModelName=9RX*&embed=make,isgType which will include all models with search string results and include make and isgType “id” as well as model “id”. Creating the Equipment Make a POST request to the /organizations/{orgId}/equipment API to create the piece of equipment in the user’s org. In this request you will provide the type of the equipment, a serialNumber (optional), name (displayed to the user in Operations Center), and the equipment model IDs. type: Machine or Implement serialNumber: A string identifier that is 30 characters or fewer. Must be unique within an organization. name: The name displayed in Operation Center, 30 characters or fewer. Must be unique within an organization. model: The id for the Model of the vehicle, found from the API in the previous step of this document. A successful POST will result in a 201 Created response. The “location” header in the response will contain the URI to the new equipment, with the final segment being the organization specific machine ID (ie “https://equipmentapi.deere.com/isg/equipment/12345” is a link to the machine 12345). If you attempt to create a machine with a serialNumber that already exists in that organization, you get a response code 400 Bad Request. The body will include the error information.
|
|
352
354
|
*/
|
|
353
|
-
|
|
354
|
-
put?: never;
|
|
355
|
-
post?: never;
|
|
355
|
+
post: operations['createEquipment'];
|
|
356
356
|
delete?: never;
|
|
357
357
|
options?: never;
|
|
358
358
|
head?: never;
|
|
@@ -392,68 +392,6 @@ export interface components {
|
|
|
392
392
|
invalidValue?: string;
|
|
393
393
|
};
|
|
394
394
|
Errors: components['schemas']['Error'][];
|
|
395
|
-
/** Link */
|
|
396
|
-
link: {
|
|
397
|
-
/** @example nextPage */
|
|
398
|
-
rel?: string;
|
|
399
|
-
/**
|
|
400
|
-
* @description This will be the relative URL. Users will prefix the base url as per their requirements.
|
|
401
|
-
* @example /equipment?pageOffset=10&itemSize=10
|
|
402
|
-
*/
|
|
403
|
-
uri?: string;
|
|
404
|
-
};
|
|
405
|
-
/**
|
|
406
|
-
* EquipmentIsgType
|
|
407
|
-
* @description Represents the ISG type of equipment, including its name, unique identifier, category, deprecation status, and metadata.
|
|
408
|
-
* @example {
|
|
409
|
-
* "name": "Tractor",
|
|
410
|
-
* "ERID": "82115264-9385-460c-bfbe-177a59445fd9",
|
|
411
|
-
* "category": "Machine",
|
|
412
|
-
* "allowsCustomModel": true,
|
|
413
|
-
* "isgMarketSegment": "Agriculture",
|
|
414
|
-
* "deprecated": false,
|
|
415
|
-
* "recordMetaData": {
|
|
416
|
-
* "createdBy": "user123",
|
|
417
|
-
* "createdAt": "2023-10-01T12:00:00Z",
|
|
418
|
-
* "updatedBy": "user456",
|
|
419
|
-
* "updatedAt": "2023-10-02T12:00:00Z"
|
|
420
|
-
* }
|
|
421
|
-
* }
|
|
422
|
-
*/
|
|
423
|
-
'equipment-isg-type': components['schemas']['resource'] & {
|
|
424
|
-
/**
|
|
425
|
-
* @description The name of the ISG equipment type.
|
|
426
|
-
* @example Tractor
|
|
427
|
-
*/
|
|
428
|
-
name?: string;
|
|
429
|
-
/**
|
|
430
|
-
* @description Unique identifier for the ISG equipment type.
|
|
431
|
-
* @example 82115264-9385-460c-bfbe-177a59445fd9
|
|
432
|
-
*/
|
|
433
|
-
ERID?: string;
|
|
434
|
-
/**
|
|
435
|
-
* @description The category of the ISG equipment type.
|
|
436
|
-
* @example Machine
|
|
437
|
-
* @enum {string}
|
|
438
|
-
*/
|
|
439
|
-
category?: 'Machine' | 'Implement' | 'Unknown';
|
|
440
|
-
/**
|
|
441
|
-
* @description Indicates if the equipment ISG type allows custom models.
|
|
442
|
-
* @example true
|
|
443
|
-
*/
|
|
444
|
-
allowsCustomModel?: boolean;
|
|
445
|
-
/**
|
|
446
|
-
* @description The ISG market segment of the equipment ISG type.
|
|
447
|
-
* @example Agriculture
|
|
448
|
-
* @enum {string}
|
|
449
|
-
*/
|
|
450
|
-
isgMarketSegment?: 'Unknown' | 'Agriculture' | 'Construction' | 'Engines & Components' | 'Forestry' | 'Turf';
|
|
451
|
-
/**
|
|
452
|
-
* @description Indicates if the ISG equipment type is deprecated.
|
|
453
|
-
* @example false
|
|
454
|
-
*/
|
|
455
|
-
deprecated?: boolean;
|
|
456
|
-
};
|
|
457
395
|
/** @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.) */
|
|
458
396
|
RecordMetadata: {
|
|
459
397
|
/**
|
|
@@ -504,287 +442,702 @@ export interface components {
|
|
|
504
442
|
*/
|
|
505
443
|
readonly lastModifiedBySourceSystemUri?: string;
|
|
506
444
|
};
|
|
507
|
-
/**
|
|
508
|
-
|
|
445
|
+
/** AbstractMeasurement */
|
|
446
|
+
abstractMeasurement: {
|
|
447
|
+
type?: string;
|
|
448
|
+
unit?: string;
|
|
449
|
+
};
|
|
450
|
+
/**
|
|
451
|
+
* Capability
|
|
452
|
+
* @description List of capabilities of the equipment.
|
|
453
|
+
*/
|
|
454
|
+
capability: components['schemas']['resource-embed'] & {
|
|
509
455
|
/**
|
|
510
|
-
* @description
|
|
511
|
-
* @example
|
|
456
|
+
* @description Capability
|
|
457
|
+
* @example Capability
|
|
458
|
+
* @enum {string}
|
|
512
459
|
*/
|
|
513
|
-
|
|
460
|
+
'@type'?: 'Capability';
|
|
461
|
+
capable?: boolean;
|
|
462
|
+
/** @enum {string} */
|
|
463
|
+
type?: 'JDLINK_CONNECTIVITY' | 'RDA' | 'WDT' | 'WIFI_CONNECTIVITY' | 'CUSTOMER_SIM_CONNECTIVITY' | 'LEGACY_CONNECTIVITY' | 'PLANNED_WORK' | 'DATA_SYNC_SETUP' | 'CH_REMOTE_ADJUST' | 'BASE_STATION' | 'MY_MACHINE' | 'RDC' | 'REMOTE_START';
|
|
464
|
+
inabilityDetails?: components['schemas']['inability-detail'][];
|
|
465
|
+
};
|
|
466
|
+
/**
|
|
467
|
+
* CommunicationModule
|
|
468
|
+
* @description Represents a communication module, including its serial number, IMEI, IMSI, ICCID, MSISDN, EID, type, service provider, state, and country calling code.
|
|
469
|
+
* @example {
|
|
470
|
+
* "serialNumber": "PCS171B372381",
|
|
471
|
+
* "imei": 123456789012345,
|
|
472
|
+
* "imsi": 310150123456789,
|
|
473
|
+
* "iccid": 89014103211118510000,
|
|
474
|
+
* "msisdn": 15555551234,
|
|
475
|
+
* "eid": 89014103211118510000,
|
|
476
|
+
* "type": "GSM",
|
|
477
|
+
* "serviceProvider": "ATT",
|
|
478
|
+
* "state": "ACTIVE",
|
|
479
|
+
* "countryCallingCode": 1
|
|
480
|
+
* }
|
|
481
|
+
*/
|
|
482
|
+
'communication-module': components['schemas']['resource-embed'] & {
|
|
514
483
|
/**
|
|
515
|
-
* @description
|
|
516
|
-
* @example
|
|
484
|
+
* @description CommunicationModule
|
|
485
|
+
* @example CommunicationModule
|
|
486
|
+
* @enum {string}
|
|
517
487
|
*/
|
|
518
|
-
'@type'?:
|
|
519
|
-
};
|
|
520
|
-
/** Resource */
|
|
521
|
-
resource: {
|
|
522
|
-
links?: components['schemas']['link'][];
|
|
488
|
+
'@type'?: 'CommunicationModule';
|
|
523
489
|
/**
|
|
524
|
-
* @description
|
|
525
|
-
* @example
|
|
490
|
+
* @description Serial number of the communication gateway
|
|
491
|
+
* @example PCS171B372381
|
|
526
492
|
*/
|
|
527
|
-
|
|
493
|
+
serialNumber?: string;
|
|
528
494
|
/**
|
|
529
|
-
* @description
|
|
530
|
-
* @example
|
|
495
|
+
* @description International Mobile Equipment Identity of the communication module.
|
|
496
|
+
* @example 123456789012345
|
|
531
497
|
*/
|
|
532
|
-
|
|
533
|
-
};
|
|
534
|
-
/** Resource */
|
|
535
|
-
'resource-embed': {
|
|
498
|
+
imei?: string;
|
|
536
499
|
/**
|
|
537
|
-
* @description
|
|
538
|
-
* @example
|
|
500
|
+
* @description International Mobile Subscriber Identity of the communication module.
|
|
501
|
+
* @example 310150123456789
|
|
539
502
|
*/
|
|
540
|
-
|
|
503
|
+
imsi?: string;
|
|
541
504
|
/**
|
|
542
|
-
* @description
|
|
543
|
-
* @example
|
|
505
|
+
* @description Integrated Circuit Card Identifier of the communication module.
|
|
506
|
+
* @example 89014103211118510000
|
|
544
507
|
*/
|
|
545
|
-
|
|
546
|
-
};
|
|
547
|
-
/** Resource */
|
|
548
|
-
'organization-embed': {
|
|
508
|
+
iccid?: string;
|
|
549
509
|
/**
|
|
550
|
-
* @description
|
|
551
|
-
* @example
|
|
510
|
+
* @description Mobile Station International Subscriber Directory Number of the communication module.
|
|
511
|
+
* @example 15555551234
|
|
552
512
|
*/
|
|
553
|
-
|
|
513
|
+
msisdn?: string;
|
|
554
514
|
/**
|
|
555
|
-
* @description
|
|
556
|
-
* @example
|
|
515
|
+
* @description Embedded Identity Document of the communication module.
|
|
516
|
+
* @example 89014103211118510000
|
|
557
517
|
*/
|
|
558
|
-
|
|
559
|
-
};
|
|
560
|
-
/**
|
|
561
|
-
* EquipmentMake
|
|
562
|
-
* @description Represents the make of the equipment, including its name, unique identifier, and metadata.
|
|
563
|
-
*/
|
|
564
|
-
'equipment-make-embed': {
|
|
518
|
+
eid?: string;
|
|
565
519
|
/**
|
|
566
|
-
* @description
|
|
567
|
-
* @example
|
|
520
|
+
* @description Type of the communication module.
|
|
521
|
+
* @example GSM
|
|
522
|
+
* @enum {string}
|
|
568
523
|
*/
|
|
569
|
-
|
|
524
|
+
type?: 'GSM' | 'SATELLITE' | 'CDMA' | 'COS';
|
|
570
525
|
/**
|
|
571
|
-
* @
|
|
572
|
-
* @
|
|
526
|
+
* @example ATT
|
|
527
|
+
* @enum {string}
|
|
573
528
|
*/
|
|
574
|
-
|
|
529
|
+
serviceProvider?: 'IRIDIUM' | 'ATT' | 'JASPER' | 'VERIZON' | 'COS' | 'COST' | 'CUBIC' | 'ATTIOT';
|
|
575
530
|
/**
|
|
576
|
-
* @description
|
|
577
|
-
* @example
|
|
531
|
+
* @description Subscription state of the communication gateway
|
|
532
|
+
* @example ACTIVE
|
|
533
|
+
* @enum {string}
|
|
578
534
|
*/
|
|
579
|
-
|
|
535
|
+
state?: 'NEW' | 'ACTIVE' | 'INACTIVE' | 'EXPIRED' | 'PENDING_ACTIVE' | 'PENDING_INACTIVE' | 'PENDING_EXPIRED' | 'PENDING_VERIFICATION' | 'PENDING_WDT' | 'TERMINATED';
|
|
580
536
|
/**
|
|
581
|
-
* @description
|
|
582
|
-
* @example
|
|
537
|
+
* @description Country calling code of the communication module.
|
|
538
|
+
* @example 1
|
|
583
539
|
*/
|
|
584
|
-
|
|
540
|
+
countryCallingCode?: string;
|
|
541
|
+
};
|
|
542
|
+
/** Equipment Creation */
|
|
543
|
+
createEquipment: {
|
|
585
544
|
/**
|
|
586
|
-
* @description
|
|
587
|
-
* @example
|
|
545
|
+
* @description Equipment Name.
|
|
546
|
+
* @example Cates 8360R 055358
|
|
588
547
|
*/
|
|
589
|
-
|
|
548
|
+
name?: string;
|
|
590
549
|
/**
|
|
591
|
-
* @description
|
|
592
|
-
* @example
|
|
550
|
+
* @description Serial Number of the Equipment and passed on the query parameter
|
|
551
|
+
* @example Must be unique string. Max character count is 30.
|
|
593
552
|
*/
|
|
594
|
-
|
|
553
|
+
serialNumber?: string;
|
|
554
|
+
/**
|
|
555
|
+
* Model of the equipment.
|
|
556
|
+
* @description Model of the equipment.
|
|
557
|
+
*/
|
|
558
|
+
model?: {
|
|
559
|
+
/**
|
|
560
|
+
* @description Unique id
|
|
561
|
+
* @example 3 | 158df9ff-334a-4e0d-86cc-3adca17a9686
|
|
562
|
+
*/
|
|
563
|
+
id?: string;
|
|
564
|
+
/**
|
|
565
|
+
* @description EquipmentModel
|
|
566
|
+
* @example EquipmentModel
|
|
567
|
+
*/
|
|
568
|
+
'@type'?: string;
|
|
569
|
+
};
|
|
570
|
+
};
|
|
571
|
+
/** DefinedTypeRepresentationValue */
|
|
572
|
+
definedTypeRepresentationValue: {
|
|
573
|
+
value?: components['schemas']['measurementAsString'];
|
|
595
574
|
};
|
|
596
575
|
/**
|
|
597
|
-
*
|
|
598
|
-
* @description Represents
|
|
576
|
+
* Device
|
|
577
|
+
* @description Represents a device, including its serial number, certification status, make, type, model, organization, and other attributes.
|
|
599
578
|
* @example {
|
|
600
|
-
* "
|
|
601
|
-
* "
|
|
602
|
-
* "
|
|
603
|
-
*
|
|
604
|
-
*
|
|
605
|
-
*
|
|
606
|
-
*
|
|
607
|
-
*
|
|
608
|
-
* "
|
|
609
|
-
* "
|
|
610
|
-
* "
|
|
611
|
-
*
|
|
579
|
+
* "@type": "Device",
|
|
580
|
+
* "serialNumber": "PCMA4GF511111",
|
|
581
|
+
* "make": {
|
|
582
|
+
* "name": "JOHN DEERE",
|
|
583
|
+
* "id": "1",
|
|
584
|
+
* "ERID": "f8b43e74-3088-4a38-9d66-30aae1ed1111"
|
|
585
|
+
* },
|
|
586
|
+
* "type": {
|
|
587
|
+
* "name": "Modem",
|
|
588
|
+
* "commonName": "TelematicsGateway",
|
|
589
|
+
* "id": "1",
|
|
590
|
+
* "ERID": "d469a324-2036-11ee-bb58-0e5cd6a91111"
|
|
591
|
+
* },
|
|
592
|
+
* "model": {
|
|
593
|
+
* "name": "JDLink Modem-4G",
|
|
594
|
+
* "id": "3",
|
|
595
|
+
* "ERID": "f413bba6-9f39-410c-866f-c800bf701111"
|
|
596
|
+
* },
|
|
597
|
+
* "firmwareVersion": {
|
|
598
|
+
* "name": "40.02.049"
|
|
599
|
+
* },
|
|
600
|
+
* "organization": {
|
|
601
|
+
* "id": "21111"
|
|
602
|
+
* },
|
|
603
|
+
* "organizationRole": {
|
|
604
|
+
* "type": "Controlling",
|
|
605
|
+
* "effectiveTS": "2024-04-30T17:53:57Z",
|
|
606
|
+
* "event": "PAIRING"
|
|
607
|
+
* },
|
|
608
|
+
* "archived": false,
|
|
609
|
+
* "decommissioned": false,
|
|
610
|
+
* "stolen": false,
|
|
611
|
+
* "principalId": "911111",
|
|
612
|
+
* "equipment": {
|
|
613
|
+
* "name": "Cattle 9700 SPFH",
|
|
614
|
+
* "serialNumber": "1Z09700YAKU621111",
|
|
615
|
+
* "isSerialNumberCertified": true,
|
|
616
|
+
* "modelYear": "2019",
|
|
617
|
+
* "make": {
|
|
618
|
+
* "name": "JOHN DEERE",
|
|
619
|
+
* "certified": true,
|
|
620
|
+
* "deereOrSubsidiary": true,
|
|
621
|
+
* "id": "1",
|
|
622
|
+
* "ERID": "db18bdc4-025a-11eb-97e4-0e8d658c1111"
|
|
623
|
+
* },
|
|
624
|
+
* "type": {
|
|
625
|
+
* "name": "Forage Harvester",
|
|
626
|
+
* "id": "162",
|
|
627
|
+
* "ERID": "34b07db5-11fb-11ee-8580-0ed5f7261111"
|
|
628
|
+
* },
|
|
629
|
+
* "isgType": {
|
|
630
|
+
* "name": "Forage Harvester",
|
|
631
|
+
* "id": "6",
|
|
632
|
+
* "ERID": "99edf0e0-4abb-42d3-9798-327439a31111"
|
|
633
|
+
* },
|
|
634
|
+
* "model": {
|
|
635
|
+
* "name": 9700,
|
|
636
|
+
* "certified": true,
|
|
637
|
+
* "id": "581111",
|
|
638
|
+
* "ERID": "2c8c951e-070a-4e1c-824d-72cca6e71111"
|
|
639
|
+
* },
|
|
640
|
+
* "principalId": "661111",
|
|
641
|
+
* "archived": false,
|
|
642
|
+
* "organization": {
|
|
643
|
+
* "id": "22967"
|
|
644
|
+
* },
|
|
645
|
+
* "organizationRole": {
|
|
646
|
+
* "type": "Controlling",
|
|
647
|
+
* "effectiveTS": "2024-04-30T17:53:56.695Z",
|
|
648
|
+
* "event": "PAIRING"
|
|
649
|
+
* },
|
|
650
|
+
* "isCsc": false,
|
|
651
|
+
* "id": "661111",
|
|
652
|
+
* "ERID": "23fe3ea0-1f95-4ae6-8e12-968729cd1111"
|
|
653
|
+
* },
|
|
654
|
+
* "capabilities": [
|
|
655
|
+
* {
|
|
656
|
+
* "type": "JDLINK_CONNECTIVITY",
|
|
657
|
+
* "capable": true
|
|
658
|
+
* },
|
|
659
|
+
* {
|
|
660
|
+
* "type": "WIFI_CONNECTIVITY",
|
|
661
|
+
* "capable": true
|
|
662
|
+
* }
|
|
663
|
+
* ],
|
|
664
|
+
* "pairingDetails": {
|
|
665
|
+
* "paired": true,
|
|
666
|
+
* "associationTimestamp": "2024-09-28T17:30:24Z",
|
|
667
|
+
* "disassociationTimestamp": null,
|
|
668
|
+
* "confirmationTimestamp": "2024-10-23T22:17:22Z",
|
|
669
|
+
* "location": {
|
|
670
|
+
* "lat": 52.780639,
|
|
671
|
+
* "lon": -122.453222,
|
|
672
|
+
* "slope": null
|
|
673
|
+
* }
|
|
674
|
+
* },
|
|
675
|
+
* "messagesRestricted": false,
|
|
676
|
+
* "pairingStatus": "PAIRED",
|
|
677
|
+
* "orderNumber": "961111",
|
|
678
|
+
* "highFidelityConfigurationVersion": {
|
|
679
|
+
* "name": "1Hz_L3X40FT4JDPS0x00_ISG_X8X9SPFH_63978_2024.008.001"
|
|
680
|
+
* },
|
|
681
|
+
* "genericConfigurationVersion": {
|
|
682
|
+
* "name": "1623F1EF-62C2-4B8B-B5EA-A0FFD6EA76F8"
|
|
683
|
+
* },
|
|
684
|
+
* "communicationModules": [
|
|
685
|
+
* {
|
|
686
|
+
* "imei": "014642005101111",
|
|
687
|
+
* "imsi": "310170835961111",
|
|
688
|
+
* "iccid": "89011704278359691111",
|
|
689
|
+
* "type": "GSM",
|
|
690
|
+
* "serviceProvider": "Jasper",
|
|
691
|
+
* "state": "Active",
|
|
692
|
+
* "id": "632111"
|
|
693
|
+
* }
|
|
694
|
+
* ],
|
|
695
|
+
* "id": "915111",
|
|
696
|
+
* "ERID": "fb537c94-14f1-11ef-871b-1287bcef1111"
|
|
612
697
|
* }
|
|
613
698
|
*/
|
|
614
|
-
|
|
699
|
+
device: components['schemas']['resource-embed'] & {
|
|
615
700
|
/**
|
|
616
|
-
* @description
|
|
617
|
-
* @example
|
|
701
|
+
* @description Device | Display | PositionReceiver | TelematicsGateway
|
|
702
|
+
* @example Device
|
|
703
|
+
* @enum {string}
|
|
618
704
|
*/
|
|
619
|
-
|
|
705
|
+
'@type'?: 'Device' | 'Display' | 'PositionReceiver' | 'TelematicsGateway';
|
|
620
706
|
/**
|
|
621
|
-
* @description
|
|
622
|
-
* @example
|
|
707
|
+
* @description Serial number of the device and passed on the query parameter
|
|
708
|
+
* @example PCS171B372381
|
|
623
709
|
*/
|
|
624
|
-
|
|
710
|
+
serialNumber?: string;
|
|
625
711
|
/**
|
|
626
|
-
* @description
|
|
712
|
+
* @description True if this is an official device (we have PI information about it).
|
|
627
713
|
* @example true
|
|
628
714
|
*/
|
|
629
|
-
|
|
715
|
+
isSerialNumberCertified?: boolean;
|
|
716
|
+
make?: components['schemas']['device-make'];
|
|
717
|
+
type?: components['schemas']['device-type'];
|
|
718
|
+
model?: components['schemas']['device-model'];
|
|
719
|
+
organization?: components['schemas']['organization-embed'];
|
|
630
720
|
/**
|
|
631
|
-
* @description
|
|
721
|
+
* @description Unique identifier of the Device.
|
|
722
|
+
* @example fcdc83cb-8840-4215-84b5-1769889db932
|
|
723
|
+
*/
|
|
724
|
+
ERID?: string;
|
|
725
|
+
firmwareVersion?: components['schemas']['version'];
|
|
726
|
+
capabilities?: components['schemas']['capability'][];
|
|
727
|
+
equipment?: components['schemas']['equipment'];
|
|
728
|
+
/**
|
|
729
|
+
* @description Indicates if the device is archived.
|
|
632
730
|
* @example true
|
|
633
731
|
*/
|
|
634
|
-
|
|
732
|
+
archived?: boolean;
|
|
635
733
|
/**
|
|
636
|
-
* @description Indicates if the
|
|
734
|
+
* @description Indicates if the device is decommissioned.
|
|
637
735
|
* @example false
|
|
638
736
|
*/
|
|
639
|
-
|
|
640
|
-
|
|
641
|
-
|
|
642
|
-
|
|
643
|
-
|
|
644
|
-
|
|
737
|
+
decommissioned?: boolean;
|
|
738
|
+
/**
|
|
739
|
+
* @description Indicates if the device is stolen.
|
|
740
|
+
* @example false
|
|
741
|
+
*/
|
|
742
|
+
stolen?: boolean;
|
|
743
|
+
/**
|
|
744
|
+
* @description Unique id for principal device
|
|
745
|
+
* @example 12345
|
|
746
|
+
*/
|
|
747
|
+
principalId?: string;
|
|
748
|
+
organizationRole?: components['schemas']['organization-role'];
|
|
749
|
+
/**
|
|
750
|
+
* @description Order number associated with the device.
|
|
751
|
+
* @example 987654321
|
|
752
|
+
*/
|
|
753
|
+
orderNumber?: string;
|
|
754
|
+
pairingDetails?: components['schemas']['pairing-details'];
|
|
755
|
+
/**
|
|
756
|
+
* Format: date-time
|
|
757
|
+
* @description Timestamp when the device was archived.
|
|
758
|
+
* @example 2021-03-10T19:19:46.420Z
|
|
759
|
+
*/
|
|
760
|
+
archivedTimestamp?: string;
|
|
761
|
+
};
|
|
762
|
+
/**
|
|
763
|
+
* DeviceMake
|
|
764
|
+
* @description Represents the make of a device, including its name and unique identifier (ERID).
|
|
645
765
|
* @example {
|
|
646
|
-
* "
|
|
647
|
-
* "
|
|
648
|
-
*
|
|
649
|
-
|
|
650
|
-
|
|
651
|
-
|
|
652
|
-
|
|
653
|
-
|
|
654
|
-
|
|
766
|
+
* "name": "JOHN DEERE",
|
|
767
|
+
* "ERID": "db18bdc4-025a-11eb-97e4-0e8d658c7ba3"
|
|
768
|
+
* }
|
|
769
|
+
*/
|
|
770
|
+
'device-make': components['schemas']['resource-embed'] & {
|
|
771
|
+
/**
|
|
772
|
+
* @description DeviceMake
|
|
773
|
+
* @example DeviceMake
|
|
774
|
+
* @enum {string}
|
|
775
|
+
*/
|
|
776
|
+
'@type'?: 'DeviceMake';
|
|
777
|
+
/**
|
|
778
|
+
* @description The name of the device make.
|
|
779
|
+
* @example JOHN DEERE
|
|
780
|
+
*/
|
|
781
|
+
name?: string;
|
|
782
|
+
/**
|
|
783
|
+
* @description Unique identifier of the device make.
|
|
784
|
+
* @example db18bdc4-025a-11eb-97e4-0e8d658c7ba3
|
|
785
|
+
*/
|
|
786
|
+
ERID?: string;
|
|
787
|
+
};
|
|
788
|
+
/**
|
|
789
|
+
* DeviceModel
|
|
790
|
+
* @description Represents the model of a device, including its name, unique identifier (ERID), make, and type.
|
|
791
|
+
* @example {
|
|
792
|
+
* "name": "JDLink Modem-4G",
|
|
793
|
+
* "ERID": "db18bdc4-025a-11eb-97e4-0e8d658c7ba3",
|
|
794
|
+
* "make": {
|
|
795
|
+
* "name": "JOHN DEERE",
|
|
796
|
+
* "ERID": "db18bdc4-025a-11eb-97e4-0e8d658c7ba3"
|
|
655
797
|
* },
|
|
656
|
-
* "
|
|
657
|
-
*
|
|
658
|
-
*
|
|
659
|
-
* "
|
|
660
|
-
* "createdAt": "2023-10-01T12:00:00Z",
|
|
661
|
-
* "updatedBy": "user456",
|
|
662
|
-
* "updatedAt": "2023-10-02T12:00:00Z"
|
|
798
|
+
* "type": {
|
|
799
|
+
* "name": "Modem",
|
|
800
|
+
* "commonName": "TelematicsGateway",
|
|
801
|
+
* "ERID": "db18bdc4-025a-11eb-97e4-0e8d658c7ba3"
|
|
663
802
|
* }
|
|
664
803
|
* }
|
|
665
804
|
*/
|
|
666
|
-
'
|
|
805
|
+
'device-model': components['schemas']['resource-embed'] & {
|
|
667
806
|
/**
|
|
668
|
-
* @description
|
|
669
|
-
* @example
|
|
807
|
+
* @description DeviceModel
|
|
808
|
+
* @example DeviceModel
|
|
809
|
+
* @enum {string}
|
|
810
|
+
*/
|
|
811
|
+
'@type'?: 'DeviceModel';
|
|
812
|
+
/**
|
|
813
|
+
* @description The name of the device model.
|
|
814
|
+
* @example JDLink Modem-4G
|
|
670
815
|
*/
|
|
671
816
|
name?: string;
|
|
672
817
|
/**
|
|
673
|
-
* @description Unique identifier
|
|
674
|
-
* @example
|
|
818
|
+
* @description Unique identifier of the device model.
|
|
819
|
+
* @example db18bdc4-025a-11eb-97e4-0e8d658c7ba3
|
|
675
820
|
*/
|
|
676
821
|
ERID?: string;
|
|
822
|
+
make?: components['schemas']['device-make'];
|
|
823
|
+
type?: components['schemas']['device-type'];
|
|
824
|
+
};
|
|
825
|
+
/**
|
|
826
|
+
* DeviceType
|
|
827
|
+
* @description Represents the type of a device, including its name, common name, and unique identifier (ERID).
|
|
828
|
+
* @example {
|
|
829
|
+
* "name": "Modem",
|
|
830
|
+
* "commonName": "TelematicsGateway",
|
|
831
|
+
* "ERID": "db18bdc4-025a-11eb-97e4-0e8d658c7ba3"
|
|
832
|
+
* }
|
|
833
|
+
*/
|
|
834
|
+
'device-type': components['schemas']['resource-embed'] & {
|
|
677
835
|
/**
|
|
678
|
-
* @description
|
|
679
|
-
* @example
|
|
836
|
+
* @description DeviceType
|
|
837
|
+
* @example DeviceType
|
|
680
838
|
* @enum {string}
|
|
681
839
|
*/
|
|
682
|
-
|
|
840
|
+
'@type'?: 'DeviceType';
|
|
683
841
|
/**
|
|
684
|
-
* @description
|
|
685
|
-
* @example
|
|
842
|
+
* @description The name of the device type.
|
|
843
|
+
* @example Modem
|
|
686
844
|
*/
|
|
687
|
-
|
|
845
|
+
name?: string;
|
|
688
846
|
/**
|
|
689
|
-
* @description
|
|
690
|
-
* @example
|
|
847
|
+
* @description The common name of the device type.
|
|
848
|
+
* @example TelematicsGateway
|
|
691
849
|
*/
|
|
692
|
-
|
|
850
|
+
commonName?: string;
|
|
693
851
|
/**
|
|
694
|
-
* @description
|
|
695
|
-
* @example
|
|
852
|
+
* @description Unique identifier of the device type.
|
|
853
|
+
* @example db18bdc4-025a-11eb-97e4-0e8d658c7ba3
|
|
854
|
+
*/
|
|
855
|
+
ERID?: string;
|
|
856
|
+
};
|
|
857
|
+
/** Display */
|
|
858
|
+
display: components['schemas']['device'] & {
|
|
859
|
+
/**
|
|
860
|
+
* @description Display
|
|
861
|
+
* @example Display
|
|
696
862
|
* @enum {string}
|
|
697
863
|
*/
|
|
698
|
-
|
|
699
|
-
|
|
864
|
+
'@type'?: 'Display';
|
|
865
|
+
monitors?: components['schemas']['display-monitors'][];
|
|
866
|
+
};
|
|
867
|
+
/** Monitor */
|
|
868
|
+
'display-monitors': components['schemas']['resource-embed'] & {
|
|
700
869
|
/**
|
|
701
|
-
* @description
|
|
702
|
-
* @example
|
|
870
|
+
* @description Monitor
|
|
871
|
+
* @example Monitor
|
|
872
|
+
* @enum {string}
|
|
703
873
|
*/
|
|
704
|
-
|
|
874
|
+
'@type'?: 'Monitor';
|
|
875
|
+
/** @example Monitor_0 */
|
|
876
|
+
type?: string;
|
|
877
|
+
/** @example PCG410A015392 */
|
|
878
|
+
serialNumber?: string;
|
|
879
|
+
/** @example 800 */
|
|
880
|
+
resolutionWidth?: number;
|
|
881
|
+
/** @example 600 */
|
|
882
|
+
resolutionHeight?: number;
|
|
705
883
|
};
|
|
706
884
|
/**
|
|
707
|
-
*
|
|
708
|
-
* @description Represents the
|
|
885
|
+
* Equipment
|
|
886
|
+
* @description Represents the equipment, including its name, serial number, model year, make, type, ISG type, model, organization, telematics capability, and various other attributes.
|
|
709
887
|
*/
|
|
710
|
-
|
|
888
|
+
equipment: components['schemas']['resource'] & {
|
|
711
889
|
/**
|
|
712
|
-
* @description
|
|
713
|
-
* @example
|
|
890
|
+
* @description Equipment | Machine | Implement
|
|
891
|
+
* @example Equipment
|
|
892
|
+
* @enum {string}
|
|
714
893
|
*/
|
|
715
|
-
'@type'?:
|
|
894
|
+
'@type'?: 'Equipment' | 'Machine' | 'Implement';
|
|
716
895
|
/**
|
|
717
|
-
* @description
|
|
718
|
-
* @example
|
|
896
|
+
* @description Equipment Name.
|
|
897
|
+
* @example Cates 8360R 055358
|
|
719
898
|
*/
|
|
720
|
-
|
|
899
|
+
name?: string;
|
|
721
900
|
/**
|
|
722
|
-
* @description
|
|
723
|
-
* @example
|
|
901
|
+
* @description Unique 64-bit ISO NAME used to identify the controller during address claim.
|
|
902
|
+
* @example b00082000422ed1d
|
|
724
903
|
*/
|
|
725
|
-
|
|
904
|
+
isoName?: string;
|
|
726
905
|
/**
|
|
727
|
-
* @description
|
|
728
|
-
* @example
|
|
906
|
+
* @description Serial Number of the Equipment and passed on the query parameter
|
|
907
|
+
* @example 1RW8360RLCD055358
|
|
729
908
|
*/
|
|
730
|
-
|
|
731
|
-
};
|
|
732
|
-
/**
|
|
733
|
-
* IconStyle
|
|
734
|
-
* @description icon style
|
|
735
|
-
*/
|
|
736
|
-
'icon-style': {
|
|
737
|
-
/** @description primary color of the icon style */
|
|
738
|
-
primaryColor?: string;
|
|
739
|
-
/** @description secondary color of the icon style */
|
|
740
|
-
secondaryColor?: string;
|
|
741
|
-
};
|
|
742
|
-
/** EquipmentIcon */
|
|
743
|
-
'equipment-icon': components['schemas']['resource'] & {
|
|
909
|
+
serialNumber?: string;
|
|
744
910
|
/**
|
|
745
|
-
* @description
|
|
746
|
-
* @example
|
|
911
|
+
* @description VIN or PIN, more than Serial Number, of the Engine.
|
|
912
|
+
* @example RG6090L839275
|
|
747
913
|
*/
|
|
748
|
-
|
|
749
|
-
iconStyle?: components['schemas']['icon-style'];
|
|
750
|
-
};
|
|
751
|
-
/** EquipmentModel */
|
|
752
|
-
'equipment-model-details': {
|
|
753
|
-
/** @example 8360R */
|
|
754
|
-
name?: string;
|
|
755
|
-
/** @example 158df9ff-334a-4e0d-86cc-3adca17a9686 */
|
|
756
|
-
ERID?: string;
|
|
757
|
-
/** @enum {string} */
|
|
758
|
-
category?: 'Machine' | 'Implement' | 'Unknown';
|
|
759
|
-
make?: components['schemas']['equipment-make-embed'];
|
|
760
|
-
type?: components['schemas']['equipment-type-embed'];
|
|
761
|
-
icon?: components['schemas']['equipment-icon'];
|
|
762
|
-
};
|
|
763
|
-
/**
|
|
764
|
-
* EquipmentISGType
|
|
765
|
-
* @description Represents the ISG type of equipment, including its name, unique identifier, category, deprecation status, and metadata.
|
|
766
|
-
*/
|
|
767
|
-
'equipment-isg-type-embed': {
|
|
914
|
+
engineSerialNumber?: string;
|
|
768
915
|
/**
|
|
769
|
-
* @description
|
|
770
|
-
* @example
|
|
916
|
+
* @description True if this is an official equipment (we have PI information about it).
|
|
917
|
+
* @example true
|
|
771
918
|
*/
|
|
772
|
-
|
|
919
|
+
isSerialNumberCertified?: boolean;
|
|
773
920
|
/**
|
|
774
|
-
* @description
|
|
775
|
-
* @example
|
|
921
|
+
* @description Year of model.
|
|
922
|
+
* @example 2019
|
|
776
923
|
*/
|
|
777
|
-
|
|
924
|
+
modelYear?: string;
|
|
925
|
+
make?: components['schemas']['equipment-make-embed'];
|
|
926
|
+
type?: components['schemas']['equipment-type-embed'];
|
|
927
|
+
isgType?: components['schemas']['equipment-isg-type-embed'];
|
|
928
|
+
model?: components['schemas']['equipment-model-embed'];
|
|
929
|
+
organization?: components['schemas']['organization-embed'];
|
|
778
930
|
/**
|
|
779
|
-
* @description
|
|
780
|
-
* @example
|
|
931
|
+
* @description Indicates if the equipment is capable of telematics.
|
|
932
|
+
* @example true
|
|
781
933
|
*/
|
|
782
|
-
|
|
934
|
+
telematicsCapable?: boolean;
|
|
783
935
|
/**
|
|
784
|
-
* @description
|
|
785
|
-
* @example
|
|
936
|
+
* @description Indicates if the equipment is archived.
|
|
937
|
+
* @example true
|
|
938
|
+
*/
|
|
939
|
+
archived?: boolean;
|
|
940
|
+
/**
|
|
941
|
+
* @description Unique id for principal equipment
|
|
942
|
+
* @example 12345
|
|
943
|
+
*/
|
|
944
|
+
principalId?: string;
|
|
945
|
+
organizationRole?: components['schemas']['organization-role'];
|
|
946
|
+
/**
|
|
947
|
+
* @description Unique identifier of the Equipment.
|
|
948
|
+
* @example fcdc83cb-8840-4215-84b5-1769889db932
|
|
949
|
+
*/
|
|
950
|
+
ERID?: string;
|
|
951
|
+
/** @description List of alternate identifiers of the Equipment like DE-13, DE-17, ERID... */
|
|
952
|
+
alternateIdentifiers?: components['schemas']['identifier'][];
|
|
953
|
+
icon?: components['schemas']['equipment-icon'];
|
|
954
|
+
offsets?: components['schemas']['offsets'];
|
|
955
|
+
/** @description List of devices paired with the equipment. */
|
|
956
|
+
devices?: components['schemas']['device'][];
|
|
957
|
+
/** @description List of capabilities of the equipment. */
|
|
958
|
+
capabilities?: components['schemas']['capability'][];
|
|
959
|
+
pairingDetails?: components['schemas']['pairing-details'];
|
|
960
|
+
/**
|
|
961
|
+
* Format: date-time
|
|
962
|
+
* @description Timestamp when the equipment was archived.
|
|
963
|
+
* @example 2021-03-10T19:19:46.420Z
|
|
964
|
+
*/
|
|
965
|
+
archivedTimestamp?: string;
|
|
966
|
+
/** @description List of equipment that was merged. */
|
|
967
|
+
mergedEquipment?: components['schemas']['machine'][];
|
|
968
|
+
/**
|
|
969
|
+
* @description Indicates if the equipment is CSC equipment or not.
|
|
970
|
+
* @example true
|
|
971
|
+
*/
|
|
972
|
+
isCsc?: boolean;
|
|
973
|
+
};
|
|
974
|
+
/** EquipmentIcon */
|
|
975
|
+
'equipment-icon': components['schemas']['resource'] & {
|
|
976
|
+
/**
|
|
977
|
+
* @description The name of the equipment icon.
|
|
978
|
+
* @example JOHN DEERE
|
|
979
|
+
*/
|
|
980
|
+
name?: string;
|
|
981
|
+
iconStyle?: components['schemas']['icon-style'];
|
|
982
|
+
};
|
|
983
|
+
/**
|
|
984
|
+
* EquipmentIsgType
|
|
985
|
+
* @description Represents the ISG type of equipment, including its name, unique identifier, category, deprecation status, and metadata.
|
|
986
|
+
* @example {
|
|
987
|
+
* "name": "Tractor",
|
|
988
|
+
* "ERID": "82115264-9385-460c-bfbe-177a59445fd9",
|
|
989
|
+
* "category": "Machine",
|
|
990
|
+
* "allowsCustomModel": true,
|
|
991
|
+
* "isgMarketSegment": "Agriculture",
|
|
992
|
+
* "deprecated": false,
|
|
993
|
+
* "recordMetaData": {
|
|
994
|
+
* "createdBy": "user123",
|
|
995
|
+
* "createdAt": "2023-10-01T12:00:00Z",
|
|
996
|
+
* "updatedBy": "user456",
|
|
997
|
+
* "updatedAt": "2023-10-02T12:00:00Z"
|
|
998
|
+
* }
|
|
999
|
+
* }
|
|
1000
|
+
*/
|
|
1001
|
+
'equipment-isg-type': components['schemas']['resource'] & {
|
|
1002
|
+
/**
|
|
1003
|
+
* @description The name of the ISG equipment type.
|
|
1004
|
+
* @example Tractor
|
|
1005
|
+
*/
|
|
1006
|
+
name?: string;
|
|
1007
|
+
/**
|
|
1008
|
+
* @description Unique identifier for the ISG equipment type.
|
|
1009
|
+
* @example 82115264-9385-460c-bfbe-177a59445fd9
|
|
1010
|
+
*/
|
|
1011
|
+
ERID?: string;
|
|
1012
|
+
/**
|
|
1013
|
+
* @description The category of the ISG equipment type.
|
|
1014
|
+
* @example Machine
|
|
1015
|
+
* @enum {string}
|
|
1016
|
+
*/
|
|
1017
|
+
category?: 'Machine' | 'Implement' | 'Unknown';
|
|
1018
|
+
/**
|
|
1019
|
+
* @description Indicates if the equipment ISG type allows custom models.
|
|
1020
|
+
* @example true
|
|
1021
|
+
*/
|
|
1022
|
+
allowsCustomModel?: boolean;
|
|
1023
|
+
/**
|
|
1024
|
+
* @description The ISG market segment of the equipment ISG type.
|
|
1025
|
+
* @example Agriculture
|
|
1026
|
+
* @enum {string}
|
|
1027
|
+
*/
|
|
1028
|
+
isgMarketSegment?: 'Unknown' | 'Agriculture' | 'Construction' | 'Engines & Components' | 'Forestry' | 'Turf';
|
|
1029
|
+
/**
|
|
1030
|
+
* @description Indicates if the ISG equipment type is deprecated.
|
|
1031
|
+
* @example false
|
|
1032
|
+
*/
|
|
1033
|
+
deprecated?: boolean;
|
|
1034
|
+
};
|
|
1035
|
+
/**
|
|
1036
|
+
* EquipmentISGType
|
|
1037
|
+
* @description Represents the ISG type of equipment, including its name, unique identifier, category, deprecation status, and metadata.
|
|
1038
|
+
*/
|
|
1039
|
+
'equipment-isg-type-embed': {
|
|
1040
|
+
/**
|
|
1041
|
+
* @description EquipmentISGType
|
|
1042
|
+
* @example EquipmentISGType
|
|
1043
|
+
*/
|
|
1044
|
+
'@type'?: string;
|
|
1045
|
+
/**
|
|
1046
|
+
* @description Unique identifier for the ISG equipment type.
|
|
1047
|
+
* @example 2
|
|
1048
|
+
*/
|
|
1049
|
+
id?: string;
|
|
1050
|
+
/**
|
|
1051
|
+
* @description The name of the ISG equipment type.
|
|
1052
|
+
* @example Combine
|
|
1053
|
+
*/
|
|
1054
|
+
name?: string;
|
|
1055
|
+
/**
|
|
1056
|
+
* @description Unique identifier for the ISG equipment type.
|
|
1057
|
+
* @example d8dce5b0-cc8d-4c34-afac-27d93793bd86
|
|
1058
|
+
*/
|
|
1059
|
+
ERID?: string;
|
|
1060
|
+
};
|
|
1061
|
+
/**
|
|
1062
|
+
* EquipmentMake
|
|
1063
|
+
* @description Represents the make of the equipment, including its name, unique identifier, and metadata.
|
|
1064
|
+
* @example {
|
|
1065
|
+
* "id": 1,
|
|
1066
|
+
* "name": "JOHN DEERE",
|
|
1067
|
+
* "ERID": "db18bdc4-025a-11eb-97e4-0e8d658c7ba3",
|
|
1068
|
+
* "certified": true,
|
|
1069
|
+
* "deereOrSubsidiary": true,
|
|
1070
|
+
* "deprecated": false,
|
|
1071
|
+
* "recordMetaData": {
|
|
1072
|
+
* "createdBy": "user123",
|
|
1073
|
+
* "createdAt": "2023-10-01T12:00:00Z",
|
|
1074
|
+
* "updatedBy": "user456",
|
|
1075
|
+
* "updatedAt": "2023-10-02T12:00:00Z"
|
|
1076
|
+
* }
|
|
1077
|
+
* }
|
|
1078
|
+
*/
|
|
1079
|
+
'equipment-make': components['schemas']['resource'] & {
|
|
1080
|
+
/**
|
|
1081
|
+
* @description The name of the equipment make.
|
|
1082
|
+
* @example JOHN DEERE
|
|
1083
|
+
*/
|
|
1084
|
+
name?: string;
|
|
1085
|
+
/**
|
|
1086
|
+
* @description Unique identifier for the equipment make.
|
|
1087
|
+
* @example db18bdc4-025a-11eb-97e4-0e8d658c7ba3
|
|
1088
|
+
*/
|
|
1089
|
+
ERID?: string;
|
|
1090
|
+
/**
|
|
1091
|
+
* @description Indicates if the equipment make is certified.
|
|
1092
|
+
* @example true
|
|
1093
|
+
*/
|
|
1094
|
+
certified?: boolean;
|
|
1095
|
+
/**
|
|
1096
|
+
* @description Indicates if the equipment make is deereOrSubsidiary.
|
|
1097
|
+
* @example true
|
|
1098
|
+
*/
|
|
1099
|
+
deereOrSubsidiary?: boolean;
|
|
1100
|
+
/**
|
|
1101
|
+
* @description Indicates if the equipment make is deprecated.
|
|
1102
|
+
* @example false
|
|
1103
|
+
*/
|
|
1104
|
+
deprecated?: boolean;
|
|
1105
|
+
};
|
|
1106
|
+
/**
|
|
1107
|
+
* EquipmentMake
|
|
1108
|
+
* @description Represents the make of the equipment, including its name, unique identifier, and metadata.
|
|
1109
|
+
*/
|
|
1110
|
+
'equipment-make-embed': {
|
|
1111
|
+
/**
|
|
1112
|
+
* @description EquipmentMake
|
|
1113
|
+
* @example EquipmentMake
|
|
1114
|
+
*/
|
|
1115
|
+
'@type'?: string;
|
|
1116
|
+
/**
|
|
1117
|
+
* @description Unique identifier for the equipment make.
|
|
1118
|
+
* @example 1
|
|
1119
|
+
*/
|
|
1120
|
+
id?: string;
|
|
1121
|
+
/**
|
|
1122
|
+
* @description The name of the equipment make.
|
|
1123
|
+
* @example JOHN DEERE
|
|
1124
|
+
*/
|
|
1125
|
+
name?: string;
|
|
1126
|
+
/**
|
|
1127
|
+
* @description Unique identifier for the equipment make.
|
|
1128
|
+
* @example db18bdc4-025a-11eb-97e4-0e8d658c7ba3
|
|
786
1129
|
*/
|
|
787
1130
|
ERID?: string;
|
|
1131
|
+
/**
|
|
1132
|
+
* @description Indicates if the equipment make is certified.
|
|
1133
|
+
* @example true
|
|
1134
|
+
*/
|
|
1135
|
+
certified?: boolean;
|
|
1136
|
+
/**
|
|
1137
|
+
* @description Indicates if the equipment make is deereOrSubsidiary.
|
|
1138
|
+
* @example true
|
|
1139
|
+
*/
|
|
1140
|
+
deereOrSubsidiary?: boolean;
|
|
788
1141
|
};
|
|
789
1142
|
/**
|
|
790
1143
|
* EquipmentModel
|
|
@@ -879,6 +1232,18 @@ export interface components {
|
|
|
879
1232
|
type?: components['schemas']['equipment-type'];
|
|
880
1233
|
isgType?: components['schemas']['equipment-isg-type'];
|
|
881
1234
|
};
|
|
1235
|
+
/** EquipmentModel */
|
|
1236
|
+
'equipment-model-details': {
|
|
1237
|
+
/** @example 8360R */
|
|
1238
|
+
name?: string;
|
|
1239
|
+
/** @example 158df9ff-334a-4e0d-86cc-3adca17a9686 */
|
|
1240
|
+
ERID?: string;
|
|
1241
|
+
/** @enum {string} */
|
|
1242
|
+
category?: 'Machine' | 'Implement' | 'Unknown';
|
|
1243
|
+
make?: components['schemas']['equipment-make-embed'];
|
|
1244
|
+
type?: components['schemas']['equipment-type-embed'];
|
|
1245
|
+
icon?: components['schemas']['equipment-icon'];
|
|
1246
|
+
};
|
|
882
1247
|
/**
|
|
883
1248
|
* EquipmentModel
|
|
884
1249
|
* @description Represents the model of the equipment, including its name, unique identifier, category, certification status, make, type, ISG type, icon, deprecation status, and metadata.
|
|
@@ -943,246 +1308,105 @@ export interface components {
|
|
|
943
1308
|
*/
|
|
944
1309
|
certified?: boolean;
|
|
945
1310
|
};
|
|
1311
|
+
/** PatchDTO */
|
|
1312
|
+
'equipment-patch': {
|
|
1313
|
+
/** @enum {string} */
|
|
1314
|
+
operation?: 'UPDATE';
|
|
1315
|
+
/** @enum {string} */
|
|
1316
|
+
path?: '/organization' | '/archived' | '/organizationRole/type' | '/name';
|
|
1317
|
+
/** @description - For transfer request : value={organizationId} - For archive/unarchive request : value=true/false - For role update request : value={Controlling} - For name update request : value={name} */
|
|
1318
|
+
value?: string;
|
|
1319
|
+
};
|
|
946
1320
|
/**
|
|
947
|
-
*
|
|
948
|
-
* @
|
|
1321
|
+
* EquipmentType
|
|
1322
|
+
* @deprecated
|
|
1323
|
+
* @description Represents the type of equipment, including its name, unique identifier, category, certification status, market segment, icon, deprecation status, and metadata.
|
|
1324
|
+
* @example {
|
|
1325
|
+
* "id": 217,
|
|
1326
|
+
* "name": "Two-wheel Drive Tractors - 140 Hp And Above",
|
|
1327
|
+
* "ERID": "82115264-9385-460c-bfbe-177a59445fd9",
|
|
1328
|
+
* "category": "Machine",
|
|
1329
|
+
* "certified": true,
|
|
1330
|
+
* "marketSegment": "Agriculture",
|
|
1331
|
+
* "icon": {
|
|
1332
|
+
* "url": "https://example.com/icon.png",
|
|
1333
|
+
* "description": "Icon representing the equipment type"
|
|
1334
|
+
* },
|
|
1335
|
+
* "deprecated": false,
|
|
1336
|
+
* "allowsCustomModel": true,
|
|
1337
|
+
* "recordMetaData": {
|
|
1338
|
+
* "createdBy": "user123",
|
|
1339
|
+
* "createdAt": "2023-10-01T12:00:00Z",
|
|
1340
|
+
* "updatedBy": "user456",
|
|
1341
|
+
* "updatedAt": "2023-10-02T12:00:00Z"
|
|
1342
|
+
* }
|
|
1343
|
+
* }
|
|
949
1344
|
*/
|
|
950
|
-
|
|
1345
|
+
'equipment-type': components['schemas']['resource'] & {
|
|
951
1346
|
/**
|
|
952
|
-
* @description
|
|
953
|
-
* @
|
|
1347
|
+
* @description The name of the equipment type.
|
|
1348
|
+
* @example Two-wheel Drive Tractors - 140 Hp And Above
|
|
954
1349
|
*/
|
|
955
|
-
|
|
1350
|
+
name?: string;
|
|
956
1351
|
/**
|
|
957
|
-
* @description
|
|
958
|
-
* @example
|
|
959
|
-
*/
|
|
960
|
-
value?: string;
|
|
961
|
-
};
|
|
962
|
-
/**
|
|
963
|
-
* OrganizationRole
|
|
964
|
-
* @description Represents the role of an organization, including its type, effective timestamp, and event.
|
|
965
|
-
* @example {
|
|
966
|
-
* "type": "Controlling",
|
|
967
|
-
* "effectiveTS": "2023-10-01T12:00:00Z",
|
|
968
|
-
* "event": "CREATION"
|
|
969
|
-
* }
|
|
970
|
-
*/
|
|
971
|
-
'organization-role': {
|
|
972
|
-
/**
|
|
973
|
-
* @description The type of the organization role.
|
|
974
|
-
* @example Controlling
|
|
975
|
-
* @enum {string}
|
|
976
|
-
*/
|
|
977
|
-
type?: 'Controlling' | 'NonControlling';
|
|
978
|
-
/**
|
|
979
|
-
* Format: date-time
|
|
980
|
-
* @description The timestamp when the role becomes effective.
|
|
981
|
-
* @example 2023-10-01T12:00:00Z
|
|
1352
|
+
* @description Unique identifier for the equipment type.
|
|
1353
|
+
* @example 82115264-9385-460c-bfbe-177a59445fd9
|
|
982
1354
|
*/
|
|
983
|
-
|
|
1355
|
+
ERID?: string;
|
|
984
1356
|
/**
|
|
985
|
-
* @description The
|
|
986
|
-
* @example
|
|
1357
|
+
* @description The category of the equipment type.
|
|
1358
|
+
* @example Machine
|
|
987
1359
|
* @enum {string}
|
|
988
1360
|
*/
|
|
989
|
-
|
|
990
|
-
/** @example true */
|
|
991
|
-
inPossession?: boolean;
|
|
992
|
-
};
|
|
993
|
-
/** AbstractMeasurement */
|
|
994
|
-
abstractMeasurement: {
|
|
995
|
-
type?: string;
|
|
996
|
-
unit?: string;
|
|
997
|
-
};
|
|
998
|
-
/**
|
|
999
|
-
* MeasurementAsDouble
|
|
1000
|
-
* @description measurement as double
|
|
1001
|
-
*/
|
|
1002
|
-
measurementAsDouble: components['schemas']['abstractMeasurement'] & {
|
|
1003
|
-
/** @description type of measurement */
|
|
1004
|
-
type?: string;
|
|
1005
|
-
/** @description unit of measurement */
|
|
1006
|
-
unit?: string;
|
|
1361
|
+
category?: 'Machine' | 'Implement' | 'Unknown';
|
|
1007
1362
|
/**
|
|
1008
|
-
*
|
|
1009
|
-
* @
|
|
1363
|
+
* @description Indicates if the equipment type is certified.
|
|
1364
|
+
* @example true
|
|
1010
1365
|
*/
|
|
1011
|
-
|
|
1012
|
-
};
|
|
1013
|
-
/** VariableRepresentationValue */
|
|
1014
|
-
variableRepresentationValue: {
|
|
1015
|
-
variable?: components['schemas']['measurementAsDouble'];
|
|
1016
|
-
};
|
|
1017
|
-
/**
|
|
1018
|
-
* MeasurementAsString
|
|
1019
|
-
* @description measurement as string
|
|
1020
|
-
*/
|
|
1021
|
-
measurementAsString: components['schemas']['abstractMeasurement'] & {
|
|
1022
|
-
/** @description type of measurement */
|
|
1023
|
-
type?: string;
|
|
1024
|
-
/** @description unit of measurement */
|
|
1025
|
-
unit?: string;
|
|
1026
|
-
/** @description measurement value as string */
|
|
1027
|
-
valueAsString?: string;
|
|
1028
|
-
};
|
|
1029
|
-
/** DefinedTypeRepresentationValue */
|
|
1030
|
-
definedTypeRepresentationValue: {
|
|
1031
|
-
value?: components['schemas']['measurementAsString'];
|
|
1032
|
-
};
|
|
1033
|
-
/**
|
|
1034
|
-
* Offsets
|
|
1035
|
-
* @description Represents the offsets of a device, including its variable and defined type representation values.
|
|
1036
|
-
*/
|
|
1037
|
-
offsets: components['schemas']['resource-embed'] & {
|
|
1366
|
+
certified?: boolean;
|
|
1038
1367
|
/**
|
|
1039
|
-
* @description
|
|
1040
|
-
* @example
|
|
1041
|
-
* @enum {string}
|
|
1368
|
+
* @description Indicates if the equipment type allows custom models.
|
|
1369
|
+
* @example true
|
|
1042
1370
|
*/
|
|
1043
|
-
|
|
1044
|
-
variableRepresentationValues?: components['schemas']['variableRepresentationValue'][];
|
|
1045
|
-
definedTypeRepresentationValues?: components['schemas']['definedTypeRepresentationValue'][];
|
|
1046
|
-
};
|
|
1047
|
-
/**
|
|
1048
|
-
* DeviceMake
|
|
1049
|
-
* @description Represents the make of a device, including its name and unique identifier (ERID).
|
|
1050
|
-
* @example {
|
|
1051
|
-
* "name": "JOHN DEERE",
|
|
1052
|
-
* "ERID": "db18bdc4-025a-11eb-97e4-0e8d658c7ba3"
|
|
1053
|
-
* }
|
|
1054
|
-
*/
|
|
1055
|
-
'device-make': components['schemas']['resource-embed'] & {
|
|
1371
|
+
allowsCustomModel?: boolean;
|
|
1056
1372
|
/**
|
|
1057
|
-
* @description
|
|
1058
|
-
* @example
|
|
1373
|
+
* @description The market segment of the equipment type.
|
|
1374
|
+
* @example Agriculture
|
|
1059
1375
|
* @enum {string}
|
|
1060
1376
|
*/
|
|
1061
|
-
'
|
|
1062
|
-
|
|
1063
|
-
* @description The name of the device make.
|
|
1064
|
-
* @example JOHN DEERE
|
|
1065
|
-
*/
|
|
1066
|
-
name?: string;
|
|
1377
|
+
marketSegment?: 'Unknown' | 'Agriculture' | 'Commercial Worksite Products' | 'Construction' | 'Engines & Components' | 'Forestry' | 'Mining' | 'Turf';
|
|
1378
|
+
icon?: components['schemas']['equipment-icon'];
|
|
1067
1379
|
/**
|
|
1068
|
-
* @description
|
|
1069
|
-
* @example
|
|
1380
|
+
* @description Indicates if the equipment type is deprecated.
|
|
1381
|
+
* @example false
|
|
1070
1382
|
*/
|
|
1071
|
-
|
|
1383
|
+
deprecated?: boolean;
|
|
1072
1384
|
};
|
|
1073
1385
|
/**
|
|
1074
|
-
*
|
|
1075
|
-
* @description Represents the type of
|
|
1076
|
-
* @example {
|
|
1077
|
-
* "name": "Modem",
|
|
1078
|
-
* "commonName": "TelematicsGateway",
|
|
1079
|
-
* "ERID": "db18bdc4-025a-11eb-97e4-0e8d658c7ba3"
|
|
1080
|
-
* }
|
|
1386
|
+
* EquipmentType
|
|
1387
|
+
* @description Represents the type of equipment, including its name, unique identifier, category, certification status, market segment, icon, deprecation status, and metadata.
|
|
1081
1388
|
*/
|
|
1082
|
-
'
|
|
1083
|
-
/**
|
|
1084
|
-
* @description DeviceType
|
|
1085
|
-
* @example DeviceType
|
|
1086
|
-
* @enum {string}
|
|
1087
|
-
*/
|
|
1088
|
-
'@type'?: 'DeviceType';
|
|
1089
|
-
/**
|
|
1090
|
-
* @description The name of the device type.
|
|
1091
|
-
* @example Modem
|
|
1092
|
-
*/
|
|
1093
|
-
name?: string;
|
|
1094
|
-
/**
|
|
1095
|
-
* @description The common name of the device type.
|
|
1096
|
-
* @example TelematicsGateway
|
|
1097
|
-
*/
|
|
1098
|
-
commonName?: string;
|
|
1389
|
+
'equipment-type-embed': {
|
|
1099
1390
|
/**
|
|
1100
|
-
* @description
|
|
1101
|
-
* @example
|
|
1391
|
+
* @description EquipmentType
|
|
1392
|
+
* @example EquipmentType
|
|
1102
1393
|
*/
|
|
1103
|
-
|
|
1104
|
-
};
|
|
1105
|
-
/**
|
|
1106
|
-
* DeviceModel
|
|
1107
|
-
* @description Represents the model of a device, including its name, unique identifier (ERID), make, and type.
|
|
1108
|
-
* @example {
|
|
1109
|
-
* "name": "JDLink Modem-4G",
|
|
1110
|
-
* "ERID": "db18bdc4-025a-11eb-97e4-0e8d658c7ba3",
|
|
1111
|
-
* "make": {
|
|
1112
|
-
* "name": "JOHN DEERE",
|
|
1113
|
-
* "ERID": "db18bdc4-025a-11eb-97e4-0e8d658c7ba3"
|
|
1114
|
-
* },
|
|
1115
|
-
* "type": {
|
|
1116
|
-
* "name": "Modem",
|
|
1117
|
-
* "commonName": "TelematicsGateway",
|
|
1118
|
-
* "ERID": "db18bdc4-025a-11eb-97e4-0e8d658c7ba3"
|
|
1119
|
-
* }
|
|
1120
|
-
* }
|
|
1121
|
-
*/
|
|
1122
|
-
'device-model': components['schemas']['resource-embed'] & {
|
|
1394
|
+
'@type'?: string;
|
|
1123
1395
|
/**
|
|
1124
|
-
* @description
|
|
1125
|
-
* @example
|
|
1126
|
-
* @enum {string}
|
|
1396
|
+
* @description Unique identifier for the equipment type.
|
|
1397
|
+
* @example 222
|
|
1127
1398
|
*/
|
|
1128
|
-
|
|
1399
|
+
id?: string;
|
|
1129
1400
|
/**
|
|
1130
|
-
* @description The name of the
|
|
1131
|
-
* @example
|
|
1401
|
+
* @description The name of the equipment type.
|
|
1402
|
+
* @example Combine
|
|
1132
1403
|
*/
|
|
1133
1404
|
name?: string;
|
|
1134
1405
|
/**
|
|
1135
|
-
* @description Unique identifier
|
|
1136
|
-
* @example
|
|
1406
|
+
* @description Unique identifier for the equipment type.
|
|
1407
|
+
* @example 80619ff7-11fa-11ee-bb58-0e5cd6a962d7
|
|
1137
1408
|
*/
|
|
1138
1409
|
ERID?: string;
|
|
1139
|
-
make?: components['schemas']['device-make'];
|
|
1140
|
-
type?: components['schemas']['device-type'];
|
|
1141
|
-
};
|
|
1142
|
-
/**
|
|
1143
|
-
* Version
|
|
1144
|
-
* @description Represents the version of a device or software, including its name.
|
|
1145
|
-
* @example {
|
|
1146
|
-
* "name": "3.16.1171"
|
|
1147
|
-
* }
|
|
1148
|
-
*/
|
|
1149
|
-
version: components['schemas']['resource-embed'] & {
|
|
1150
|
-
/**
|
|
1151
|
-
* @description Version
|
|
1152
|
-
* @example Version
|
|
1153
|
-
* @enum {string}
|
|
1154
|
-
*/
|
|
1155
|
-
'@type'?: 'Version';
|
|
1156
|
-
/**
|
|
1157
|
-
* @description The name of the version.
|
|
1158
|
-
* @example 3.16.1171
|
|
1159
|
-
*/
|
|
1160
|
-
name?: string;
|
|
1161
|
-
};
|
|
1162
|
-
/** InabilityDetail */
|
|
1163
|
-
'inability-detail': components['schemas']['resource'] & {
|
|
1164
|
-
/** @example RC14.8.1 */
|
|
1165
|
-
code?: string;
|
|
1166
|
-
/** @example REGISTRATION */
|
|
1167
|
-
type?: string;
|
|
1168
|
-
/** @example SIM registration is required */
|
|
1169
|
-
description?: string;
|
|
1170
|
-
};
|
|
1171
|
-
/**
|
|
1172
|
-
* Capability
|
|
1173
|
-
* @description List of capabilities of the equipment.
|
|
1174
|
-
*/
|
|
1175
|
-
capability: components['schemas']['resource-embed'] & {
|
|
1176
|
-
/**
|
|
1177
|
-
* @description Capability
|
|
1178
|
-
* @example Capability
|
|
1179
|
-
* @enum {string}
|
|
1180
|
-
*/
|
|
1181
|
-
'@type'?: 'Capability';
|
|
1182
|
-
capable?: boolean;
|
|
1183
|
-
/** @enum {string} */
|
|
1184
|
-
type?: 'JDLINK_CONNECTIVITY' | 'RDA' | 'WDT' | 'WIFI_CONNECTIVITY' | 'CUSTOMER_SIM_CONNECTIVITY' | 'LEGACY_CONNECTIVITY' | 'PLANNED_WORK' | 'DATA_SYNC_SETUP' | 'CH_REMOTE_ADJUST' | 'BASE_STATION' | 'MY_MACHINE' | 'RDC' | 'REMOTE_START';
|
|
1185
|
-
inabilityDetails?: components['schemas']['inability-detail'][];
|
|
1186
1410
|
};
|
|
1187
1411
|
/**
|
|
1188
1412
|
* Equipment
|
|
@@ -1272,435 +1496,233 @@ export interface components {
|
|
|
1272
1496
|
isCsc?: boolean;
|
|
1273
1497
|
};
|
|
1274
1498
|
/**
|
|
1275
|
-
*
|
|
1276
|
-
* @description
|
|
1499
|
+
* IconStyle
|
|
1500
|
+
* @description icon style
|
|
1277
1501
|
*/
|
|
1278
|
-
|
|
1502
|
+
'icon-style': {
|
|
1503
|
+
/** @description primary color of the icon style */
|
|
1504
|
+
primaryColor?: string;
|
|
1505
|
+
/** @description secondary color of the icon style */
|
|
1506
|
+
secondaryColor?: string;
|
|
1507
|
+
};
|
|
1508
|
+
/**
|
|
1509
|
+
* Identifier of Equipment
|
|
1510
|
+
* @description Identifier of the Equipment like DE-13, DE-17, ERID...
|
|
1511
|
+
*/
|
|
1512
|
+
identifier: {
|
|
1279
1513
|
/**
|
|
1280
|
-
* @description
|
|
1281
|
-
* @example Equipment
|
|
1514
|
+
* @description Type of identifier.
|
|
1282
1515
|
* @enum {string}
|
|
1283
1516
|
*/
|
|
1284
|
-
|
|
1517
|
+
type?: 'serialNumber' | 'ERID';
|
|
1285
1518
|
/**
|
|
1286
|
-
* @description
|
|
1287
|
-
* @example
|
|
1288
|
-
*/
|
|
1289
|
-
name?: string;
|
|
1290
|
-
/**
|
|
1291
|
-
* @description Unique 64-bit ISO NAME used to identify the controller during address claim.
|
|
1292
|
-
* @example b00082000422ed1d
|
|
1293
|
-
*/
|
|
1294
|
-
isoName?: string;
|
|
1295
|
-
/**
|
|
1296
|
-
* @description Serial Number of the Equipment and passed on the query parameter
|
|
1297
|
-
* @example 1RW8360RLCD055358
|
|
1298
|
-
*/
|
|
1299
|
-
serialNumber?: string;
|
|
1300
|
-
/**
|
|
1301
|
-
* @description VIN or PIN, more than Serial Number, of the Engine.
|
|
1302
|
-
* @example RG6090L839275
|
|
1303
|
-
*/
|
|
1304
|
-
engineSerialNumber?: string;
|
|
1305
|
-
/**
|
|
1306
|
-
* @description True if this is an official equipment (we have PI information about it).
|
|
1307
|
-
* @example true
|
|
1308
|
-
*/
|
|
1309
|
-
isSerialNumberCertified?: boolean;
|
|
1310
|
-
/**
|
|
1311
|
-
* @description Year of model.
|
|
1312
|
-
* @example 2019
|
|
1313
|
-
*/
|
|
1314
|
-
modelYear?: string;
|
|
1315
|
-
make?: components['schemas']['equipment-make-embed'];
|
|
1316
|
-
type?: components['schemas']['equipment-type-embed'];
|
|
1317
|
-
isgType?: components['schemas']['equipment-isg-type-embed'];
|
|
1318
|
-
model?: components['schemas']['equipment-model-embed'];
|
|
1319
|
-
organization?: components['schemas']['organization-embed'];
|
|
1320
|
-
/**
|
|
1321
|
-
* @description Indicates if the equipment is capable of telematics.
|
|
1322
|
-
* @example true
|
|
1323
|
-
*/
|
|
1324
|
-
telematicsCapable?: boolean;
|
|
1325
|
-
/**
|
|
1326
|
-
* @description Indicates if the equipment is archived.
|
|
1327
|
-
* @example true
|
|
1328
|
-
*/
|
|
1329
|
-
archived?: boolean;
|
|
1330
|
-
/**
|
|
1331
|
-
* @description Unique id for principal equipment
|
|
1332
|
-
* @example 12345
|
|
1333
|
-
*/
|
|
1334
|
-
principalId?: string;
|
|
1335
|
-
organizationRole?: components['schemas']['organization-role'];
|
|
1336
|
-
/**
|
|
1337
|
-
* @description Unique identifier of the Equipment.
|
|
1338
|
-
* @example fcdc83cb-8840-4215-84b5-1769889db932
|
|
1339
|
-
*/
|
|
1340
|
-
ERID?: string;
|
|
1341
|
-
/** @description List of alternate identifiers of the Equipment like DE-13, DE-17, ERID... */
|
|
1342
|
-
alternateIdentifiers?: components['schemas']['identifier'][];
|
|
1343
|
-
icon?: components['schemas']['equipment-icon'];
|
|
1344
|
-
offsets?: components['schemas']['offsets'];
|
|
1345
|
-
/** @description List of devices paired with the equipment. */
|
|
1346
|
-
devices?: components['schemas']['device'][];
|
|
1347
|
-
/** @description List of capabilities of the equipment. */
|
|
1348
|
-
capabilities?: components['schemas']['capability'][];
|
|
1349
|
-
pairingDetails?: components['schemas']['pairing-details'];
|
|
1350
|
-
/**
|
|
1351
|
-
* Format: date-time
|
|
1352
|
-
* @description Timestamp when the equipment was archived.
|
|
1353
|
-
* @example 2021-03-10T19:19:46.420Z
|
|
1519
|
+
* @description Value of identifier.
|
|
1520
|
+
* @example RW8360R055358
|
|
1354
1521
|
*/
|
|
1355
|
-
|
|
1356
|
-
|
|
1357
|
-
|
|
1522
|
+
value?: string;
|
|
1523
|
+
};
|
|
1524
|
+
/** Implement */
|
|
1525
|
+
implement: components['schemas']['equipment'] & {
|
|
1526
|
+
machine?: components['schemas']['machine'];
|
|
1527
|
+
};
|
|
1528
|
+
/** InabilityDetail */
|
|
1529
|
+
'inability-detail': components['schemas']['resource'] & {
|
|
1530
|
+
/** @example RC14.8.1 */
|
|
1531
|
+
code?: string;
|
|
1532
|
+
/** @example REGISTRATION */
|
|
1533
|
+
type?: string;
|
|
1534
|
+
/** @example SIM registration is required */
|
|
1535
|
+
description?: string;
|
|
1536
|
+
};
|
|
1537
|
+
/** Link */
|
|
1538
|
+
link: {
|
|
1539
|
+
/** @example nextPage */
|
|
1540
|
+
rel?: string;
|
|
1358
1541
|
/**
|
|
1359
|
-
* @description
|
|
1360
|
-
* @example
|
|
1542
|
+
* @description This will be the relative URL. Users will prefix the base url as per their requirements.
|
|
1543
|
+
* @example /equipment?pageOffset=10&itemSize=10
|
|
1361
1544
|
*/
|
|
1362
|
-
|
|
1545
|
+
uri?: string;
|
|
1363
1546
|
};
|
|
1364
|
-
/**
|
|
1365
|
-
|
|
1366
|
-
|
|
1367
|
-
lat?: number;
|
|
1368
|
-
/** Format: double */
|
|
1369
|
-
lon?: number;
|
|
1370
|
-
/** Format: double */
|
|
1371
|
-
slope?: number;
|
|
1547
|
+
/** Machine */
|
|
1548
|
+
machine: components['schemas']['equipment'] & {
|
|
1549
|
+
implements?: components['schemas']['implement'][];
|
|
1372
1550
|
};
|
|
1373
1551
|
/**
|
|
1374
|
-
*
|
|
1375
|
-
* @description
|
|
1376
|
-
* @example {
|
|
1377
|
-
* "paired": true,
|
|
1378
|
-
* "associationTimestamp": "2023-10-01T12:00:00Z",
|
|
1379
|
-
* "disassociationTimestamp": "2023-10-02T12:00:00Z",
|
|
1380
|
-
* "confirmationTimestamp": "2023-10-01T12:30:00Z",
|
|
1381
|
-
* "location": {
|
|
1382
|
-
* "latitude": 40.712776,
|
|
1383
|
-
* "longitude": -74.005974
|
|
1384
|
-
* }
|
|
1385
|
-
* }
|
|
1552
|
+
* MeasurementAsDouble
|
|
1553
|
+
* @description measurement as double
|
|
1386
1554
|
*/
|
|
1387
|
-
'
|
|
1388
|
-
/**
|
|
1389
|
-
|
|
1390
|
-
|
|
1391
|
-
|
|
1392
|
-
paired?: boolean;
|
|
1393
|
-
/**
|
|
1394
|
-
* Format: date-time
|
|
1395
|
-
* @description The timestamp when the equipment was paired.
|
|
1396
|
-
* @example 2023-10-01T12:00:00Z
|
|
1397
|
-
*/
|
|
1398
|
-
associationTimestamp?: string;
|
|
1399
|
-
/**
|
|
1400
|
-
* Format: date-time
|
|
1401
|
-
* @description The timestamp when the equipment was un-paired.
|
|
1402
|
-
* @example 2023-10-02T12:00:00Z
|
|
1403
|
-
*/
|
|
1404
|
-
disassociationTimestamp?: string;
|
|
1555
|
+
measurementAsDouble: components['schemas']['abstractMeasurement'] & {
|
|
1556
|
+
/** @description type of measurement */
|
|
1557
|
+
type?: string;
|
|
1558
|
+
/** @description unit of measurement */
|
|
1559
|
+
unit?: string;
|
|
1405
1560
|
/**
|
|
1406
|
-
* Format:
|
|
1407
|
-
* @description
|
|
1408
|
-
* @example 2023-10-01T12:30:00Z
|
|
1561
|
+
* Format: double
|
|
1562
|
+
* @description measurement value as double
|
|
1409
1563
|
*/
|
|
1410
|
-
|
|
1411
|
-
location?: components['schemas']['point'];
|
|
1564
|
+
valueAsDouble?: number;
|
|
1412
1565
|
};
|
|
1413
1566
|
/**
|
|
1414
|
-
*
|
|
1415
|
-
* @description
|
|
1416
|
-
* @example {
|
|
1417
|
-
* "@type": "Device",
|
|
1418
|
-
* "serialNumber": "PCMA4GF511111",
|
|
1419
|
-
* "make": {
|
|
1420
|
-
* "name": "JOHN DEERE",
|
|
1421
|
-
* "id": "1",
|
|
1422
|
-
* "ERID": "f8b43e74-3088-4a38-9d66-30aae1ed1111"
|
|
1423
|
-
* },
|
|
1424
|
-
* "type": {
|
|
1425
|
-
* "name": "Modem",
|
|
1426
|
-
* "commonName": "TelematicsGateway",
|
|
1427
|
-
* "id": "1",
|
|
1428
|
-
* "ERID": "d469a324-2036-11ee-bb58-0e5cd6a91111"
|
|
1429
|
-
* },
|
|
1430
|
-
* "model": {
|
|
1431
|
-
* "name": "JDLink Modem-4G",
|
|
1432
|
-
* "id": "3",
|
|
1433
|
-
* "ERID": "f413bba6-9f39-410c-866f-c800bf701111"
|
|
1434
|
-
* },
|
|
1435
|
-
* "firmwareVersion": {
|
|
1436
|
-
* "name": "40.02.049"
|
|
1437
|
-
* },
|
|
1438
|
-
* "organization": {
|
|
1439
|
-
* "id": "21111"
|
|
1440
|
-
* },
|
|
1441
|
-
* "organizationRole": {
|
|
1442
|
-
* "type": "Controlling",
|
|
1443
|
-
* "effectiveTS": "2024-04-30T17:53:57Z",
|
|
1444
|
-
* "event": "PAIRING"
|
|
1445
|
-
* },
|
|
1446
|
-
* "archived": false,
|
|
1447
|
-
* "decommissioned": false,
|
|
1448
|
-
* "stolen": false,
|
|
1449
|
-
* "principalId": "911111",
|
|
1450
|
-
* "equipment": {
|
|
1451
|
-
* "name": "Cattle 9700 SPFH",
|
|
1452
|
-
* "serialNumber": "1Z09700YAKU621111",
|
|
1453
|
-
* "isSerialNumberCertified": true,
|
|
1454
|
-
* "modelYear": "2019",
|
|
1455
|
-
* "make": {
|
|
1456
|
-
* "name": "JOHN DEERE",
|
|
1457
|
-
* "certified": true,
|
|
1458
|
-
* "deereOrSubsidiary": true,
|
|
1459
|
-
* "id": "1",
|
|
1460
|
-
* "ERID": "db18bdc4-025a-11eb-97e4-0e8d658c1111"
|
|
1461
|
-
* },
|
|
1462
|
-
* "type": {
|
|
1463
|
-
* "name": "Forage Harvester",
|
|
1464
|
-
* "id": "162",
|
|
1465
|
-
* "ERID": "34b07db5-11fb-11ee-8580-0ed5f7261111"
|
|
1466
|
-
* },
|
|
1467
|
-
* "isgType": {
|
|
1468
|
-
* "name": "Forage Harvester",
|
|
1469
|
-
* "id": "6",
|
|
1470
|
-
* "ERID": "99edf0e0-4abb-42d3-9798-327439a31111"
|
|
1471
|
-
* },
|
|
1472
|
-
* "model": {
|
|
1473
|
-
* "name": 9700,
|
|
1474
|
-
* "certified": true,
|
|
1475
|
-
* "id": "581111",
|
|
1476
|
-
* "ERID": "2c8c951e-070a-4e1c-824d-72cca6e71111"
|
|
1477
|
-
* },
|
|
1478
|
-
* "principalId": "661111",
|
|
1479
|
-
* "archived": false,
|
|
1480
|
-
* "organization": {
|
|
1481
|
-
* "id": "22967"
|
|
1482
|
-
* },
|
|
1483
|
-
* "organizationRole": {
|
|
1484
|
-
* "type": "Controlling",
|
|
1485
|
-
* "effectiveTS": "2024-04-30T17:53:56.695Z",
|
|
1486
|
-
* "event": "PAIRING"
|
|
1487
|
-
* },
|
|
1488
|
-
* "isCsc": false,
|
|
1489
|
-
* "id": "661111",
|
|
1490
|
-
* "ERID": "23fe3ea0-1f95-4ae6-8e12-968729cd1111"
|
|
1491
|
-
* },
|
|
1492
|
-
* "capabilities": [
|
|
1493
|
-
* {
|
|
1494
|
-
* "type": "JDLINK_CONNECTIVITY",
|
|
1495
|
-
* "capable": true
|
|
1496
|
-
* },
|
|
1497
|
-
* {
|
|
1498
|
-
* "type": "WIFI_CONNECTIVITY",
|
|
1499
|
-
* "capable": true
|
|
1500
|
-
* }
|
|
1501
|
-
* ],
|
|
1502
|
-
* "pairingDetails": {
|
|
1503
|
-
* "paired": true,
|
|
1504
|
-
* "associationTimestamp": "2024-09-28T17:30:24Z",
|
|
1505
|
-
* "disassociationTimestamp": null,
|
|
1506
|
-
* "confirmationTimestamp": "2024-10-23T22:17:22Z",
|
|
1507
|
-
* "location": {
|
|
1508
|
-
* "lat": 52.780639,
|
|
1509
|
-
* "lon": -122.453222,
|
|
1510
|
-
* "slope": null
|
|
1511
|
-
* }
|
|
1512
|
-
* },
|
|
1513
|
-
* "messagesRestricted": false,
|
|
1514
|
-
* "pairingStatus": "PAIRED",
|
|
1515
|
-
* "orderNumber": "961111",
|
|
1516
|
-
* "highFidelityConfigurationVersion": {
|
|
1517
|
-
* "name": "1Hz_L3X40FT4JDPS0x00_ISG_X8X9SPFH_63978_2024.008.001"
|
|
1518
|
-
* },
|
|
1519
|
-
* "genericConfigurationVersion": {
|
|
1520
|
-
* "name": "1623F1EF-62C2-4B8B-B5EA-A0FFD6EA76F8"
|
|
1521
|
-
* },
|
|
1522
|
-
* "communicationModules": [
|
|
1523
|
-
* {
|
|
1524
|
-
* "imei": "014642005101111",
|
|
1525
|
-
* "imsi": "310170835961111",
|
|
1526
|
-
* "iccid": "89011704278359691111",
|
|
1527
|
-
* "type": "GSM",
|
|
1528
|
-
* "serviceProvider": "Jasper",
|
|
1529
|
-
* "state": "Active",
|
|
1530
|
-
* "id": "632111"
|
|
1531
|
-
* }
|
|
1532
|
-
* ],
|
|
1533
|
-
* "id": "915111",
|
|
1534
|
-
* "ERID": "fb537c94-14f1-11ef-871b-1287bcef1111"
|
|
1535
|
-
* }
|
|
1567
|
+
* MeasurementAsString
|
|
1568
|
+
* @description measurement as string
|
|
1536
1569
|
*/
|
|
1537
|
-
|
|
1570
|
+
measurementAsString: components['schemas']['abstractMeasurement'] & {
|
|
1571
|
+
/** @description type of measurement */
|
|
1572
|
+
type?: string;
|
|
1573
|
+
/** @description unit of measurement */
|
|
1574
|
+
unit?: string;
|
|
1575
|
+
/** @description measurement value as string */
|
|
1576
|
+
valueAsString?: string;
|
|
1577
|
+
};
|
|
1578
|
+
/**
|
|
1579
|
+
* Offsets
|
|
1580
|
+
* @description Represents the offsets of a device, including its variable and defined type representation values.
|
|
1581
|
+
*/
|
|
1582
|
+
offsets: components['schemas']['resource-embed'] & {
|
|
1538
1583
|
/**
|
|
1539
|
-
* @description
|
|
1540
|
-
* @example
|
|
1584
|
+
* @description Offsets
|
|
1585
|
+
* @example Offsets
|
|
1541
1586
|
* @enum {string}
|
|
1542
1587
|
*/
|
|
1543
|
-
'@type'?: '
|
|
1544
|
-
|
|
1545
|
-
|
|
1546
|
-
|
|
1547
|
-
|
|
1548
|
-
|
|
1549
|
-
/**
|
|
1550
|
-
* @description True if this is an official device (we have PI information about it).
|
|
1551
|
-
* @example true
|
|
1552
|
-
*/
|
|
1553
|
-
isSerialNumberCertified?: boolean;
|
|
1554
|
-
make?: components['schemas']['device-make'];
|
|
1555
|
-
type?: components['schemas']['device-type'];
|
|
1556
|
-
model?: components['schemas']['device-model'];
|
|
1557
|
-
organization?: components['schemas']['organization-embed'];
|
|
1558
|
-
/**
|
|
1559
|
-
* @description Unique identifier of the Device.
|
|
1560
|
-
* @example fcdc83cb-8840-4215-84b5-1769889db932
|
|
1561
|
-
*/
|
|
1562
|
-
ERID?: string;
|
|
1563
|
-
firmwareVersion?: components['schemas']['version'];
|
|
1564
|
-
capabilities?: components['schemas']['capability'][];
|
|
1565
|
-
equipment?: components['schemas']['equipment'];
|
|
1566
|
-
/**
|
|
1567
|
-
* @description Indicates if the device is archived.
|
|
1568
|
-
* @example true
|
|
1569
|
-
*/
|
|
1570
|
-
archived?: boolean;
|
|
1571
|
-
/**
|
|
1572
|
-
* @description Indicates if the device is decommissioned.
|
|
1573
|
-
* @example false
|
|
1574
|
-
*/
|
|
1575
|
-
decommissioned?: boolean;
|
|
1576
|
-
/**
|
|
1577
|
-
* @description Indicates if the device is stolen.
|
|
1578
|
-
* @example false
|
|
1579
|
-
*/
|
|
1580
|
-
stolen?: boolean;
|
|
1581
|
-
/**
|
|
1582
|
-
* @description Unique id for principal device
|
|
1583
|
-
* @example 12345
|
|
1584
|
-
*/
|
|
1585
|
-
principalId?: string;
|
|
1586
|
-
organizationRole?: components['schemas']['organization-role'];
|
|
1588
|
+
'@type'?: 'Offsets';
|
|
1589
|
+
variableRepresentationValues?: components['schemas']['variableRepresentationValue'][];
|
|
1590
|
+
definedTypeRepresentationValues?: components['schemas']['definedTypeRepresentationValue'][];
|
|
1591
|
+
};
|
|
1592
|
+
/** Resource */
|
|
1593
|
+
'organization-embed': {
|
|
1587
1594
|
/**
|
|
1588
|
-
* @description
|
|
1589
|
-
* @example
|
|
1595
|
+
* @description Unique id
|
|
1596
|
+
* @example 363997 | fcdc83cb-8840-4215-84b5-1769889db932
|
|
1590
1597
|
*/
|
|
1591
|
-
|
|
1592
|
-
pairingDetails?: components['schemas']['pairing-details'];
|
|
1598
|
+
id?: string;
|
|
1593
1599
|
/**
|
|
1594
|
-
*
|
|
1595
|
-
* @
|
|
1596
|
-
* @example 2021-03-10T19:19:46.420Z
|
|
1600
|
+
* @description Resource
|
|
1601
|
+
* @example Resource
|
|
1597
1602
|
*/
|
|
1598
|
-
|
|
1603
|
+
'@type'?: string;
|
|
1599
1604
|
};
|
|
1600
|
-
/**
|
|
1601
|
-
|
|
1605
|
+
/**
|
|
1606
|
+
* OrganizationRole
|
|
1607
|
+
* @description Represents the role of an organization, including its type, effective timestamp, and event.
|
|
1608
|
+
* @example {
|
|
1609
|
+
* "type": "Controlling",
|
|
1610
|
+
* "effectiveTS": "2023-10-01T12:00:00Z",
|
|
1611
|
+
* "event": "CREATION"
|
|
1612
|
+
* }
|
|
1613
|
+
*/
|
|
1614
|
+
'organization-role': {
|
|
1602
1615
|
/**
|
|
1603
|
-
* @description
|
|
1604
|
-
* @example
|
|
1616
|
+
* @description The type of the organization role.
|
|
1617
|
+
* @example Controlling
|
|
1605
1618
|
* @enum {string}
|
|
1606
1619
|
*/
|
|
1607
|
-
|
|
1608
|
-
monitors?: components['schemas']['display-monitors'][];
|
|
1609
|
-
};
|
|
1610
|
-
/** Monitor */
|
|
1611
|
-
'display-monitors': components['schemas']['resource-embed'] & {
|
|
1620
|
+
type?: 'Controlling' | 'NonControlling';
|
|
1612
1621
|
/**
|
|
1613
|
-
*
|
|
1614
|
-
* @
|
|
1622
|
+
* Format: date-time
|
|
1623
|
+
* @description The timestamp when the role becomes effective.
|
|
1624
|
+
* @example 2023-10-01T12:00:00Z
|
|
1625
|
+
*/
|
|
1626
|
+
effectiveTS?: string;
|
|
1627
|
+
/**
|
|
1628
|
+
* @description The event associated with the organization role.
|
|
1629
|
+
* @example CREATION
|
|
1615
1630
|
* @enum {string}
|
|
1616
1631
|
*/
|
|
1617
|
-
'
|
|
1618
|
-
/** @example
|
|
1619
|
-
|
|
1620
|
-
/** @example PCG410A015392 */
|
|
1621
|
-
serialNumber?: string;
|
|
1622
|
-
/** @example 800 */
|
|
1623
|
-
resolutionWidth?: number;
|
|
1624
|
-
/** @example 600 */
|
|
1625
|
-
resolutionHeight?: number;
|
|
1632
|
+
event?: 'CREATION' | 'TRANSFER' | 'SUBSCRIPTION' | 'PAIRING' | 'ORDER' | 'COMMANDED' | 'DECOMMISSION';
|
|
1633
|
+
/** @example true */
|
|
1634
|
+
inPossession?: boolean;
|
|
1626
1635
|
};
|
|
1627
|
-
/** PositionReceiver */
|
|
1628
|
-
'position-receiver': components['schemas']['device'] & Record<string, never>;
|
|
1629
1636
|
/**
|
|
1630
|
-
*
|
|
1631
|
-
* @description Represents
|
|
1637
|
+
* PairingDetails
|
|
1638
|
+
* @description Represents the details of the pairing process, including timestamps and location.
|
|
1632
1639
|
* @example {
|
|
1633
|
-
* "
|
|
1634
|
-
* "
|
|
1635
|
-
* "
|
|
1636
|
-
* "
|
|
1637
|
-
* "
|
|
1638
|
-
*
|
|
1639
|
-
*
|
|
1640
|
-
*
|
|
1641
|
-
* "state": "ACTIVE",
|
|
1642
|
-
* "countryCallingCode": 1
|
|
1640
|
+
* "paired": true,
|
|
1641
|
+
* "associationTimestamp": "2023-10-01T12:00:00Z",
|
|
1642
|
+
* "disassociationTimestamp": "2023-10-02T12:00:00Z",
|
|
1643
|
+
* "confirmationTimestamp": "2023-10-01T12:30:00Z",
|
|
1644
|
+
* "location": {
|
|
1645
|
+
* "latitude": 40.712776,
|
|
1646
|
+
* "longitude": -74.005974
|
|
1647
|
+
* }
|
|
1643
1648
|
* }
|
|
1644
1649
|
*/
|
|
1645
|
-
'
|
|
1646
|
-
/**
|
|
1647
|
-
* @description CommunicationModule
|
|
1648
|
-
* @example CommunicationModule
|
|
1649
|
-
* @enum {string}
|
|
1650
|
-
*/
|
|
1651
|
-
'@type'?: 'CommunicationModule';
|
|
1650
|
+
'pairing-details': {
|
|
1652
1651
|
/**
|
|
1653
|
-
* @description
|
|
1654
|
-
* @example
|
|
1652
|
+
* @description Indicates if the equipment is paired.
|
|
1653
|
+
* @example true
|
|
1655
1654
|
*/
|
|
1656
|
-
|
|
1655
|
+
paired?: boolean;
|
|
1657
1656
|
/**
|
|
1658
|
-
*
|
|
1659
|
-
* @
|
|
1657
|
+
* Format: date-time
|
|
1658
|
+
* @description The timestamp when the equipment was paired.
|
|
1659
|
+
* @example 2023-10-01T12:00:00Z
|
|
1660
1660
|
*/
|
|
1661
|
-
|
|
1661
|
+
associationTimestamp?: string;
|
|
1662
1662
|
/**
|
|
1663
|
-
*
|
|
1664
|
-
* @
|
|
1663
|
+
* Format: date-time
|
|
1664
|
+
* @description The timestamp when the equipment was un-paired.
|
|
1665
|
+
* @example 2023-10-02T12:00:00Z
|
|
1665
1666
|
*/
|
|
1666
|
-
|
|
1667
|
+
disassociationTimestamp?: string;
|
|
1667
1668
|
/**
|
|
1668
|
-
*
|
|
1669
|
-
* @
|
|
1669
|
+
* Format: date-time
|
|
1670
|
+
* @description The timestamp when the pairing was confirmed.
|
|
1671
|
+
* @example 2023-10-01T12:30:00Z
|
|
1670
1672
|
*/
|
|
1671
|
-
|
|
1673
|
+
confirmationTimestamp?: string;
|
|
1674
|
+
location?: components['schemas']['point'];
|
|
1675
|
+
};
|
|
1676
|
+
/** Point */
|
|
1677
|
+
point: {
|
|
1678
|
+
/** Format: double */
|
|
1679
|
+
lat?: number;
|
|
1680
|
+
/** Format: double */
|
|
1681
|
+
lon?: number;
|
|
1682
|
+
/** Format: double */
|
|
1683
|
+
slope?: number;
|
|
1684
|
+
};
|
|
1685
|
+
/** PositionReceiver */
|
|
1686
|
+
'position-receiver': components['schemas']['device'] & Record<string, never>;
|
|
1687
|
+
/** Resource */
|
|
1688
|
+
resource: {
|
|
1689
|
+
links?: components['schemas']['link'][];
|
|
1672
1690
|
/**
|
|
1673
|
-
* @description
|
|
1674
|
-
* @example
|
|
1691
|
+
* @description Unique id
|
|
1692
|
+
* @example 363997 | fcdc83cb-8840-4215-84b5-1769889db932
|
|
1675
1693
|
*/
|
|
1676
|
-
|
|
1694
|
+
id?: string;
|
|
1677
1695
|
/**
|
|
1678
|
-
* @description
|
|
1679
|
-
* @example
|
|
1696
|
+
* @description Equipment | Machine | Implement | MachineCharacteristics | ImplementCharacteristics | EquipmentType | EquipmentMake | EquipmentModel | Organization | TheftRecord | DecommissionRecord | WarrantyInformation | DeviceParameter | Other
|
|
1697
|
+
* @example Equipment | Machine | Implement | MachineCharacteristics | ImplementCharacteristics | EquipmentType | EquipmentMake | EquipmentModel | Organization | TheftRecord | DecommissionRecord | WarrantyInformation | DeviceParameter | Other
|
|
1680
1698
|
*/
|
|
1681
|
-
|
|
1699
|
+
'@type'?: string;
|
|
1700
|
+
};
|
|
1701
|
+
/** Resource */
|
|
1702
|
+
'resource-embed': {
|
|
1682
1703
|
/**
|
|
1683
|
-
* @description
|
|
1684
|
-
* @example
|
|
1685
|
-
* @enum {string}
|
|
1704
|
+
* @description Unique id
|
|
1705
|
+
* @example 363997 | fcdc83cb-8840-4215-84b5-1769889db932
|
|
1686
1706
|
*/
|
|
1687
|
-
|
|
1707
|
+
id?: string;
|
|
1688
1708
|
/**
|
|
1689
|
-
* @
|
|
1690
|
-
* @
|
|
1709
|
+
* @description Equipment | Machine | Implement | EquipmentType | EquipmentMake | EquipmentModel | Organization | TheftRecord | DecommissionRecord | WarrantyInformation | DeviceParameter | Other
|
|
1710
|
+
* @example Equipment | Machine | Implement | EquipmentType | EquipmentMake | EquipmentModel | Organization | TheftRecord | DecommissionRecord | WarrantyInformation | DeviceParameter | Other
|
|
1691
1711
|
*/
|
|
1692
|
-
|
|
1712
|
+
'@type'?: string;
|
|
1713
|
+
};
|
|
1714
|
+
/** Resource */
|
|
1715
|
+
resourcewithoutLinks: {
|
|
1693
1716
|
/**
|
|
1694
|
-
* @description
|
|
1695
|
-
* @example
|
|
1696
|
-
* @enum {string}
|
|
1717
|
+
* @description Unique id
|
|
1718
|
+
* @example 363997 | fcdc83cb-8840-4215-84b5-1769889db932
|
|
1697
1719
|
*/
|
|
1698
|
-
|
|
1720
|
+
id?: string;
|
|
1699
1721
|
/**
|
|
1700
|
-
* @description
|
|
1701
|
-
* @example
|
|
1722
|
+
* @description Equipment | Machine | Implement | EquipmentType | EquipmentMake | EquipmentModel | Organization | TheftRecord | DecommissionRecord | WarrantyInformation | DeviceParameter | Other
|
|
1723
|
+
* @example Equipment | Machine | Implement | EquipmentType | EquipmentMake | EquipmentModel | Organization | TheftRecord | DecommissionRecord | WarrantyInformation | DeviceParameter | Other
|
|
1702
1724
|
*/
|
|
1703
|
-
|
|
1725
|
+
'@type'?: string;
|
|
1704
1726
|
};
|
|
1705
1727
|
/** TelematicsGateway */
|
|
1706
1728
|
'telematics-gateway': components['schemas']['device'] & {
|
|
@@ -1712,73 +1734,80 @@ export interface components {
|
|
|
1712
1734
|
messagesRestricted?: boolean;
|
|
1713
1735
|
communicationModules?: components['schemas']['communication-module'][];
|
|
1714
1736
|
};
|
|
1715
|
-
/**
|
|
1716
|
-
|
|
1717
|
-
|
|
1718
|
-
};
|
|
1719
|
-
/** Machine */
|
|
1720
|
-
machine: components['schemas']['equipment'] & {
|
|
1721
|
-
implements?: components['schemas']['implement'][];
|
|
1722
|
-
};
|
|
1723
|
-
/** PatchDTO */
|
|
1724
|
-
'equipment-patch': {
|
|
1725
|
-
/** @enum {string} */
|
|
1726
|
-
operation?: 'UPDATE';
|
|
1727
|
-
/** @enum {string} */
|
|
1728
|
-
path?: '/organization' | '/archived' | '/organizationRole/type' | '/name';
|
|
1729
|
-
/** @description - For transfer request : value={organizationId} - For archive/unarchive request : value=true/false - For role update request : value={Controlling} - For name update request : value={name} */
|
|
1730
|
-
value?: string;
|
|
1737
|
+
/** VariableRepresentationValue */
|
|
1738
|
+
variableRepresentationValue: {
|
|
1739
|
+
variable?: components['schemas']['measurementAsDouble'];
|
|
1731
1740
|
};
|
|
1732
|
-
/**
|
|
1733
|
-
|
|
1734
|
-
|
|
1735
|
-
|
|
1736
|
-
|
|
1737
|
-
|
|
1738
|
-
|
|
1741
|
+
/**
|
|
1742
|
+
* Version
|
|
1743
|
+
* @description Represents the version of a device or software, including its name.
|
|
1744
|
+
* @example {
|
|
1745
|
+
* "name": "3.16.1171"
|
|
1746
|
+
* }
|
|
1747
|
+
*/
|
|
1748
|
+
version: components['schemas']['resource-embed'] & {
|
|
1739
1749
|
/**
|
|
1740
|
-
* @description
|
|
1741
|
-
* @example
|
|
1750
|
+
* @description Version
|
|
1751
|
+
* @example Version
|
|
1752
|
+
* @enum {string}
|
|
1742
1753
|
*/
|
|
1743
|
-
|
|
1754
|
+
'@type'?: 'Version';
|
|
1744
1755
|
/**
|
|
1745
|
-
*
|
|
1746
|
-
* @
|
|
1756
|
+
* @description The name of the version.
|
|
1757
|
+
* @example 3.16.1171
|
|
1747
1758
|
*/
|
|
1748
|
-
|
|
1749
|
-
/**
|
|
1750
|
-
* @description Unique id
|
|
1751
|
-
* @example 3 | 158df9ff-334a-4e0d-86cc-3adca17a9686
|
|
1752
|
-
*/
|
|
1753
|
-
id?: string;
|
|
1754
|
-
/**
|
|
1755
|
-
* @description EquipmentModel
|
|
1756
|
-
* @example EquipmentModel
|
|
1757
|
-
*/
|
|
1758
|
-
'@type'?: string;
|
|
1759
|
-
};
|
|
1759
|
+
name?: string;
|
|
1760
1760
|
};
|
|
1761
1761
|
};
|
|
1762
1762
|
responses: {
|
|
1763
|
+
/** @description Create */
|
|
1764
|
+
CreateEquip: {
|
|
1765
|
+
headers: {
|
|
1766
|
+
[name: string]: unknown;
|
|
1767
|
+
};
|
|
1768
|
+
content: {
|
|
1769
|
+
'application/json': Record<string, never>;
|
|
1770
|
+
};
|
|
1771
|
+
};
|
|
1763
1772
|
/** @description A collection of Assets */
|
|
1764
1773
|
GetEquipment: {
|
|
1765
1774
|
headers: {
|
|
1766
1775
|
[name: string]: unknown;
|
|
1767
1776
|
};
|
|
1768
1777
|
content: {
|
|
1769
|
-
'application/json': {
|
|
1770
|
-
values?:
|
|
1771
|
-
};
|
|
1778
|
+
'application/json': {
|
|
1779
|
+
values?: components['schemas']['equipmentForList'][];
|
|
1780
|
+
};
|
|
1781
|
+
};
|
|
1782
|
+
};
|
|
1783
|
+
/** @description A collection of Assets */
|
|
1784
|
+
GetEquipmentById: {
|
|
1785
|
+
headers: {
|
|
1786
|
+
[name: string]: unknown;
|
|
1787
|
+
};
|
|
1788
|
+
content: {
|
|
1789
|
+
'application/json': {
|
|
1790
|
+
values?: components['schemas']['equipment'][];
|
|
1791
|
+
};
|
|
1792
|
+
};
|
|
1793
|
+
};
|
|
1794
|
+
/** @description A collection of Assets */
|
|
1795
|
+
GetEquipmentByMakeId: {
|
|
1796
|
+
headers: {
|
|
1797
|
+
[name: string]: unknown;
|
|
1798
|
+
};
|
|
1799
|
+
content: {
|
|
1800
|
+
'application/json': Record<string, never>;
|
|
1772
1801
|
};
|
|
1773
1802
|
};
|
|
1774
1803
|
/** @description A collection of Assets */
|
|
1775
|
-
|
|
1804
|
+
GetEquipmentMake: {
|
|
1776
1805
|
headers: {
|
|
1777
1806
|
[name: string]: unknown;
|
|
1778
1807
|
};
|
|
1779
1808
|
content: {
|
|
1780
1809
|
'application/json': {
|
|
1781
|
-
values?: unknown
|
|
1810
|
+
values?: unknown;
|
|
1782
1811
|
};
|
|
1783
1812
|
};
|
|
1784
1813
|
};
|
|
@@ -1804,21 +1833,8 @@ export interface components {
|
|
|
1804
1833
|
};
|
|
1805
1834
|
};
|
|
1806
1835
|
};
|
|
1807
|
-
/** Equipment Creation */
|
|
1808
|
-
UpdateEquipment: {
|
|
1809
|
-
headers: {
|
|
1810
|
-
[name: string]: unknown;
|
|
1811
|
-
};
|
|
1812
|
-
content?: never;
|
|
1813
|
-
};
|
|
1814
|
-
examples: {
|
|
1815
|
-
headers: {
|
|
1816
|
-
[name: string]: unknown;
|
|
1817
|
-
};
|
|
1818
|
-
content?: never;
|
|
1819
|
-
};
|
|
1820
1836
|
/** @description A collection of Assets */
|
|
1821
|
-
|
|
1837
|
+
GetEquipmentTypeByEquipmentMakeIdAndEquipmentTypeId: {
|
|
1822
1838
|
headers: {
|
|
1823
1839
|
[name: string]: unknown;
|
|
1824
1840
|
};
|
|
@@ -1829,7 +1845,7 @@ export interface components {
|
|
|
1829
1845
|
};
|
|
1830
1846
|
};
|
|
1831
1847
|
/** @description A collection of Assets */
|
|
1832
|
-
|
|
1848
|
+
GetEquipmentTypes: {
|
|
1833
1849
|
headers: {
|
|
1834
1850
|
[name: string]: unknown;
|
|
1835
1851
|
};
|
|
@@ -1846,28 +1862,15 @@ export interface components {
|
|
|
1846
1862
|
'application/json': Record<string, never>;
|
|
1847
1863
|
};
|
|
1848
1864
|
};
|
|
1849
|
-
/**
|
|
1850
|
-
|
|
1851
|
-
headers: {
|
|
1852
|
-
[name: string]: unknown;
|
|
1853
|
-
};
|
|
1854
|
-
content: {
|
|
1855
|
-
'application/json': Record<string, never>;
|
|
1856
|
-
};
|
|
1857
|
-
};
|
|
1858
|
-
/** @description A collection of Assets */
|
|
1859
|
-
GetEquipmentTypeByEquipmentMakeIdAndEquipmentTypeId: {
|
|
1865
|
+
/** Equipment Creation */
|
|
1866
|
+
UpdateEquipment: {
|
|
1860
1867
|
headers: {
|
|
1861
1868
|
[name: string]: unknown;
|
|
1862
1869
|
};
|
|
1863
|
-
content
|
|
1864
|
-
'application/json': {
|
|
1865
|
-
values?: unknown;
|
|
1866
|
-
};
|
|
1867
|
-
};
|
|
1870
|
+
content?: never;
|
|
1868
1871
|
};
|
|
1869
|
-
/** @description
|
|
1870
|
-
|
|
1872
|
+
/** @description Update */
|
|
1873
|
+
UpdatedEquip: {
|
|
1871
1874
|
headers: {
|
|
1872
1875
|
[name: string]: unknown;
|
|
1873
1876
|
};
|
|
@@ -1875,66 +1878,24 @@ export interface components {
|
|
|
1875
1878
|
'application/json': Record<string, never>;
|
|
1876
1879
|
};
|
|
1877
1880
|
};
|
|
1878
|
-
|
|
1879
|
-
UpdatedEquip: {
|
|
1881
|
+
examples: {
|
|
1880
1882
|
headers: {
|
|
1881
1883
|
[name: string]: unknown;
|
|
1882
1884
|
};
|
|
1883
|
-
content
|
|
1884
|
-
'application/json': Record<string, never>;
|
|
1885
|
-
};
|
|
1885
|
+
content?: never;
|
|
1886
1886
|
};
|
|
1887
1887
|
};
|
|
1888
1888
|
parameters: {
|
|
1889
|
-
/** @description List of embed data for the Equipment ISG Type */
|
|
1890
|
-
embed: 'equipmentModels' | 'recordMetadata';
|
|
1891
|
-
/** @description Optional query parameter that controls which records are returned based on the record's deprecated flag: parameter set to false: Return only non-deprecated records query parameter not present: both deprecated and non-deprecated records returned. */
|
|
1892
|
-
deprecatedForEquipmentModels: boolean;
|
|
1893
|
-
/** @description Whether to filter isg types by the deprecated flag */
|
|
1894
|
-
deprecated: false | true | 'all';
|
|
1895
|
-
/** @description Originating system of the request */
|
|
1896
|
-
originator: string;
|
|
1897
|
-
/** @description List of OrganizationEquipment Ids (these ids are unique across all orgs) */
|
|
1898
|
-
OrganizationEquipmentIds: number[];
|
|
1899
|
-
/** @description List of serial numbers of the equipment */
|
|
1900
|
-
EquipmentSerialNumbers: string[];
|
|
1901
|
-
/** @description List of OrganizationIds */
|
|
1902
|
-
OrganizationIds: number[];
|
|
1903
|
-
/** @description List of PrincipalIds */
|
|
1904
|
-
PrincipalIds: number[];
|
|
1905
|
-
/**
|
|
1906
|
-
* @description Refers to starting record value
|
|
1907
|
-
* @example 200
|
|
1908
|
-
*/
|
|
1909
|
-
PageOffset: number;
|
|
1910
|
-
/**
|
|
1911
|
-
* @description Refers to number of items per page(default 100 max 5000)
|
|
1912
|
-
* @example 200
|
|
1913
|
-
*/
|
|
1914
|
-
ItemLimit: number;
|
|
1915
|
-
/** @example 1111 */
|
|
1916
|
-
id: number;
|
|
1917
|
-
/** @example 1234, */
|
|
1918
|
-
organizationId: number;
|
|
1919
|
-
/** @description The organization ids to get Equipment Models for. If provided, then only non-certified models will be returned. If not provided, then only certified models will be returned. */
|
|
1920
|
-
organizationIds: number[];
|
|
1921
|
-
/** @description embed 'pairingDetails' is only supported along with 'devices' or 'equipment' embeds */
|
|
1922
|
-
EmbedForList: 'devices' | 'equipment' | 'icon' | 'pairingDetails';
|
|
1923
|
-
/** @description embed 'pairingDetails' is only supported along with 'devices' or 'equipment' embeds */
|
|
1924
|
-
Embed: 'devices' | 'equipment' | 'pairingDetails' | 'icon' | 'offsets' | 'capabilities';
|
|
1925
|
-
Categories: 'Machine' | 'Implement';
|
|
1926
|
-
CapableOf: 'Connectivity' | '!Connectivity';
|
|
1927
|
-
Role: 'Controlling' | 'NonControlling';
|
|
1928
1889
|
/** @description true or false */
|
|
1929
1890
|
Archived: boolean;
|
|
1930
|
-
|
|
1931
|
-
|
|
1932
|
-
/** @description ID for Equipment Make */
|
|
1933
|
-
EquipmentMakeId: number;
|
|
1934
|
-
/** @description ID for Equipment ISG Type */
|
|
1935
|
-
EquipmentISGTypeId: number;
|
|
1891
|
+
CapableOf: 'Connectivity' | '!Connectivity';
|
|
1892
|
+
Categories: 'Machine' | 'Implement';
|
|
1936
1893
|
/** @description Deprecated value should be false */
|
|
1937
1894
|
Deprecated: boolean;
|
|
1895
|
+
/** @description embed 'pairingDetails' is only supported along with 'devices' or 'equipment' embeds */
|
|
1896
|
+
Embed: 'devices' | 'equipment' | 'pairingDetails' | 'icon' | 'offsets' | 'capabilities';
|
|
1897
|
+
/** @description embed 'pairingDetails' is only supported along with 'devices' or 'equipment' embeds */
|
|
1898
|
+
EmbedForList: 'devices' | 'equipment' | 'icon' | 'pairingDetails';
|
|
1938
1899
|
/**
|
|
1939
1900
|
* @description Embed additional attributes if required.
|
|
1940
1901
|
* @example [
|
|
@@ -1943,6 +1904,14 @@ export interface components {
|
|
|
1943
1904
|
* ]
|
|
1944
1905
|
*/
|
|
1945
1906
|
EmbedV1: 'make' | 'type' | 'isgType';
|
|
1907
|
+
/** @description ID for Equipment ISG Type */
|
|
1908
|
+
EquipmentISGTypeId: number;
|
|
1909
|
+
/** @description ID for Equipment Make */
|
|
1910
|
+
EquipmentMakeId: number;
|
|
1911
|
+
/** @description Name for Equipment Make */
|
|
1912
|
+
EquipmentMakeName: string;
|
|
1913
|
+
/** @description ID for Equipment Model */
|
|
1914
|
+
EquipmentModelId: number;
|
|
1946
1915
|
/**
|
|
1947
1916
|
* @description It should be equipment model name
|
|
1948
1917
|
* @example [
|
|
@@ -1951,16 +1920,47 @@ export interface components {
|
|
|
1951
1920
|
* ]
|
|
1952
1921
|
*/
|
|
1953
1922
|
EquipmentModelName: 'string or partial string with * wildcard search';
|
|
1923
|
+
/** @description List of serial numbers of the equipment */
|
|
1924
|
+
EquipmentSerialNumbers: string[];
|
|
1954
1925
|
/** @description ID for Equipment Type */
|
|
1955
1926
|
EquipmentTypeId: number;
|
|
1956
|
-
/** @description ID for Equipment Model */
|
|
1957
|
-
EquipmentModelId: number;
|
|
1958
|
-
/** @description List of type categories for the Equipment Model */
|
|
1959
|
-
category: 'machine' | 'implement';
|
|
1960
1927
|
/** @description Name for Equipment Type */
|
|
1961
1928
|
EquipmentTypeName: string;
|
|
1962
|
-
/**
|
|
1963
|
-
|
|
1929
|
+
/**
|
|
1930
|
+
* @description Refers to number of items per page(default 100 max 5000)
|
|
1931
|
+
* @example 200
|
|
1932
|
+
*/
|
|
1933
|
+
ItemLimit: number;
|
|
1934
|
+
/** @description List of OrganizationEquipment Ids (these ids are unique across all orgs) */
|
|
1935
|
+
OrganizationEquipmentIds: number[];
|
|
1936
|
+
/** @description List of OrganizationIds */
|
|
1937
|
+
OrganizationIds: number[];
|
|
1938
|
+
/**
|
|
1939
|
+
* @description Refers to starting record value
|
|
1940
|
+
* @example 200
|
|
1941
|
+
*/
|
|
1942
|
+
PageOffset: number;
|
|
1943
|
+
/** @description List of PrincipalIds */
|
|
1944
|
+
PrincipalIds: number[];
|
|
1945
|
+
Role: 'Controlling' | 'NonControlling';
|
|
1946
|
+
/** @example VIN1234 */
|
|
1947
|
+
SerialNumber: string;
|
|
1948
|
+
/** @description List of type categories for the Equipment Model */
|
|
1949
|
+
category: 'machine' | 'implement';
|
|
1950
|
+
/** @description Whether to filter isg types by the deprecated flag */
|
|
1951
|
+
deprecated: false | true | 'all';
|
|
1952
|
+
/** @description Optional query parameter that controls which records are returned based on the record's deprecated flag: parameter set to false: Return only non-deprecated records query parameter not present: both deprecated and non-deprecated records returned. */
|
|
1953
|
+
deprecatedForEquipmentModels: boolean;
|
|
1954
|
+
/** @description List of embed data for the Equipment ISG Type */
|
|
1955
|
+
embed: 'equipmentModels' | 'recordMetadata';
|
|
1956
|
+
/** @example 1111 */
|
|
1957
|
+
id: number;
|
|
1958
|
+
/** @example 1234, */
|
|
1959
|
+
organizationId: number;
|
|
1960
|
+
/** @description The organization ids to get Equipment Models for. If provided, then only non-certified models will be returned. If not provided, then only certified models will be returned. */
|
|
1961
|
+
organizationIds: number[];
|
|
1962
|
+
/** @description Originating system of the request */
|
|
1963
|
+
originator: string;
|
|
1964
1964
|
};
|
|
1965
1965
|
requestBodies: never;
|
|
1966
1966
|
headers: never;
|
|
@@ -1968,50 +1968,6 @@ export interface components {
|
|
|
1968
1968
|
}
|
|
1969
1969
|
export type $defs = Record<string, never>;
|
|
1970
1970
|
export interface operations {
|
|
1971
|
-
createEquipment: {
|
|
1972
|
-
parameters: {
|
|
1973
|
-
query?: never;
|
|
1974
|
-
header?: never;
|
|
1975
|
-
path: {
|
|
1976
|
-
/** @example 1234, */
|
|
1977
|
-
organizationId: components['parameters']['organizationId'];
|
|
1978
|
-
};
|
|
1979
|
-
cookie?: never;
|
|
1980
|
-
};
|
|
1981
|
-
/** @description Asset to be created. */
|
|
1982
|
-
requestBody?: {
|
|
1983
|
-
content: {
|
|
1984
|
-
'application/json': components['schemas']['createEquipment'];
|
|
1985
|
-
};
|
|
1986
|
-
};
|
|
1987
|
-
responses: {
|
|
1988
|
-
/** @description Created */
|
|
1989
|
-
201: components['responses']['CreateEquip'];
|
|
1990
|
-
/** @description Accepted */
|
|
1991
|
-
202: {
|
|
1992
|
-
headers: {
|
|
1993
|
-
[name: string]: unknown;
|
|
1994
|
-
};
|
|
1995
|
-
content?: never;
|
|
1996
|
-
};
|
|
1997
|
-
/** @description Bad Request */
|
|
1998
|
-
400: {
|
|
1999
|
-
headers: {
|
|
2000
|
-
[name: string]: unknown;
|
|
2001
|
-
};
|
|
2002
|
-
content: {
|
|
2003
|
-
'application/json': components['schemas']['Errors'];
|
|
2004
|
-
};
|
|
2005
|
-
};
|
|
2006
|
-
/** @description User is not authorized for this request. */
|
|
2007
|
-
403: {
|
|
2008
|
-
headers: {
|
|
2009
|
-
[name: string]: unknown;
|
|
2010
|
-
};
|
|
2011
|
-
content?: never;
|
|
2012
|
-
};
|
|
2013
|
-
};
|
|
2014
|
-
};
|
|
2015
1971
|
putEquipment: {
|
|
2016
1972
|
parameters: {
|
|
2017
1973
|
query?: never;
|
|
@@ -2049,111 +2005,53 @@ export interface operations {
|
|
|
2049
2005
|
};
|
|
2050
2006
|
};
|
|
2051
2007
|
};
|
|
2052
|
-
deleteEquipment: {
|
|
2053
|
-
parameters: {
|
|
2054
|
-
query?: never;
|
|
2055
|
-
header?: never;
|
|
2056
|
-
path: {
|
|
2057
|
-
/** @example 1111 */
|
|
2058
|
-
id: components['parameters']['id'];
|
|
2059
|
-
};
|
|
2060
|
-
cookie?: never;
|
|
2061
|
-
};
|
|
2062
|
-
requestBody?: never;
|
|
2063
|
-
responses: {
|
|
2064
|
-
/** @description Deleted */
|
|
2065
|
-
200: components['responses']['UpdatedEquip'];
|
|
2066
|
-
/** @description Bad Request */
|
|
2067
|
-
400: {
|
|
2068
|
-
headers: {
|
|
2069
|
-
[name: string]: unknown;
|
|
2070
|
-
};
|
|
2071
|
-
content: {
|
|
2072
|
-
'application/json': components['schemas']['Errors'];
|
|
2073
|
-
};
|
|
2074
|
-
};
|
|
2075
|
-
/** @description User is not authorized for this request. */
|
|
2076
|
-
403: {
|
|
2077
|
-
headers: {
|
|
2078
|
-
[name: string]: unknown;
|
|
2079
|
-
};
|
|
2080
|
-
content?: never;
|
|
2081
|
-
};
|
|
2082
|
-
};
|
|
2083
|
-
};
|
|
2084
|
-
getEquipmentMakes: {
|
|
2085
|
-
parameters: {
|
|
2086
|
-
query?: never;
|
|
2087
|
-
header?: never;
|
|
2088
|
-
path: {
|
|
2089
|
-
/** @description Deprecated value should be false */
|
|
2090
|
-
deprecated: components['parameters']['Deprecated'];
|
|
2091
|
-
};
|
|
2092
|
-
cookie?: never;
|
|
2093
|
-
};
|
|
2094
|
-
requestBody?: never;
|
|
2095
|
-
responses: {
|
|
2096
|
-
/** @description OK */
|
|
2097
|
-
200: components['responses']['GetEquipmentMake'];
|
|
2098
|
-
/** @description User is not authorized */
|
|
2099
|
-
403: {
|
|
2100
|
-
headers: {
|
|
2101
|
-
[name: string]: unknown;
|
|
2102
|
-
};
|
|
2103
|
-
content?: never;
|
|
2104
|
-
};
|
|
2105
|
-
};
|
|
2106
|
-
};
|
|
2107
|
-
getEquipmentMakesById: {
|
|
2008
|
+
deleteEquipment: {
|
|
2108
2009
|
parameters: {
|
|
2109
2010
|
query?: never;
|
|
2110
2011
|
header?: never;
|
|
2111
2012
|
path: {
|
|
2112
|
-
/** @
|
|
2113
|
-
|
|
2013
|
+
/** @example 1111 */
|
|
2014
|
+
id: components['parameters']['id'];
|
|
2114
2015
|
};
|
|
2115
2016
|
cookie?: never;
|
|
2116
2017
|
};
|
|
2117
2018
|
requestBody?: never;
|
|
2118
2019
|
responses: {
|
|
2119
|
-
/** @description
|
|
2120
|
-
200:
|
|
2020
|
+
/** @description Deleted */
|
|
2021
|
+
200: components['responses']['UpdatedEquip'];
|
|
2022
|
+
/** @description Bad Request */
|
|
2023
|
+
400: {
|
|
2121
2024
|
headers: {
|
|
2122
2025
|
[name: string]: unknown;
|
|
2123
2026
|
};
|
|
2124
2027
|
content: {
|
|
2125
|
-
'application/json':
|
|
2126
|
-
links?: components['schemas']['link'][];
|
|
2127
|
-
values?: components['schemas']['equipment-make'][];
|
|
2128
|
-
};
|
|
2028
|
+
'application/json': components['schemas']['Errors'];
|
|
2129
2029
|
};
|
|
2130
2030
|
};
|
|
2131
|
-
/** @description User is not authorized */
|
|
2031
|
+
/** @description User is not authorized for this request. */
|
|
2132
2032
|
403: {
|
|
2133
2033
|
headers: {
|
|
2134
2034
|
[name: string]: unknown;
|
|
2135
2035
|
};
|
|
2136
2036
|
content?: never;
|
|
2137
2037
|
};
|
|
2138
|
-
/** @description Resource Not foundapi-makes */
|
|
2139
|
-
404: {
|
|
2140
|
-
headers: {
|
|
2141
|
-
[name: string]: unknown;
|
|
2142
|
-
};
|
|
2143
|
-
content?: never;
|
|
2144
|
-
};
|
|
2145
2038
|
};
|
|
2146
2039
|
};
|
|
2147
|
-
|
|
2040
|
+
getEquipmentISGTypes: {
|
|
2148
2041
|
parameters: {
|
|
2149
|
-
query?:
|
|
2150
|
-
|
|
2151
|
-
|
|
2152
|
-
/** @description
|
|
2153
|
-
|
|
2154
|
-
/** @description
|
|
2155
|
-
|
|
2042
|
+
query?: {
|
|
2043
|
+
/** @description List of type categories for the Equipment Model */
|
|
2044
|
+
category?: components['parameters']['category'];
|
|
2045
|
+
/** @description Whether to filter isg types by the deprecated flag */
|
|
2046
|
+
deprecated?: components['parameters']['deprecated'];
|
|
2047
|
+
/** @description List of embed data for the Equipment ISG Type */
|
|
2048
|
+
embed?: components['parameters']['embed'];
|
|
2049
|
+
};
|
|
2050
|
+
header?: {
|
|
2051
|
+
/** @description Originating system of the request */
|
|
2052
|
+
'X-Deere-Originator'?: components['parameters']['originator'];
|
|
2156
2053
|
};
|
|
2054
|
+
path?: never;
|
|
2157
2055
|
cookie?: never;
|
|
2158
2056
|
};
|
|
2159
2057
|
requestBody?: never;
|
|
@@ -2166,13 +2064,13 @@ export interface operations {
|
|
|
2166
2064
|
content: {
|
|
2167
2065
|
'application/json': {
|
|
2168
2066
|
links?: components['schemas']['link'][];
|
|
2169
|
-
values?: components['schemas']['equipment-type'][];
|
|
2067
|
+
values?: components['schemas']['equipment-isg-type'][];
|
|
2170
2068
|
};
|
|
2171
2069
|
};
|
|
2172
2070
|
};
|
|
2173
2071
|
};
|
|
2174
2072
|
};
|
|
2175
|
-
|
|
2073
|
+
getEquipmentMakes: {
|
|
2176
2074
|
parameters: {
|
|
2177
2075
|
query?: never;
|
|
2178
2076
|
header?: never;
|
|
@@ -2185,67 +2083,24 @@ export interface operations {
|
|
|
2185
2083
|
requestBody?: never;
|
|
2186
2084
|
responses: {
|
|
2187
2085
|
/** @description OK */
|
|
2188
|
-
200:
|
|
2086
|
+
200: components['responses']['GetEquipmentMake'];
|
|
2087
|
+
/** @description User is not authorized */
|
|
2088
|
+
403: {
|
|
2189
2089
|
headers: {
|
|
2190
2090
|
[name: string]: unknown;
|
|
2191
2091
|
};
|
|
2192
|
-
content
|
|
2193
|
-
'application/json': {
|
|
2194
|
-
links?: components['schemas']['link'][];
|
|
2195
|
-
values?: components['schemas']['equipment-type'][];
|
|
2196
|
-
};
|
|
2197
|
-
};
|
|
2092
|
+
content?: never;
|
|
2198
2093
|
};
|
|
2199
2094
|
};
|
|
2200
2095
|
};
|
|
2201
|
-
|
|
2096
|
+
getEquipmentMakesById: {
|
|
2202
2097
|
parameters: {
|
|
2203
|
-
query?:
|
|
2204
|
-
/**
|
|
2205
|
-
* @description Embed additional attributes if required.
|
|
2206
|
-
* @example [
|
|
2207
|
-
* "make",
|
|
2208
|
-
* "type"
|
|
2209
|
-
* ]
|
|
2210
|
-
*/
|
|
2211
|
-
embed?: components['parameters']['EmbedV1'];
|
|
2212
|
-
/**
|
|
2213
|
-
* @description It should be equipment model name
|
|
2214
|
-
* @example [
|
|
2215
|
-
* "9RX420",
|
|
2216
|
-
* "9RX*"
|
|
2217
|
-
* ]
|
|
2218
|
-
*/
|
|
2219
|
-
equipmentModelName?: components['parameters']['EquipmentModelName'];
|
|
2220
|
-
};
|
|
2098
|
+
query?: never;
|
|
2221
2099
|
header?: never;
|
|
2222
2100
|
path: {
|
|
2223
|
-
/** @description
|
|
2224
|
-
|
|
2225
|
-
};
|
|
2226
|
-
cookie?: never;
|
|
2227
|
-
};
|
|
2228
|
-
requestBody?: never;
|
|
2229
|
-
responses: {
|
|
2230
|
-
/** @description OK */
|
|
2231
|
-
200: components['responses']['GetEquipmentModelName'];
|
|
2232
|
-
};
|
|
2233
|
-
};
|
|
2234
|
-
getEquipmentISGTypes: {
|
|
2235
|
-
parameters: {
|
|
2236
|
-
query?: {
|
|
2237
|
-
/** @description List of type categories for the Equipment Model */
|
|
2238
|
-
category?: components['parameters']['category'];
|
|
2239
|
-
/** @description Whether to filter isg types by the deprecated flag */
|
|
2240
|
-
deprecated?: components['parameters']['deprecated'];
|
|
2241
|
-
/** @description List of embed data for the Equipment ISG Type */
|
|
2242
|
-
embed?: components['parameters']['embed'];
|
|
2243
|
-
};
|
|
2244
|
-
header?: {
|
|
2245
|
-
/** @description Originating system of the request */
|
|
2246
|
-
'X-Deere-Originator'?: components['parameters']['originator'];
|
|
2101
|
+
/** @description ID for Equipment Make */
|
|
2102
|
+
equipmentMakeId: components['parameters']['EquipmentMakeId'];
|
|
2247
2103
|
};
|
|
2248
|
-
path?: never;
|
|
2249
2104
|
cookie?: never;
|
|
2250
2105
|
};
|
|
2251
2106
|
requestBody?: never;
|
|
@@ -2258,10 +2113,24 @@ export interface operations {
|
|
|
2258
2113
|
content: {
|
|
2259
2114
|
'application/json': {
|
|
2260
2115
|
links?: components['schemas']['link'][];
|
|
2261
|
-
values?: components['schemas']['equipment-
|
|
2116
|
+
values?: components['schemas']['equipment-make'][];
|
|
2262
2117
|
};
|
|
2263
2118
|
};
|
|
2264
2119
|
};
|
|
2120
|
+
/** @description User is not authorized */
|
|
2121
|
+
403: {
|
|
2122
|
+
headers: {
|
|
2123
|
+
[name: string]: unknown;
|
|
2124
|
+
};
|
|
2125
|
+
content?: never;
|
|
2126
|
+
};
|
|
2127
|
+
/** @description Resource Not foundapi-makes */
|
|
2128
|
+
404: {
|
|
2129
|
+
headers: {
|
|
2130
|
+
[name: string]: unknown;
|
|
2131
|
+
};
|
|
2132
|
+
content?: never;
|
|
2133
|
+
};
|
|
2265
2134
|
};
|
|
2266
2135
|
};
|
|
2267
2136
|
getEquipmentISGTypesByMakeId: {
|
|
@@ -2413,5 +2282,136 @@ export interface operations {
|
|
|
2413
2282
|
};
|
|
2414
2283
|
};
|
|
2415
2284
|
};
|
|
2285
|
+
getEquipmentTypesByMakeId: {
|
|
2286
|
+
parameters: {
|
|
2287
|
+
query?: never;
|
|
2288
|
+
header?: never;
|
|
2289
|
+
path: {
|
|
2290
|
+
/** @description ID for Equipment Make */
|
|
2291
|
+
equipmentMakeId: components['parameters']['EquipmentMakeId'];
|
|
2292
|
+
/** @description Deprecated value should be false */
|
|
2293
|
+
deprecated: components['parameters']['Deprecated'];
|
|
2294
|
+
};
|
|
2295
|
+
cookie?: never;
|
|
2296
|
+
};
|
|
2297
|
+
requestBody?: never;
|
|
2298
|
+
responses: {
|
|
2299
|
+
/** @description OK */
|
|
2300
|
+
200: {
|
|
2301
|
+
headers: {
|
|
2302
|
+
[name: string]: unknown;
|
|
2303
|
+
};
|
|
2304
|
+
content: {
|
|
2305
|
+
'application/json': {
|
|
2306
|
+
links?: components['schemas']['link'][];
|
|
2307
|
+
values?: components['schemas']['equipment-type'][];
|
|
2308
|
+
};
|
|
2309
|
+
};
|
|
2310
|
+
};
|
|
2311
|
+
};
|
|
2312
|
+
};
|
|
2313
|
+
getEquipmentModels: {
|
|
2314
|
+
parameters: {
|
|
2315
|
+
query?: {
|
|
2316
|
+
/**
|
|
2317
|
+
* @description Embed additional attributes if required.
|
|
2318
|
+
* @example [
|
|
2319
|
+
* "make",
|
|
2320
|
+
* "type"
|
|
2321
|
+
* ]
|
|
2322
|
+
*/
|
|
2323
|
+
embed?: components['parameters']['EmbedV1'];
|
|
2324
|
+
/**
|
|
2325
|
+
* @description It should be equipment model name
|
|
2326
|
+
* @example [
|
|
2327
|
+
* "9RX420",
|
|
2328
|
+
* "9RX*"
|
|
2329
|
+
* ]
|
|
2330
|
+
*/
|
|
2331
|
+
equipmentModelName?: components['parameters']['EquipmentModelName'];
|
|
2332
|
+
};
|
|
2333
|
+
header?: never;
|
|
2334
|
+
path: {
|
|
2335
|
+
/** @description Deprecated value should be false */
|
|
2336
|
+
deprecated: components['parameters']['Deprecated'];
|
|
2337
|
+
};
|
|
2338
|
+
cookie?: never;
|
|
2339
|
+
};
|
|
2340
|
+
requestBody?: never;
|
|
2341
|
+
responses: {
|
|
2342
|
+
/** @description OK */
|
|
2343
|
+
200: components['responses']['GetEquipmentModelName'];
|
|
2344
|
+
};
|
|
2345
|
+
};
|
|
2346
|
+
getEquipmentTypes: {
|
|
2347
|
+
parameters: {
|
|
2348
|
+
query?: never;
|
|
2349
|
+
header?: never;
|
|
2350
|
+
path: {
|
|
2351
|
+
/** @description Deprecated value should be false */
|
|
2352
|
+
deprecated: components['parameters']['Deprecated'];
|
|
2353
|
+
};
|
|
2354
|
+
cookie?: never;
|
|
2355
|
+
};
|
|
2356
|
+
requestBody?: never;
|
|
2357
|
+
responses: {
|
|
2358
|
+
/** @description OK */
|
|
2359
|
+
200: {
|
|
2360
|
+
headers: {
|
|
2361
|
+
[name: string]: unknown;
|
|
2362
|
+
};
|
|
2363
|
+
content: {
|
|
2364
|
+
'application/json': {
|
|
2365
|
+
links?: components['schemas']['link'][];
|
|
2366
|
+
values?: components['schemas']['equipment-type'][];
|
|
2367
|
+
};
|
|
2368
|
+
};
|
|
2369
|
+
};
|
|
2370
|
+
};
|
|
2371
|
+
};
|
|
2372
|
+
createEquipment: {
|
|
2373
|
+
parameters: {
|
|
2374
|
+
query?: never;
|
|
2375
|
+
header?: never;
|
|
2376
|
+
path: {
|
|
2377
|
+
/** @example 1234, */
|
|
2378
|
+
organizationId: components['parameters']['organizationId'];
|
|
2379
|
+
};
|
|
2380
|
+
cookie?: never;
|
|
2381
|
+
};
|
|
2382
|
+
/** @description Asset to be created. */
|
|
2383
|
+
requestBody?: {
|
|
2384
|
+
content: {
|
|
2385
|
+
'application/json': components['schemas']['createEquipment'];
|
|
2386
|
+
};
|
|
2387
|
+
};
|
|
2388
|
+
responses: {
|
|
2389
|
+
/** @description Created */
|
|
2390
|
+
201: components['responses']['CreateEquip'];
|
|
2391
|
+
/** @description Accepted */
|
|
2392
|
+
202: {
|
|
2393
|
+
headers: {
|
|
2394
|
+
[name: string]: unknown;
|
|
2395
|
+
};
|
|
2396
|
+
content?: never;
|
|
2397
|
+
};
|
|
2398
|
+
/** @description Bad Request */
|
|
2399
|
+
400: {
|
|
2400
|
+
headers: {
|
|
2401
|
+
[name: string]: unknown;
|
|
2402
|
+
};
|
|
2403
|
+
content: {
|
|
2404
|
+
'application/json': components['schemas']['Errors'];
|
|
2405
|
+
};
|
|
2406
|
+
};
|
|
2407
|
+
/** @description User is not authorized for this request. */
|
|
2408
|
+
403: {
|
|
2409
|
+
headers: {
|
|
2410
|
+
[name: string]: unknown;
|
|
2411
|
+
};
|
|
2412
|
+
content?: never;
|
|
2413
|
+
};
|
|
2414
|
+
};
|
|
2415
|
+
};
|
|
2416
2416
|
}
|
|
2417
2417
|
//# sourceMappingURL=equipment.d.ts.map
|