@ignos/api-client 20261110.361.1-alpha → 20261111.363.1
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/lib/ignosportal-api.d.ts +120 -67
- package/lib/ignosportal-api.js +166 -5
- package/package.json +1 -1
- package/src/ignosportal-api.ts +277 -67
package/lib/ignosportal-api.d.ts
CHANGED
|
@@ -224,18 +224,19 @@ export interface IMachineUtilizationClient {
|
|
|
224
224
|
* @param favorites (optional)
|
|
225
225
|
* @param startTimeToday (optional) UTC offset for start of today's utilization is extracted from this value
|
|
226
226
|
* @param utcOffset (optional) Explicit UTC offset for start of today's utilization
|
|
227
|
+
* @param assetExternalId (optional)
|
|
227
228
|
*/
|
|
228
|
-
getMachineUtilizations(assetId: number | null | undefined, favorites: boolean | undefined, startTimeToday: Date | null | undefined, utcOffset: number | null | undefined): Promise<UtilizationListDto>;
|
|
229
|
-
getMachineUtilization(id:
|
|
229
|
+
getMachineUtilizations(assetId: number | null | undefined, favorites: boolean | undefined, startTimeToday: Date | null | undefined, utcOffset: number | null | undefined, assetExternalId: string | null | undefined): Promise<UtilizationListDto>;
|
|
230
|
+
getMachineUtilization(id: string, startTime: Date | undefined, endTime: Date | null | undefined): Promise<UtilizationDetailsDto>;
|
|
230
231
|
/**
|
|
231
232
|
* @param startTime (optional)
|
|
232
233
|
* @param endTime (optional)
|
|
233
234
|
* @deprecated
|
|
234
235
|
*/
|
|
235
|
-
getUtilizationDetailsForMachine(id:
|
|
236
|
-
getResourceTimelines(id:
|
|
237
|
-
listMachineStates(id:
|
|
238
|
-
getMachineStatesSummary(id:
|
|
236
|
+
getUtilizationDetailsForMachine(id: string, startTime: Date | null | undefined, endTime: Date | null | undefined): Promise<MachineStatesSummaryDto>;
|
|
237
|
+
getResourceTimelines(id: string, startTime: Date | null | undefined, endTime: Date | null | undefined, filter: TimelineFilterDto | undefined): Promise<TimelinesDto>;
|
|
238
|
+
listMachineStates(id: string, startTime: Date | null | undefined, endTime: Date | null | undefined): Promise<MachineStateDatapoint[]>;
|
|
239
|
+
getMachineStatesSummary(id: string, startTime: Date | null | undefined, endTime: Date | null | undefined): Promise<MachineStatesSummaryDto>;
|
|
239
240
|
listMachineUptimesToday(request: ListMachineUptimesTodayRequest): Promise<MachineUptimesAggregateDto>;
|
|
240
241
|
listPowerOnUtilizationDatapoints(id: number | null | undefined, externalId: string | null | undefined, nDays: number | null | undefined, startTime: Date | null | undefined, endTime: Date | null | undefined): Promise<PowerOnUtilizationList>;
|
|
241
242
|
getFactoryUtilization(): Promise<PowerOnUtilizationDto>;
|
|
@@ -258,23 +259,24 @@ export declare class MachineUtilizationClient extends AuthorizedApiBase implemen
|
|
|
258
259
|
* @param favorites (optional)
|
|
259
260
|
* @param startTimeToday (optional) UTC offset for start of today's utilization is extracted from this value
|
|
260
261
|
* @param utcOffset (optional) Explicit UTC offset for start of today's utilization
|
|
262
|
+
* @param assetExternalId (optional)
|
|
261
263
|
*/
|
|
262
|
-
getMachineUtilizations(assetId: number | null | undefined, favorites: boolean | undefined, startTimeToday: Date | null | undefined, utcOffset: number | null | undefined): Promise<UtilizationListDto>;
|
|
264
|
+
getMachineUtilizations(assetId: number | null | undefined, favorites: boolean | undefined, startTimeToday: Date | null | undefined, utcOffset: number | null | undefined, assetExternalId: string | null | undefined): Promise<UtilizationListDto>;
|
|
263
265
|
protected processGetMachineUtilizations(response: Response): Promise<UtilizationListDto>;
|
|
264
|
-
getMachineUtilization(id:
|
|
266
|
+
getMachineUtilization(id: string, startTime: Date | undefined, endTime: Date | null | undefined): Promise<UtilizationDetailsDto>;
|
|
265
267
|
protected processGetMachineUtilization(response: Response): Promise<UtilizationDetailsDto>;
|
|
266
268
|
/**
|
|
267
269
|
* @param startTime (optional)
|
|
268
270
|
* @param endTime (optional)
|
|
269
271
|
* @deprecated
|
|
270
272
|
*/
|
|
271
|
-
getUtilizationDetailsForMachine(id:
|
|
273
|
+
getUtilizationDetailsForMachine(id: string, startTime: Date | null | undefined, endTime: Date | null | undefined): Promise<MachineStatesSummaryDto>;
|
|
272
274
|
protected processGetUtilizationDetailsForMachine(response: Response): Promise<MachineStatesSummaryDto>;
|
|
273
|
-
getResourceTimelines(id:
|
|
275
|
+
getResourceTimelines(id: string, startTime: Date | null | undefined, endTime: Date | null | undefined, filter: TimelineFilterDto | undefined): Promise<TimelinesDto>;
|
|
274
276
|
protected processGetResourceTimelines(response: Response): Promise<TimelinesDto>;
|
|
275
|
-
listMachineStates(id:
|
|
277
|
+
listMachineStates(id: string, startTime: Date | null | undefined, endTime: Date | null | undefined): Promise<MachineStateDatapoint[]>;
|
|
276
278
|
protected processListMachineStates(response: Response): Promise<MachineStateDatapoint[]>;
|
|
277
|
-
getMachineStatesSummary(id:
|
|
279
|
+
getMachineStatesSummary(id: string, startTime: Date | null | undefined, endTime: Date | null | undefined): Promise<MachineStatesSummaryDto>;
|
|
278
280
|
protected processGetMachineStatesSummary(response: Response): Promise<MachineStatesSummaryDto>;
|
|
279
281
|
listMachineUptimesToday(request: ListMachineUptimesTodayRequest): Promise<MachineUptimesAggregateDto>;
|
|
280
282
|
protected processListMachineUptimesToday(response: Response): Promise<MachineUptimesAggregateDto>;
|
|
@@ -297,12 +299,13 @@ export interface IResourceUtilizationClient {
|
|
|
297
299
|
* @param favorites (optional)
|
|
298
300
|
* @param startTimeToday (optional) UTC offset for start of today's utilization is extracted from this value
|
|
299
301
|
* @param utcOffset (optional) Explicit UTC offset for start of today's utilization
|
|
302
|
+
* @param assetExternalId (optional)
|
|
300
303
|
*/
|
|
301
|
-
getResourceUtilizations(assetId: number | null | undefined, favorites: boolean | undefined, startTimeToday: Date | null | undefined, utcOffset: number | null | undefined): Promise<ResourceUtilizationListDto>;
|
|
302
|
-
getResourceUtilization(id:
|
|
303
|
-
getResourceTimelines(id:
|
|
304
|
-
listMachineStates(id:
|
|
305
|
-
getMachineStatesSummary(id:
|
|
304
|
+
getResourceUtilizations(assetId: number | null | undefined, favorites: boolean | undefined, startTimeToday: Date | null | undefined, utcOffset: number | null | undefined, assetExternalId: string | null | undefined): Promise<ResourceUtilizationListDto>;
|
|
305
|
+
getResourceUtilization(id: string, startTime: Date | undefined, endTime: Date | null | undefined): Promise<ResourceUtilizationDetailsDto>;
|
|
306
|
+
getResourceTimelines(id: string, startTime: Date | null | undefined, endTime: Date | null | undefined, filter: TimelineFilterDto | undefined): Promise<TimelinesDto>;
|
|
307
|
+
listMachineStates(id: string, startTime: Date | null | undefined, endTime: Date | null | undefined): Promise<MachineStateDatapoint[]>;
|
|
308
|
+
getMachineStatesSummary(id: string, startTime: Date | null | undefined, endTime: Date | null | undefined): Promise<MachineStatesSummaryDto>;
|
|
306
309
|
listResourceUptimesToday(request: ListResourceUptimesTodayRequest): Promise<ResourceUptimesAggregateDto>;
|
|
307
310
|
listPowerOnUtilizationDatapoints(id: number | null | undefined, externalId: string | null | undefined, nDays: number | null | undefined, startTime: Date | null | undefined, endTime: Date | null | undefined): Promise<PowerOnUtilizationList>;
|
|
308
311
|
getFactoryUtilization(): Promise<PowerOnUtilizationDto>;
|
|
@@ -325,16 +328,17 @@ export declare class ResourceUtilizationClient extends AuthorizedApiBase impleme
|
|
|
325
328
|
* @param favorites (optional)
|
|
326
329
|
* @param startTimeToday (optional) UTC offset for start of today's utilization is extracted from this value
|
|
327
330
|
* @param utcOffset (optional) Explicit UTC offset for start of today's utilization
|
|
331
|
+
* @param assetExternalId (optional)
|
|
328
332
|
*/
|
|
329
|
-
getResourceUtilizations(assetId: number | null | undefined, favorites: boolean | undefined, startTimeToday: Date | null | undefined, utcOffset: number | null | undefined): Promise<ResourceUtilizationListDto>;
|
|
333
|
+
getResourceUtilizations(assetId: number | null | undefined, favorites: boolean | undefined, startTimeToday: Date | null | undefined, utcOffset: number | null | undefined, assetExternalId: string | null | undefined): Promise<ResourceUtilizationListDto>;
|
|
330
334
|
protected processGetResourceUtilizations(response: Response): Promise<ResourceUtilizationListDto>;
|
|
331
|
-
getResourceUtilization(id:
|
|
335
|
+
getResourceUtilization(id: string, startTime: Date | undefined, endTime: Date | null | undefined): Promise<ResourceUtilizationDetailsDto>;
|
|
332
336
|
protected processGetResourceUtilization(response: Response): Promise<ResourceUtilizationDetailsDto>;
|
|
333
|
-
getResourceTimelines(id:
|
|
337
|
+
getResourceTimelines(id: string, startTime: Date | null | undefined, endTime: Date | null | undefined, filter: TimelineFilterDto | undefined): Promise<TimelinesDto>;
|
|
334
338
|
protected processGetResourceTimelines(response: Response): Promise<TimelinesDto>;
|
|
335
|
-
listMachineStates(id:
|
|
339
|
+
listMachineStates(id: string, startTime: Date | null | undefined, endTime: Date | null | undefined): Promise<MachineStateDatapoint[]>;
|
|
336
340
|
protected processListMachineStates(response: Response): Promise<MachineStateDatapoint[]>;
|
|
337
|
-
getMachineStatesSummary(id:
|
|
341
|
+
getMachineStatesSummary(id: string, startTime: Date | null | undefined, endTime: Date | null | undefined): Promise<MachineStatesSummaryDto>;
|
|
338
342
|
protected processGetMachineStatesSummary(response: Response): Promise<MachineStatesSummaryDto>;
|
|
339
343
|
listResourceUptimesToday(request: ListResourceUptimesTodayRequest): Promise<ResourceUptimesAggregateDto>;
|
|
340
344
|
protected processListResourceUptimesToday(response: Response): Promise<ResourceUptimesAggregateDto>;
|
|
@@ -400,6 +404,8 @@ export interface IUserAppSettingsClient {
|
|
|
400
404
|
setMoveUserSettings(settings: MoveAppSettings): Promise<void>;
|
|
401
405
|
getEngageUserSettings(): Promise<EngageAppSettings>;
|
|
402
406
|
setEngageUserSettings(settings: EngageAppSettings): Promise<void>;
|
|
407
|
+
getFavoriteRoutesUserSettings(): Promise<FavoriteRoutesAppSettings>;
|
|
408
|
+
setFavoriteRoutesUserSettings(settings: FavoriteRoutesAppSettings): Promise<void>;
|
|
403
409
|
}
|
|
404
410
|
export declare class UserAppSettingsClient extends AuthorizedApiBase implements IUserAppSettingsClient {
|
|
405
411
|
private http;
|
|
@@ -419,6 +425,10 @@ export declare class UserAppSettingsClient extends AuthorizedApiBase implements
|
|
|
419
425
|
protected processGetEngageUserSettings(response: Response): Promise<EngageAppSettings>;
|
|
420
426
|
setEngageUserSettings(settings: EngageAppSettings): Promise<void>;
|
|
421
427
|
protected processSetEngageUserSettings(response: Response): Promise<void>;
|
|
428
|
+
getFavoriteRoutesUserSettings(): Promise<FavoriteRoutesAppSettings>;
|
|
429
|
+
protected processGetFavoriteRoutesUserSettings(response: Response): Promise<FavoriteRoutesAppSettings>;
|
|
430
|
+
setFavoriteRoutesUserSettings(settings: FavoriteRoutesAppSettings): Promise<void>;
|
|
431
|
+
protected processSetFavoriteRoutesUserSettings(response: Response): Promise<void>;
|
|
422
432
|
}
|
|
423
433
|
export interface IUploadClient {
|
|
424
434
|
createUploadInfo(): Promise<UploadInfoDto>;
|
|
@@ -436,7 +446,7 @@ export declare class UploadClient extends AuthorizedApiBase implements IUploadCl
|
|
|
436
446
|
protected processCreateUploadInfoCdf(response: Response): Promise<UploadInfoCdfDto>;
|
|
437
447
|
}
|
|
438
448
|
export interface ISystemHealthDashboardClient {
|
|
439
|
-
getMachineDataHealth(assetId: number | null | undefined): Promise<DataHealthDto>;
|
|
449
|
+
getMachineDataHealth(assetId: number | null | undefined, assetExternalId: string | null | undefined): Promise<DataHealthDto>;
|
|
440
450
|
}
|
|
441
451
|
export declare class SystemHealthDashboardClient extends AuthorizedApiBase implements ISystemHealthDashboardClient {
|
|
442
452
|
private http;
|
|
@@ -444,7 +454,7 @@ export declare class SystemHealthDashboardClient extends AuthorizedApiBase imple
|
|
|
444
454
|
constructor(configuration: IApiClientConfig, baseUrl?: string, http?: {
|
|
445
455
|
fetch(url: RequestInfo, init?: RequestInit): Promise<Response>;
|
|
446
456
|
});
|
|
447
|
-
getMachineDataHealth(assetId: number | null | undefined): Promise<DataHealthDto>;
|
|
457
|
+
getMachineDataHealth(assetId: number | null | undefined, assetExternalId: string | null | undefined): Promise<DataHealthDto>;
|
|
448
458
|
protected processGetMachineDataHealth(response: Response): Promise<DataHealthDto>;
|
|
449
459
|
}
|
|
450
460
|
export interface IPowerClient {
|
|
@@ -672,13 +682,13 @@ export interface IResourcesClient {
|
|
|
672
682
|
createResourceGroup(request: CreateResourceGroup): Promise<CreateResourceGroupResponse>;
|
|
673
683
|
updateResourceGroup(id: string, request: UpdateResourceGroup): Promise<void>;
|
|
674
684
|
deleteResourceGroup(id: string): Promise<void>;
|
|
675
|
-
listCurrentMachineStates(assetId: number | null | undefined): Promise<MachineStateListDto>;
|
|
676
|
-
listMachineStates(id:
|
|
677
|
-
listLastDowntimeMachineStates(id:
|
|
678
|
-
getMachineStateWithDowntimePeriods(id:
|
|
679
|
-
getMachineStatesSummary(id:
|
|
685
|
+
listCurrentMachineStates(assetId: number | null | undefined, assetExternalId: string | null | undefined): Promise<MachineStateListDto>;
|
|
686
|
+
listMachineStates(id: string, startTime: Date | null | undefined, endTime: Date | null | undefined): Promise<MachineStateDatapoint[]>;
|
|
687
|
+
listLastDowntimeMachineStates(id: string, endTime: Date | null | undefined, maxStates: number | null | undefined): Promise<DowntimeMachineStateDto[]>;
|
|
688
|
+
getMachineStateWithDowntimePeriods(id: string, timestamp: number | undefined): Promise<DowntimeMachineStateDto>;
|
|
689
|
+
getMachineStatesSummary(id: string, startTime: Date | null | undefined, endTime: Date | null | undefined): Promise<MachineStatesSummaryDto>;
|
|
680
690
|
listResourceErpData(): Promise<ResourceErpDataListDto>;
|
|
681
|
-
getResourceErpData(id:
|
|
691
|
+
getResourceErpData(id: string): Promise<ResourceErpDataDto>;
|
|
682
692
|
getResourceUtilizationSummary(): Promise<ResourceUtilizationSummaryDto>;
|
|
683
693
|
getCrossCompanyUtilizationSummary(): Promise<CrossCompanyResourceUtilizationSummaryDto>;
|
|
684
694
|
listCurrentResourceOperators(resourceExternalId: string | null | undefined, operatorNameQuery: string | null | undefined): Promise<OperatorAndMachineDto[]>;
|
|
@@ -686,7 +696,7 @@ export interface IResourcesClient {
|
|
|
686
696
|
createResourceWithoutMachine(request: CreateResourceWithoutMachine): Promise<void>;
|
|
687
697
|
createResourceWithResource(request: CreateResourceWithMachine): Promise<void>;
|
|
688
698
|
createResourceInResourceGroup(request: CreateResourceInResourceGroup): Promise<void>;
|
|
689
|
-
deleteMachine(id:
|
|
699
|
+
deleteMachine(id: string): Promise<void>;
|
|
690
700
|
/**
|
|
691
701
|
* @deprecated
|
|
692
702
|
*/
|
|
@@ -709,19 +719,19 @@ export declare class ResourcesClient extends AuthorizedApiBase implements IResou
|
|
|
709
719
|
protected processUpdateResourceGroup(response: Response): Promise<void>;
|
|
710
720
|
deleteResourceGroup(id: string): Promise<void>;
|
|
711
721
|
protected processDeleteResourceGroup(response: Response): Promise<void>;
|
|
712
|
-
listCurrentMachineStates(assetId: number | null | undefined): Promise<MachineStateListDto>;
|
|
722
|
+
listCurrentMachineStates(assetId: number | null | undefined, assetExternalId: string | null | undefined): Promise<MachineStateListDto>;
|
|
713
723
|
protected processListCurrentMachineStates(response: Response): Promise<MachineStateListDto>;
|
|
714
|
-
listMachineStates(id:
|
|
724
|
+
listMachineStates(id: string, startTime: Date | null | undefined, endTime: Date | null | undefined): Promise<MachineStateDatapoint[]>;
|
|
715
725
|
protected processListMachineStates(response: Response): Promise<MachineStateDatapoint[]>;
|
|
716
|
-
listLastDowntimeMachineStates(id:
|
|
726
|
+
listLastDowntimeMachineStates(id: string, endTime: Date | null | undefined, maxStates: number | null | undefined): Promise<DowntimeMachineStateDto[]>;
|
|
717
727
|
protected processListLastDowntimeMachineStates(response: Response): Promise<DowntimeMachineStateDto[]>;
|
|
718
|
-
getMachineStateWithDowntimePeriods(id:
|
|
728
|
+
getMachineStateWithDowntimePeriods(id: string, timestamp: number | undefined): Promise<DowntimeMachineStateDto>;
|
|
719
729
|
protected processGetMachineStateWithDowntimePeriods(response: Response): Promise<DowntimeMachineStateDto>;
|
|
720
|
-
getMachineStatesSummary(id:
|
|
730
|
+
getMachineStatesSummary(id: string, startTime: Date | null | undefined, endTime: Date | null | undefined): Promise<MachineStatesSummaryDto>;
|
|
721
731
|
protected processGetMachineStatesSummary(response: Response): Promise<MachineStatesSummaryDto>;
|
|
722
732
|
listResourceErpData(): Promise<ResourceErpDataListDto>;
|
|
723
733
|
protected processListResourceErpData(response: Response): Promise<ResourceErpDataListDto>;
|
|
724
|
-
getResourceErpData(id:
|
|
734
|
+
getResourceErpData(id: string): Promise<ResourceErpDataDto>;
|
|
725
735
|
protected processGetResourceErpData(response: Response): Promise<ResourceErpDataDto>;
|
|
726
736
|
getResourceUtilizationSummary(): Promise<ResourceUtilizationSummaryDto>;
|
|
727
737
|
protected processGetResourceUtilizationSummary(response: Response): Promise<ResourceUtilizationSummaryDto>;
|
|
@@ -737,7 +747,7 @@ export declare class ResourcesClient extends AuthorizedApiBase implements IResou
|
|
|
737
747
|
protected processCreateResourceWithResource(response: Response): Promise<void>;
|
|
738
748
|
createResourceInResourceGroup(request: CreateResourceInResourceGroup): Promise<void>;
|
|
739
749
|
protected processCreateResourceInResourceGroup(response: Response): Promise<void>;
|
|
740
|
-
deleteMachine(id:
|
|
750
|
+
deleteMachine(id: string): Promise<void>;
|
|
741
751
|
protected processDeleteMachine(response: Response): Promise<void>;
|
|
742
752
|
/**
|
|
743
753
|
* @deprecated
|
|
@@ -1424,13 +1434,13 @@ export interface IMachinesClient {
|
|
|
1424
1434
|
createMachineGroup(request: CreateMachineGroup): Promise<CreateMachineGroupResponse>;
|
|
1425
1435
|
updateMachineGroup(id: string, request: UpdateMachineGroup): Promise<void>;
|
|
1426
1436
|
deleteMachineGroup(id: string): Promise<void>;
|
|
1427
|
-
listCurrentMachineStates(assetId: number | null | undefined): Promise<MachineStateListDto>;
|
|
1428
|
-
listMachineStates(id:
|
|
1429
|
-
listLastDowntimeMachineStates(id:
|
|
1430
|
-
getMachineStateWithDowntimePeriods(id:
|
|
1431
|
-
getMachineStatesSummary(id:
|
|
1437
|
+
listCurrentMachineStates(assetId: number | null | undefined, assetExternalId: string | null | undefined): Promise<MachineStateListDto>;
|
|
1438
|
+
listMachineStates(id: string, startTime: Date | null | undefined, endTime: Date | null | undefined): Promise<MachineStateDatapoint[]>;
|
|
1439
|
+
listLastDowntimeMachineStates(id: string, endTime: Date | null | undefined, maxStates: number | null | undefined): Promise<DowntimeMachineStateDto[]>;
|
|
1440
|
+
getMachineStateWithDowntimePeriods(id: string, timestamp: number | undefined): Promise<DowntimeMachineStateDto>;
|
|
1441
|
+
getMachineStatesSummary(id: string, startTime: Date | null | undefined, endTime: Date | null | undefined): Promise<MachineStatesSummaryDto>;
|
|
1432
1442
|
listMachineErpData(): Promise<MachineErpDataListDto>;
|
|
1433
|
-
getMachineErpData(id:
|
|
1443
|
+
getMachineErpData(id: string): Promise<MachineErpDataDto>;
|
|
1434
1444
|
/**
|
|
1435
1445
|
* @param startTime (optional)
|
|
1436
1446
|
* @param endTime (optional)
|
|
@@ -1444,7 +1454,7 @@ export interface IMachinesClient {
|
|
|
1444
1454
|
createResourceWithoutMachine(request: CreateResourceWithoutMachine): Promise<void>;
|
|
1445
1455
|
createResourceWithMachine(request: CreateResourceWithMachine): Promise<void>;
|
|
1446
1456
|
createResourceInResourceGroup(request: CreateResourceInResourceGroup): Promise<void>;
|
|
1447
|
-
deleteMachine(id:
|
|
1457
|
+
deleteMachine(id: string): Promise<void>;
|
|
1448
1458
|
}
|
|
1449
1459
|
export declare class MachinesClient extends AuthorizedApiBase implements IMachinesClient {
|
|
1450
1460
|
private http;
|
|
@@ -1462,19 +1472,19 @@ export declare class MachinesClient extends AuthorizedApiBase implements IMachin
|
|
|
1462
1472
|
protected processUpdateMachineGroup(response: Response): Promise<void>;
|
|
1463
1473
|
deleteMachineGroup(id: string): Promise<void>;
|
|
1464
1474
|
protected processDeleteMachineGroup(response: Response): Promise<void>;
|
|
1465
|
-
listCurrentMachineStates(assetId: number | null | undefined): Promise<MachineStateListDto>;
|
|
1475
|
+
listCurrentMachineStates(assetId: number | null | undefined, assetExternalId: string | null | undefined): Promise<MachineStateListDto>;
|
|
1466
1476
|
protected processListCurrentMachineStates(response: Response): Promise<MachineStateListDto>;
|
|
1467
|
-
listMachineStates(id:
|
|
1477
|
+
listMachineStates(id: string, startTime: Date | null | undefined, endTime: Date | null | undefined): Promise<MachineStateDatapoint[]>;
|
|
1468
1478
|
protected processListMachineStates(response: Response): Promise<MachineStateDatapoint[]>;
|
|
1469
|
-
listLastDowntimeMachineStates(id:
|
|
1479
|
+
listLastDowntimeMachineStates(id: string, endTime: Date | null | undefined, maxStates: number | null | undefined): Promise<DowntimeMachineStateDto[]>;
|
|
1470
1480
|
protected processListLastDowntimeMachineStates(response: Response): Promise<DowntimeMachineStateDto[]>;
|
|
1471
|
-
getMachineStateWithDowntimePeriods(id:
|
|
1481
|
+
getMachineStateWithDowntimePeriods(id: string, timestamp: number | undefined): Promise<DowntimeMachineStateDto>;
|
|
1472
1482
|
protected processGetMachineStateWithDowntimePeriods(response: Response): Promise<DowntimeMachineStateDto>;
|
|
1473
|
-
getMachineStatesSummary(id:
|
|
1483
|
+
getMachineStatesSummary(id: string, startTime: Date | null | undefined, endTime: Date | null | undefined): Promise<MachineStatesSummaryDto>;
|
|
1474
1484
|
protected processGetMachineStatesSummary(response: Response): Promise<MachineStatesSummaryDto>;
|
|
1475
1485
|
listMachineErpData(): Promise<MachineErpDataListDto>;
|
|
1476
1486
|
protected processListMachineErpData(response: Response): Promise<MachineErpDataListDto>;
|
|
1477
|
-
getMachineErpData(id:
|
|
1487
|
+
getMachineErpData(id: string): Promise<MachineErpDataDto>;
|
|
1478
1488
|
protected processGetMachineErpData(response: Response): Promise<MachineErpDataDto>;
|
|
1479
1489
|
/**
|
|
1480
1490
|
* @param startTime (optional)
|
|
@@ -1497,13 +1507,13 @@ export declare class MachinesClient extends AuthorizedApiBase implements IMachin
|
|
|
1497
1507
|
protected processCreateResourceWithMachine(response: Response): Promise<void>;
|
|
1498
1508
|
createResourceInResourceGroup(request: CreateResourceInResourceGroup): Promise<void>;
|
|
1499
1509
|
protected processCreateResourceInResourceGroup(response: Response): Promise<void>;
|
|
1500
|
-
deleteMachine(id:
|
|
1510
|
+
deleteMachine(id: string): Promise<void>;
|
|
1501
1511
|
protected processDeleteMachine(response: Response): Promise<void>;
|
|
1502
1512
|
}
|
|
1503
1513
|
export interface IMachineDataClient {
|
|
1504
|
-
getLiveMachineData(assetId:
|
|
1505
|
-
getTimeseriesGraph(assetId:
|
|
1506
|
-
exportTimeseriesGraph(assetId:
|
|
1514
|
+
getLiveMachineData(assetId: string, externalIds: string[] | undefined): Promise<LiveMachineDataDto>;
|
|
1515
|
+
getTimeseriesGraph(assetId: string, externalIds: string[] | undefined, startTime: Date | undefined, endTime: Date | undefined): Promise<TimeseriesGraphDto>;
|
|
1516
|
+
exportTimeseriesGraph(assetId: string, request: ExportTimeseriesGraphRequest): Promise<DownloadDto>;
|
|
1507
1517
|
}
|
|
1508
1518
|
export declare class MachineDataClient extends AuthorizedApiBase implements IMachineDataClient {
|
|
1509
1519
|
private http;
|
|
@@ -1511,11 +1521,11 @@ export declare class MachineDataClient extends AuthorizedApiBase implements IMac
|
|
|
1511
1521
|
constructor(configuration: IApiClientConfig, baseUrl?: string, http?: {
|
|
1512
1522
|
fetch(url: RequestInfo, init?: RequestInit): Promise<Response>;
|
|
1513
1523
|
});
|
|
1514
|
-
getLiveMachineData(assetId:
|
|
1524
|
+
getLiveMachineData(assetId: string, externalIds: string[] | undefined): Promise<LiveMachineDataDto>;
|
|
1515
1525
|
protected processGetLiveMachineData(response: Response): Promise<LiveMachineDataDto>;
|
|
1516
|
-
getTimeseriesGraph(assetId:
|
|
1526
|
+
getTimeseriesGraph(assetId: string, externalIds: string[] | undefined, startTime: Date | undefined, endTime: Date | undefined): Promise<TimeseriesGraphDto>;
|
|
1517
1527
|
protected processGetTimeseriesGraph(response: Response): Promise<TimeseriesGraphDto>;
|
|
1518
|
-
exportTimeseriesGraph(assetId:
|
|
1528
|
+
exportTimeseriesGraph(assetId: string, request: ExportTimeseriesGraphRequest): Promise<DownloadDto>;
|
|
1519
1529
|
protected processExportTimeseriesGraph(response: Response): Promise<DownloadDto>;
|
|
1520
1530
|
}
|
|
1521
1531
|
export interface ILinksClient {
|
|
@@ -2061,9 +2071,9 @@ export interface IAssetsClient {
|
|
|
2061
2071
|
listAssets(externalIdprefix: string | null | undefined, name: string | null | undefined, source: string | null | undefined, limit: number | undefined, continuationToken: string | null | undefined): Promise<PagedResultOfAssetDto>;
|
|
2062
2072
|
createAsset(createAsset: CreateAsset): Promise<AssetDto>;
|
|
2063
2073
|
searchAssets(name: string | null | undefined, description: string | null | undefined, limit: number | undefined): Promise<AssetDto[]>;
|
|
2064
|
-
getAssetById(id:
|
|
2065
|
-
updateAsset(id:
|
|
2066
|
-
getAssetStructureById(id:
|
|
2074
|
+
getAssetById(id: string): Promise<AssetDto>;
|
|
2075
|
+
updateAsset(id: string, request: UpdateAssetRequest): Promise<AssetDto>;
|
|
2076
|
+
getAssetStructureById(id: string): Promise<AssetStructureDto>;
|
|
2067
2077
|
/**
|
|
2068
2078
|
* @deprecated
|
|
2069
2079
|
*/
|
|
@@ -2081,11 +2091,11 @@ export declare class AssetsClient extends AuthorizedApiBase implements IAssetsCl
|
|
|
2081
2091
|
protected processCreateAsset(response: Response): Promise<AssetDto>;
|
|
2082
2092
|
searchAssets(name: string | null | undefined, description: string | null | undefined, limit: number | undefined): Promise<AssetDto[]>;
|
|
2083
2093
|
protected processSearchAssets(response: Response): Promise<AssetDto[]>;
|
|
2084
|
-
getAssetById(id:
|
|
2094
|
+
getAssetById(id: string): Promise<AssetDto>;
|
|
2085
2095
|
protected processGetAssetById(response: Response): Promise<AssetDto>;
|
|
2086
|
-
updateAsset(id:
|
|
2096
|
+
updateAsset(id: string, request: UpdateAssetRequest): Promise<AssetDto>;
|
|
2087
2097
|
protected processUpdateAsset(response: Response): Promise<AssetDto>;
|
|
2088
|
-
getAssetStructureById(id:
|
|
2098
|
+
getAssetStructureById(id: string): Promise<AssetStructureDto>;
|
|
2089
2099
|
protected processGetAssetStructureById(response: Response): Promise<AssetStructureDto>;
|
|
2090
2100
|
/**
|
|
2091
2101
|
* @deprecated
|
|
@@ -3123,6 +3133,7 @@ export interface IMeasurementFormSchemasAdminClient {
|
|
|
3123
3133
|
*/
|
|
3124
3134
|
uploadSchemaDrawing(id: string, request: UploadDrawingRequest): Promise<MeasurementFormSchemaDto>;
|
|
3125
3135
|
uploadSchemaAttachment(id: string, request: UploadRequest): Promise<MeasurementFormSchemaDto>;
|
|
3136
|
+
deleteMeasurementFormSchemaFile(id: string, slot: SchemaFileSlot): Promise<void>;
|
|
3126
3137
|
getMeasurementFormImportStatus(id: string): Promise<MeasurementFormImportStatusDto>;
|
|
3127
3138
|
listLinkableMeasurementFormSchemas(schemaId: string, pageSize: number | undefined, filter: string | null | undefined, continuationToken: string | null | undefined): Promise<PagedResultOfMeasurementFormListDto>;
|
|
3128
3139
|
postListLinkableMeasurementFormSchemas(request: ListLinkableMeasurementFormSchemasRequest): Promise<PagedResultOfMeasurementFormListDto>;
|
|
@@ -3213,6 +3224,8 @@ export declare class MeasurementFormSchemasAdminClient extends AuthorizedApiBase
|
|
|
3213
3224
|
protected processUploadSchemaDrawing(response: Response): Promise<MeasurementFormSchemaDto>;
|
|
3214
3225
|
uploadSchemaAttachment(id: string, request: UploadRequest): Promise<MeasurementFormSchemaDto>;
|
|
3215
3226
|
protected processUploadSchemaAttachment(response: Response): Promise<MeasurementFormSchemaDto>;
|
|
3227
|
+
deleteMeasurementFormSchemaFile(id: string, slot: SchemaFileSlot): Promise<void>;
|
|
3228
|
+
protected processDeleteMeasurementFormSchemaFile(response: Response): Promise<void>;
|
|
3216
3229
|
getMeasurementFormImportStatus(id: string): Promise<MeasurementFormImportStatusDto>;
|
|
3217
3230
|
protected processGetMeasurementFormImportStatus(response: Response): Promise<MeasurementFormImportStatusDto>;
|
|
3218
3231
|
listLinkableMeasurementFormSchemas(schemaId: string, pageSize: number | undefined, filter: string | null | undefined, continuationToken: string | null | undefined): Promise<PagedResultOfMeasurementFormListDto>;
|
|
@@ -3311,6 +3324,7 @@ export interface IMeasurementFormSchemasClient {
|
|
|
3311
3324
|
getMeasurementFormSchema(id: string): Promise<MeasurementFormSchemaDto>;
|
|
3312
3325
|
postListMeasurementFormSchemas(request: ListMeasurementFormSchemasRequest | undefined): Promise<PagedResultOfMeasurementFormSchemaOverviewDto>;
|
|
3313
3326
|
postCountMeasurementFormSchemas(request: CountMeasurementFormSchemasRequest | undefined): Promise<MeasurementFormSchemaCountsDto>;
|
|
3327
|
+
listMeasurementFormSchemaFiles(id: string): Promise<MeasurementFormSchemaFileDto[]>;
|
|
3314
3328
|
listMeasurementFormSchemaVersions(id: string): Promise<MeasurementFormSchemaVersionDto[]>;
|
|
3315
3329
|
listMeasurementFormSchemaInstances(id: string): Promise<MeasurementFormSchemaInstanceDto[]>;
|
|
3316
3330
|
listMeasurementFormSchemaVersionChanges(id: string): Promise<MeasurementFormSchemaVersionChangesDto[]>;
|
|
@@ -3340,6 +3354,8 @@ export declare class MeasurementFormSchemasClient extends AuthorizedApiBase impl
|
|
|
3340
3354
|
protected processPostListMeasurementFormSchemas(response: Response): Promise<PagedResultOfMeasurementFormSchemaOverviewDto>;
|
|
3341
3355
|
postCountMeasurementFormSchemas(request: CountMeasurementFormSchemasRequest | undefined): Promise<MeasurementFormSchemaCountsDto>;
|
|
3342
3356
|
protected processPostCountMeasurementFormSchemas(response: Response): Promise<MeasurementFormSchemaCountsDto>;
|
|
3357
|
+
listMeasurementFormSchemaFiles(id: string): Promise<MeasurementFormSchemaFileDto[]>;
|
|
3358
|
+
protected processListMeasurementFormSchemaFiles(response: Response): Promise<MeasurementFormSchemaFileDto[]>;
|
|
3343
3359
|
listMeasurementFormSchemaVersions(id: string): Promise<MeasurementFormSchemaVersionDto[]>;
|
|
3344
3360
|
protected processListMeasurementFormSchemaVersions(response: Response): Promise<MeasurementFormSchemaVersionDto[]>;
|
|
3345
3361
|
listMeasurementFormSchemaInstances(id: string): Promise<MeasurementFormSchemaInstanceDto[]>;
|
|
@@ -3989,6 +4005,7 @@ export interface UtilizationListDto {
|
|
|
3989
4005
|
}
|
|
3990
4006
|
export interface MachineUtilizationDto {
|
|
3991
4007
|
assetId: number;
|
|
4008
|
+
assetExternalId: string;
|
|
3992
4009
|
name: string;
|
|
3993
4010
|
description?: string | null;
|
|
3994
4011
|
state: string;
|
|
@@ -4030,6 +4047,7 @@ export interface PowerOnUtilizationDto extends UtilizationAveragesDto {
|
|
|
4030
4047
|
}
|
|
4031
4048
|
export interface UtilizationDetailsDto {
|
|
4032
4049
|
machineId: number;
|
|
4050
|
+
machineExternalId: string;
|
|
4033
4051
|
machineName: string;
|
|
4034
4052
|
machineStateText?: string | null;
|
|
4035
4053
|
machineState?: MachineState | null;
|
|
@@ -4144,6 +4162,7 @@ export interface ResourceUtilizationListDto {
|
|
|
4144
4162
|
}
|
|
4145
4163
|
export interface ResourceUtilizationDto {
|
|
4146
4164
|
assetId: number;
|
|
4165
|
+
assetExternalId: string;
|
|
4147
4166
|
name: string;
|
|
4148
4167
|
description?: string | null;
|
|
4149
4168
|
state: string;
|
|
@@ -4154,6 +4173,7 @@ export interface ResourceUtilizationDto {
|
|
|
4154
4173
|
}
|
|
4155
4174
|
export interface ResourceUtilizationDetailsDto {
|
|
4156
4175
|
resourceId: number;
|
|
4176
|
+
resourceExternalId: string;
|
|
4157
4177
|
resourceName: string;
|
|
4158
4178
|
machineStateText?: string | null;
|
|
4159
4179
|
machineState?: MachineState | null;
|
|
@@ -4235,6 +4255,13 @@ export interface EngageAppSettings {
|
|
|
4235
4255
|
scheduleViewMode?: ScheduleViewMode | null;
|
|
4236
4256
|
}
|
|
4237
4257
|
export type ScheduleViewMode = "Flat" | "Grouped";
|
|
4258
|
+
export interface FavoriteRoutesAppSettings {
|
|
4259
|
+
favorites?: FavoriteRoute[];
|
|
4260
|
+
}
|
|
4261
|
+
export interface FavoriteRoute {
|
|
4262
|
+
appKey: string;
|
|
4263
|
+
route: string;
|
|
4264
|
+
}
|
|
4238
4265
|
export interface UploadInfoDto {
|
|
4239
4266
|
baseUrl?: string | null;
|
|
4240
4267
|
key?: string | null;
|
|
@@ -4252,6 +4279,7 @@ export interface DataHealthDto {
|
|
|
4252
4279
|
}
|
|
4253
4280
|
export interface MachineDataHealthDto {
|
|
4254
4281
|
assetId: number;
|
|
4282
|
+
assetExternalId: string;
|
|
4255
4283
|
name: string;
|
|
4256
4284
|
description?: string | null;
|
|
4257
4285
|
state?: string | null;
|
|
@@ -4269,6 +4297,7 @@ export interface PowerRegionDto {
|
|
|
4269
4297
|
}
|
|
4270
4298
|
export interface ConsumptionDto {
|
|
4271
4299
|
assetId: number;
|
|
4300
|
+
assetExternalId: string;
|
|
4272
4301
|
assetName: string;
|
|
4273
4302
|
kwh: number;
|
|
4274
4303
|
co2Equivalent?: number | null;
|
|
@@ -4277,15 +4306,18 @@ export interface ConsumptionDto {
|
|
|
4277
4306
|
}
|
|
4278
4307
|
export interface AssetConsumptionDto {
|
|
4279
4308
|
timeseriesId: number;
|
|
4309
|
+
timeseriesExternalId?: string | null;
|
|
4280
4310
|
timeseriesName: string;
|
|
4281
4311
|
kwh: number;
|
|
4282
4312
|
assetId: number;
|
|
4313
|
+
assetExternalId?: string | null;
|
|
4283
4314
|
assetName: string;
|
|
4284
4315
|
co2Equivalent?: number | null;
|
|
4285
4316
|
co2EquivalentNotAdjustedForLocalProduction?: number | null;
|
|
4286
4317
|
}
|
|
4287
4318
|
export interface GetConsumption {
|
|
4288
4319
|
assetId?: number | null;
|
|
4320
|
+
assetExternalId?: string | null;
|
|
4289
4321
|
start?: Date | null;
|
|
4290
4322
|
end?: Date | null;
|
|
4291
4323
|
}
|
|
@@ -4295,8 +4327,10 @@ export interface PowerDto {
|
|
|
4295
4327
|
}
|
|
4296
4328
|
export interface AssetPowerDto {
|
|
4297
4329
|
timeseriesId?: number;
|
|
4330
|
+
timeseriesExternalId?: string | null;
|
|
4298
4331
|
timeseriesName?: string | null;
|
|
4299
4332
|
assetId?: number;
|
|
4333
|
+
assetExternalId?: string | null;
|
|
4300
4334
|
assetName?: string | null;
|
|
4301
4335
|
timeSeriesDataPoints?: NumericDataPointDto[] | null;
|
|
4302
4336
|
}
|
|
@@ -4308,7 +4342,8 @@ export interface NumericDataPointDto {
|
|
|
4308
4342
|
max?: number | null;
|
|
4309
4343
|
}
|
|
4310
4344
|
export interface GetPower {
|
|
4311
|
-
assetId
|
|
4345
|
+
assetId?: number | null;
|
|
4346
|
+
assetExternalId?: string | null;
|
|
4312
4347
|
granularity?: string | null;
|
|
4313
4348
|
start?: Date | null;
|
|
4314
4349
|
end?: Date | null;
|
|
@@ -4774,6 +4809,7 @@ export interface MachineStateDto {
|
|
|
4774
4809
|
state: string;
|
|
4775
4810
|
machineState: MachineState;
|
|
4776
4811
|
startTime: Date;
|
|
4812
|
+
assetExternalId: string;
|
|
4777
4813
|
}
|
|
4778
4814
|
export interface DowntimeMachineStateDto {
|
|
4779
4815
|
datapoint: MachineStateDatapoint;
|
|
@@ -4790,6 +4826,7 @@ export interface SingleResourceErpDataListDto {
|
|
|
4790
4826
|
activeOrders: ResourceErpDataDto[];
|
|
4791
4827
|
lastActiveEvent?: WorkorderOperationEventDto | null;
|
|
4792
4828
|
downtimePeriodReason?: DowntimePeriodReasonDto | null;
|
|
4829
|
+
assetExternalId: string;
|
|
4793
4830
|
}
|
|
4794
4831
|
export interface ResourceErpDataDto {
|
|
4795
4832
|
workOrderId: string;
|
|
@@ -5127,6 +5164,7 @@ export interface ResourceGroupUtilizationV2Dto {
|
|
|
5127
5164
|
}
|
|
5128
5165
|
export interface ResourceUtilizationV3Dto {
|
|
5129
5166
|
id?: number;
|
|
5167
|
+
externalId: string;
|
|
5130
5168
|
name: string;
|
|
5131
5169
|
description?: string | null;
|
|
5132
5170
|
utilization: UtilizationDetailsV2Dto;
|
|
@@ -6162,6 +6200,7 @@ export interface SingleMachineErpDataListDto {
|
|
|
6162
6200
|
activeOrders: MachineErpDataDto[];
|
|
6163
6201
|
lastActiveEvent?: WorkorderOperationEventDto | null;
|
|
6164
6202
|
downtimePeriodReason?: DowntimePeriodReasonDto | null;
|
|
6203
|
+
assetExternalId: string;
|
|
6165
6204
|
}
|
|
6166
6205
|
export interface MachineErpDataDto {
|
|
6167
6206
|
workOrderId: string;
|
|
@@ -6202,6 +6241,7 @@ export interface CrossCompanyUtilizationSummaryDto {
|
|
|
6202
6241
|
export interface LiveMachineDataDto {
|
|
6203
6242
|
assetId?: number;
|
|
6204
6243
|
dataPoints?: LiveMachineDataPointDto[];
|
|
6244
|
+
assetExternalId: string;
|
|
6205
6245
|
}
|
|
6206
6246
|
export interface LiveMachineDataPointDto {
|
|
6207
6247
|
externalId?: string;
|
|
@@ -6212,6 +6252,7 @@ export interface LiveMachineDataPointDto {
|
|
|
6212
6252
|
export interface TimeseriesGraphDto {
|
|
6213
6253
|
assetId?: number;
|
|
6214
6254
|
series?: TimeseriesGraphSeriesDto[];
|
|
6255
|
+
assetExternalId: string;
|
|
6215
6256
|
}
|
|
6216
6257
|
export interface TimeseriesGraphSeriesDto {
|
|
6217
6258
|
externalId?: string;
|
|
@@ -7230,11 +7271,13 @@ export interface AssetDto {
|
|
|
7230
7271
|
} | null;
|
|
7231
7272
|
aggregates?: any | null;
|
|
7232
7273
|
parentId?: number | null;
|
|
7274
|
+
parentExternalId?: string | null;
|
|
7233
7275
|
source?: string | null;
|
|
7234
7276
|
id?: number | null;
|
|
7235
7277
|
createdTime?: number | null;
|
|
7236
7278
|
lastUpdatedTime?: number | null;
|
|
7237
7279
|
rootId?: number | null;
|
|
7280
|
+
rootExternalId?: string | null;
|
|
7238
7281
|
}
|
|
7239
7282
|
export interface AssetStructureDto {
|
|
7240
7283
|
externalId?: string | null;
|
|
@@ -7251,7 +7294,8 @@ export interface AssetSimpleStructureDto {
|
|
|
7251
7294
|
id?: number | null;
|
|
7252
7295
|
}
|
|
7253
7296
|
export interface CreateAsset {
|
|
7254
|
-
parentId
|
|
7297
|
+
parentId?: number | null;
|
|
7298
|
+
parentExternalId?: string | null;
|
|
7255
7299
|
externalId: string;
|
|
7256
7300
|
name: string;
|
|
7257
7301
|
description: string;
|
|
@@ -7261,7 +7305,8 @@ export interface CreateAsset {
|
|
|
7261
7305
|
source?: string | null;
|
|
7262
7306
|
}
|
|
7263
7307
|
export interface UpdateAssetRequest {
|
|
7264
|
-
parentId
|
|
7308
|
+
parentId?: number | null;
|
|
7309
|
+
parentExternalId?: string | null;
|
|
7265
7310
|
name: string;
|
|
7266
7311
|
description: string;
|
|
7267
7312
|
metadata: {
|
|
@@ -9999,6 +10044,7 @@ export interface UploadRequest {
|
|
|
9999
10044
|
filename: string;
|
|
10000
10045
|
isMarkedDrawing?: boolean | null;
|
|
10001
10046
|
}
|
|
10047
|
+
export type SchemaFileSlot = "Drawing" | "ProjectFile" | "MarkedDrawing" | "SourceFile";
|
|
10002
10048
|
export interface MeasurementFormImportStatusDto {
|
|
10003
10049
|
progress: number;
|
|
10004
10050
|
totalElements: number;
|
|
@@ -10298,6 +10344,13 @@ export interface CountMeasurementFormSchemasRequest {
|
|
|
10298
10344
|
withoutCustomer?: boolean | null;
|
|
10299
10345
|
schemaCreator?: boolean | null;
|
|
10300
10346
|
}
|
|
10347
|
+
export interface MeasurementFormSchemaFileDto {
|
|
10348
|
+
slot: SchemaFileSlot;
|
|
10349
|
+
title: string;
|
|
10350
|
+
url: string;
|
|
10351
|
+
size?: number | null;
|
|
10352
|
+
lastModified?: Date | null;
|
|
10353
|
+
}
|
|
10301
10354
|
export interface MeasurementFormSchemaVersionDto {
|
|
10302
10355
|
id: string;
|
|
10303
10356
|
versionId: number;
|