@ignos/api-client 20261109.354.1 → 20261109.355.1-alpha
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 +93 -81
- package/lib/ignosportal-api.js +17 -82
- package/package.json +1 -1
- package/src/ignosportal-api.ts +103 -157
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>;
|
|
@@ -436,7 +440,7 @@ export declare class UploadClient extends AuthorizedApiBase implements IUploadCl
|
|
|
436
440
|
protected processCreateUploadInfoCdf(response: Response): Promise<UploadInfoCdfDto>;
|
|
437
441
|
}
|
|
438
442
|
export interface ISystemHealthDashboardClient {
|
|
439
|
-
getMachineDataHealth(assetId: number | null | undefined): Promise<DataHealthDto>;
|
|
443
|
+
getMachineDataHealth(assetId: number | null | undefined, assetExternalId: string | null | undefined): Promise<DataHealthDto>;
|
|
440
444
|
}
|
|
441
445
|
export declare class SystemHealthDashboardClient extends AuthorizedApiBase implements ISystemHealthDashboardClient {
|
|
442
446
|
private http;
|
|
@@ -444,7 +448,7 @@ export declare class SystemHealthDashboardClient extends AuthorizedApiBase imple
|
|
|
444
448
|
constructor(configuration: IApiClientConfig, baseUrl?: string, http?: {
|
|
445
449
|
fetch(url: RequestInfo, init?: RequestInit): Promise<Response>;
|
|
446
450
|
});
|
|
447
|
-
getMachineDataHealth(assetId: number | null | undefined): Promise<DataHealthDto>;
|
|
451
|
+
getMachineDataHealth(assetId: number | null | undefined, assetExternalId: string | null | undefined): Promise<DataHealthDto>;
|
|
448
452
|
protected processGetMachineDataHealth(response: Response): Promise<DataHealthDto>;
|
|
449
453
|
}
|
|
450
454
|
export interface IPowerClient {
|
|
@@ -672,13 +676,13 @@ export interface IResourcesClient {
|
|
|
672
676
|
createResourceGroup(request: CreateResourceGroup): Promise<CreateResourceGroupResponse>;
|
|
673
677
|
updateResourceGroup(id: string, request: UpdateResourceGroup): Promise<void>;
|
|
674
678
|
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:
|
|
679
|
+
listCurrentMachineStates(assetId: number | null | undefined, assetExternalId: string | null | undefined): Promise<MachineStateListDto>;
|
|
680
|
+
listMachineStates(id: string, startTime: Date | null | undefined, endTime: Date | null | undefined): Promise<MachineStateDatapoint[]>;
|
|
681
|
+
listLastDowntimeMachineStates(id: string, endTime: Date | null | undefined, maxStates: number | null | undefined): Promise<DowntimeMachineStateDto[]>;
|
|
682
|
+
getMachineStateWithDowntimePeriods(id: string, timestamp: number | undefined): Promise<DowntimeMachineStateDto>;
|
|
683
|
+
getMachineStatesSummary(id: string, startTime: Date | null | undefined, endTime: Date | null | undefined): Promise<MachineStatesSummaryDto>;
|
|
680
684
|
listResourceErpData(): Promise<ResourceErpDataListDto>;
|
|
681
|
-
getResourceErpData(id:
|
|
685
|
+
getResourceErpData(id: string): Promise<ResourceErpDataDto>;
|
|
682
686
|
getResourceUtilizationSummary(): Promise<ResourceUtilizationSummaryDto>;
|
|
683
687
|
getCrossCompanyUtilizationSummary(): Promise<CrossCompanyResourceUtilizationSummaryDto>;
|
|
684
688
|
listCurrentResourceOperators(resourceExternalId: string | null | undefined, operatorNameQuery: string | null | undefined): Promise<OperatorAndMachineDto[]>;
|
|
@@ -686,7 +690,7 @@ export interface IResourcesClient {
|
|
|
686
690
|
createResourceWithoutMachine(request: CreateResourceWithoutMachine): Promise<void>;
|
|
687
691
|
createResourceWithResource(request: CreateResourceWithMachine): Promise<void>;
|
|
688
692
|
createResourceInResourceGroup(request: CreateResourceInResourceGroup): Promise<void>;
|
|
689
|
-
deleteMachine(id:
|
|
693
|
+
deleteMachine(id: string): Promise<void>;
|
|
690
694
|
/**
|
|
691
695
|
* @deprecated
|
|
692
696
|
*/
|
|
@@ -709,19 +713,19 @@ export declare class ResourcesClient extends AuthorizedApiBase implements IResou
|
|
|
709
713
|
protected processUpdateResourceGroup(response: Response): Promise<void>;
|
|
710
714
|
deleteResourceGroup(id: string): Promise<void>;
|
|
711
715
|
protected processDeleteResourceGroup(response: Response): Promise<void>;
|
|
712
|
-
listCurrentMachineStates(assetId: number | null | undefined): Promise<MachineStateListDto>;
|
|
716
|
+
listCurrentMachineStates(assetId: number | null | undefined, assetExternalId: string | null | undefined): Promise<MachineStateListDto>;
|
|
713
717
|
protected processListCurrentMachineStates(response: Response): Promise<MachineStateListDto>;
|
|
714
|
-
listMachineStates(id:
|
|
718
|
+
listMachineStates(id: string, startTime: Date | null | undefined, endTime: Date | null | undefined): Promise<MachineStateDatapoint[]>;
|
|
715
719
|
protected processListMachineStates(response: Response): Promise<MachineStateDatapoint[]>;
|
|
716
|
-
listLastDowntimeMachineStates(id:
|
|
720
|
+
listLastDowntimeMachineStates(id: string, endTime: Date | null | undefined, maxStates: number | null | undefined): Promise<DowntimeMachineStateDto[]>;
|
|
717
721
|
protected processListLastDowntimeMachineStates(response: Response): Promise<DowntimeMachineStateDto[]>;
|
|
718
|
-
getMachineStateWithDowntimePeriods(id:
|
|
722
|
+
getMachineStateWithDowntimePeriods(id: string, timestamp: number | undefined): Promise<DowntimeMachineStateDto>;
|
|
719
723
|
protected processGetMachineStateWithDowntimePeriods(response: Response): Promise<DowntimeMachineStateDto>;
|
|
720
|
-
getMachineStatesSummary(id:
|
|
724
|
+
getMachineStatesSummary(id: string, startTime: Date | null | undefined, endTime: Date | null | undefined): Promise<MachineStatesSummaryDto>;
|
|
721
725
|
protected processGetMachineStatesSummary(response: Response): Promise<MachineStatesSummaryDto>;
|
|
722
726
|
listResourceErpData(): Promise<ResourceErpDataListDto>;
|
|
723
727
|
protected processListResourceErpData(response: Response): Promise<ResourceErpDataListDto>;
|
|
724
|
-
getResourceErpData(id:
|
|
728
|
+
getResourceErpData(id: string): Promise<ResourceErpDataDto>;
|
|
725
729
|
protected processGetResourceErpData(response: Response): Promise<ResourceErpDataDto>;
|
|
726
730
|
getResourceUtilizationSummary(): Promise<ResourceUtilizationSummaryDto>;
|
|
727
731
|
protected processGetResourceUtilizationSummary(response: Response): Promise<ResourceUtilizationSummaryDto>;
|
|
@@ -737,7 +741,7 @@ export declare class ResourcesClient extends AuthorizedApiBase implements IResou
|
|
|
737
741
|
protected processCreateResourceWithResource(response: Response): Promise<void>;
|
|
738
742
|
createResourceInResourceGroup(request: CreateResourceInResourceGroup): Promise<void>;
|
|
739
743
|
protected processCreateResourceInResourceGroup(response: Response): Promise<void>;
|
|
740
|
-
deleteMachine(id:
|
|
744
|
+
deleteMachine(id: string): Promise<void>;
|
|
741
745
|
protected processDeleteMachine(response: Response): Promise<void>;
|
|
742
746
|
/**
|
|
743
747
|
* @deprecated
|
|
@@ -1412,13 +1416,13 @@ export interface IMachinesClient {
|
|
|
1412
1416
|
createMachineGroup(request: CreateMachineGroup): Promise<CreateMachineGroupResponse>;
|
|
1413
1417
|
updateMachineGroup(id: string, request: UpdateMachineGroup): Promise<void>;
|
|
1414
1418
|
deleteMachineGroup(id: string): Promise<void>;
|
|
1415
|
-
listCurrentMachineStates(assetId: number | null | undefined): Promise<MachineStateListDto>;
|
|
1416
|
-
listMachineStates(id:
|
|
1417
|
-
listLastDowntimeMachineStates(id:
|
|
1418
|
-
getMachineStateWithDowntimePeriods(id:
|
|
1419
|
-
getMachineStatesSummary(id:
|
|
1419
|
+
listCurrentMachineStates(assetId: number | null | undefined, assetExternalId: string | null | undefined): Promise<MachineStateListDto>;
|
|
1420
|
+
listMachineStates(id: string, startTime: Date | null | undefined, endTime: Date | null | undefined): Promise<MachineStateDatapoint[]>;
|
|
1421
|
+
listLastDowntimeMachineStates(id: string, endTime: Date | null | undefined, maxStates: number | null | undefined): Promise<DowntimeMachineStateDto[]>;
|
|
1422
|
+
getMachineStateWithDowntimePeriods(id: string, timestamp: number | undefined): Promise<DowntimeMachineStateDto>;
|
|
1423
|
+
getMachineStatesSummary(id: string, startTime: Date | null | undefined, endTime: Date | null | undefined): Promise<MachineStatesSummaryDto>;
|
|
1420
1424
|
listMachineErpData(): Promise<MachineErpDataListDto>;
|
|
1421
|
-
getMachineErpData(id:
|
|
1425
|
+
getMachineErpData(id: string): Promise<MachineErpDataDto>;
|
|
1422
1426
|
/**
|
|
1423
1427
|
* @param startTime (optional)
|
|
1424
1428
|
* @param endTime (optional)
|
|
@@ -1432,7 +1436,7 @@ export interface IMachinesClient {
|
|
|
1432
1436
|
createResourceWithoutMachine(request: CreateResourceWithoutMachine): Promise<void>;
|
|
1433
1437
|
createResourceWithMachine(request: CreateResourceWithMachine): Promise<void>;
|
|
1434
1438
|
createResourceInResourceGroup(request: CreateResourceInResourceGroup): Promise<void>;
|
|
1435
|
-
deleteMachine(id:
|
|
1439
|
+
deleteMachine(id: string): Promise<void>;
|
|
1436
1440
|
}
|
|
1437
1441
|
export declare class MachinesClient extends AuthorizedApiBase implements IMachinesClient {
|
|
1438
1442
|
private http;
|
|
@@ -1450,19 +1454,19 @@ export declare class MachinesClient extends AuthorizedApiBase implements IMachin
|
|
|
1450
1454
|
protected processUpdateMachineGroup(response: Response): Promise<void>;
|
|
1451
1455
|
deleteMachineGroup(id: string): Promise<void>;
|
|
1452
1456
|
protected processDeleteMachineGroup(response: Response): Promise<void>;
|
|
1453
|
-
listCurrentMachineStates(assetId: number | null | undefined): Promise<MachineStateListDto>;
|
|
1457
|
+
listCurrentMachineStates(assetId: number | null | undefined, assetExternalId: string | null | undefined): Promise<MachineStateListDto>;
|
|
1454
1458
|
protected processListCurrentMachineStates(response: Response): Promise<MachineStateListDto>;
|
|
1455
|
-
listMachineStates(id:
|
|
1459
|
+
listMachineStates(id: string, startTime: Date | null | undefined, endTime: Date | null | undefined): Promise<MachineStateDatapoint[]>;
|
|
1456
1460
|
protected processListMachineStates(response: Response): Promise<MachineStateDatapoint[]>;
|
|
1457
|
-
listLastDowntimeMachineStates(id:
|
|
1461
|
+
listLastDowntimeMachineStates(id: string, endTime: Date | null | undefined, maxStates: number | null | undefined): Promise<DowntimeMachineStateDto[]>;
|
|
1458
1462
|
protected processListLastDowntimeMachineStates(response: Response): Promise<DowntimeMachineStateDto[]>;
|
|
1459
|
-
getMachineStateWithDowntimePeriods(id:
|
|
1463
|
+
getMachineStateWithDowntimePeriods(id: string, timestamp: number | undefined): Promise<DowntimeMachineStateDto>;
|
|
1460
1464
|
protected processGetMachineStateWithDowntimePeriods(response: Response): Promise<DowntimeMachineStateDto>;
|
|
1461
|
-
getMachineStatesSummary(id:
|
|
1465
|
+
getMachineStatesSummary(id: string, startTime: Date | null | undefined, endTime: Date | null | undefined): Promise<MachineStatesSummaryDto>;
|
|
1462
1466
|
protected processGetMachineStatesSummary(response: Response): Promise<MachineStatesSummaryDto>;
|
|
1463
1467
|
listMachineErpData(): Promise<MachineErpDataListDto>;
|
|
1464
1468
|
protected processListMachineErpData(response: Response): Promise<MachineErpDataListDto>;
|
|
1465
|
-
getMachineErpData(id:
|
|
1469
|
+
getMachineErpData(id: string): Promise<MachineErpDataDto>;
|
|
1466
1470
|
protected processGetMachineErpData(response: Response): Promise<MachineErpDataDto>;
|
|
1467
1471
|
/**
|
|
1468
1472
|
* @param startTime (optional)
|
|
@@ -1485,13 +1489,13 @@ export declare class MachinesClient extends AuthorizedApiBase implements IMachin
|
|
|
1485
1489
|
protected processCreateResourceWithMachine(response: Response): Promise<void>;
|
|
1486
1490
|
createResourceInResourceGroup(request: CreateResourceInResourceGroup): Promise<void>;
|
|
1487
1491
|
protected processCreateResourceInResourceGroup(response: Response): Promise<void>;
|
|
1488
|
-
deleteMachine(id:
|
|
1492
|
+
deleteMachine(id: string): Promise<void>;
|
|
1489
1493
|
protected processDeleteMachine(response: Response): Promise<void>;
|
|
1490
1494
|
}
|
|
1491
1495
|
export interface IMachineDataClient {
|
|
1492
|
-
getLiveMachineData(assetId:
|
|
1493
|
-
getTimeseriesGraph(assetId:
|
|
1494
|
-
exportTimeseriesGraph(assetId:
|
|
1496
|
+
getLiveMachineData(assetId: string, externalIds: string[] | undefined): Promise<LiveMachineDataDto>;
|
|
1497
|
+
getTimeseriesGraph(assetId: string, externalIds: string[] | undefined, startTime: Date | undefined, endTime: Date | undefined): Promise<TimeseriesGraphDto>;
|
|
1498
|
+
exportTimeseriesGraph(assetId: string, request: ExportTimeseriesGraphRequest): Promise<DownloadDto>;
|
|
1495
1499
|
}
|
|
1496
1500
|
export declare class MachineDataClient extends AuthorizedApiBase implements IMachineDataClient {
|
|
1497
1501
|
private http;
|
|
@@ -1499,11 +1503,11 @@ export declare class MachineDataClient extends AuthorizedApiBase implements IMac
|
|
|
1499
1503
|
constructor(configuration: IApiClientConfig, baseUrl?: string, http?: {
|
|
1500
1504
|
fetch(url: RequestInfo, init?: RequestInit): Promise<Response>;
|
|
1501
1505
|
});
|
|
1502
|
-
getLiveMachineData(assetId:
|
|
1506
|
+
getLiveMachineData(assetId: string, externalIds: string[] | undefined): Promise<LiveMachineDataDto>;
|
|
1503
1507
|
protected processGetLiveMachineData(response: Response): Promise<LiveMachineDataDto>;
|
|
1504
|
-
getTimeseriesGraph(assetId:
|
|
1508
|
+
getTimeseriesGraph(assetId: string, externalIds: string[] | undefined, startTime: Date | undefined, endTime: Date | undefined): Promise<TimeseriesGraphDto>;
|
|
1505
1509
|
protected processGetTimeseriesGraph(response: Response): Promise<TimeseriesGraphDto>;
|
|
1506
|
-
exportTimeseriesGraph(assetId:
|
|
1510
|
+
exportTimeseriesGraph(assetId: string, request: ExportTimeseriesGraphRequest): Promise<DownloadDto>;
|
|
1507
1511
|
protected processExportTimeseriesGraph(response: Response): Promise<DownloadDto>;
|
|
1508
1512
|
}
|
|
1509
1513
|
export interface ILinksClient {
|
|
@@ -2049,9 +2053,9 @@ export interface IAssetsClient {
|
|
|
2049
2053
|
listAssets(externalIdprefix: string | null | undefined, name: string | null | undefined, source: string | null | undefined, limit: number | undefined, continuationToken: string | null | undefined): Promise<PagedResultOfAssetDto>;
|
|
2050
2054
|
createAsset(createAsset: CreateAsset): Promise<AssetDto>;
|
|
2051
2055
|
searchAssets(name: string | null | undefined, description: string | null | undefined, limit: number | undefined): Promise<AssetDto[]>;
|
|
2052
|
-
getAssetById(id:
|
|
2053
|
-
updateAsset(id:
|
|
2054
|
-
getAssetStructureById(id:
|
|
2056
|
+
getAssetById(id: string): Promise<AssetDto>;
|
|
2057
|
+
updateAsset(id: string, request: UpdateAssetRequest): Promise<AssetDto>;
|
|
2058
|
+
getAssetStructureById(id: string): Promise<AssetStructureDto>;
|
|
2055
2059
|
/**
|
|
2056
2060
|
* @deprecated
|
|
2057
2061
|
*/
|
|
@@ -2069,11 +2073,11 @@ export declare class AssetsClient extends AuthorizedApiBase implements IAssetsCl
|
|
|
2069
2073
|
protected processCreateAsset(response: Response): Promise<AssetDto>;
|
|
2070
2074
|
searchAssets(name: string | null | undefined, description: string | null | undefined, limit: number | undefined): Promise<AssetDto[]>;
|
|
2071
2075
|
protected processSearchAssets(response: Response): Promise<AssetDto[]>;
|
|
2072
|
-
getAssetById(id:
|
|
2076
|
+
getAssetById(id: string): Promise<AssetDto>;
|
|
2073
2077
|
protected processGetAssetById(response: Response): Promise<AssetDto>;
|
|
2074
|
-
updateAsset(id:
|
|
2078
|
+
updateAsset(id: string, request: UpdateAssetRequest): Promise<AssetDto>;
|
|
2075
2079
|
protected processUpdateAsset(response: Response): Promise<AssetDto>;
|
|
2076
|
-
getAssetStructureById(id:
|
|
2080
|
+
getAssetStructureById(id: string): Promise<AssetStructureDto>;
|
|
2077
2081
|
protected processGetAssetStructureById(response: Response): Promise<AssetStructureDto>;
|
|
2078
2082
|
/**
|
|
2079
2083
|
* @deprecated
|
|
@@ -3111,7 +3115,6 @@ export interface IMeasurementFormSchemasAdminClient {
|
|
|
3111
3115
|
*/
|
|
3112
3116
|
uploadSchemaDrawing(id: string, request: UploadDrawingRequest): Promise<MeasurementFormSchemaDto>;
|
|
3113
3117
|
uploadSchemaAttachment(id: string, request: UploadRequest): Promise<MeasurementFormSchemaDto>;
|
|
3114
|
-
deleteMeasurementFormSchemaFile(id: string, slot: SchemaFileSlot): Promise<void>;
|
|
3115
3118
|
getMeasurementFormImportStatus(id: string): Promise<MeasurementFormImportStatusDto>;
|
|
3116
3119
|
listLinkableMeasurementFormSchemas(schemaId: string, pageSize: number | undefined, filter: string | null | undefined, continuationToken: string | null | undefined): Promise<PagedResultOfMeasurementFormListDto>;
|
|
3117
3120
|
postListLinkableMeasurementFormSchemas(request: ListLinkableMeasurementFormSchemasRequest): Promise<PagedResultOfMeasurementFormListDto>;
|
|
@@ -3202,8 +3205,6 @@ export declare class MeasurementFormSchemasAdminClient extends AuthorizedApiBase
|
|
|
3202
3205
|
protected processUploadSchemaDrawing(response: Response): Promise<MeasurementFormSchemaDto>;
|
|
3203
3206
|
uploadSchemaAttachment(id: string, request: UploadRequest): Promise<MeasurementFormSchemaDto>;
|
|
3204
3207
|
protected processUploadSchemaAttachment(response: Response): Promise<MeasurementFormSchemaDto>;
|
|
3205
|
-
deleteMeasurementFormSchemaFile(id: string, slot: SchemaFileSlot): Promise<void>;
|
|
3206
|
-
protected processDeleteMeasurementFormSchemaFile(response: Response): Promise<void>;
|
|
3207
3208
|
getMeasurementFormImportStatus(id: string): Promise<MeasurementFormImportStatusDto>;
|
|
3208
3209
|
protected processGetMeasurementFormImportStatus(response: Response): Promise<MeasurementFormImportStatusDto>;
|
|
3209
3210
|
listLinkableMeasurementFormSchemas(schemaId: string, pageSize: number | undefined, filter: string | null | undefined, continuationToken: string | null | undefined): Promise<PagedResultOfMeasurementFormListDto>;
|
|
@@ -3302,7 +3303,6 @@ export interface IMeasurementFormSchemasClient {
|
|
|
3302
3303
|
getMeasurementFormSchema(id: string): Promise<MeasurementFormSchemaDto>;
|
|
3303
3304
|
postListMeasurementFormSchemas(request: ListMeasurementFormSchemasRequest | undefined): Promise<PagedResultOfMeasurementFormSchemaOverviewDto>;
|
|
3304
3305
|
postCountMeasurementFormSchemas(request: CountMeasurementFormSchemasRequest | undefined): Promise<MeasurementFormSchemaCountsDto>;
|
|
3305
|
-
listMeasurementFormSchemaFiles(id: string): Promise<MeasurementFormSchemaFileDto[]>;
|
|
3306
3306
|
listMeasurementFormSchemaVersions(id: string): Promise<MeasurementFormSchemaVersionDto[]>;
|
|
3307
3307
|
listMeasurementFormSchemaInstances(id: string): Promise<MeasurementFormSchemaInstanceDto[]>;
|
|
3308
3308
|
listMeasurementFormSchemaVersionChanges(id: string): Promise<MeasurementFormSchemaVersionChangesDto[]>;
|
|
@@ -3332,8 +3332,6 @@ export declare class MeasurementFormSchemasClient extends AuthorizedApiBase impl
|
|
|
3332
3332
|
protected processPostListMeasurementFormSchemas(response: Response): Promise<PagedResultOfMeasurementFormSchemaOverviewDto>;
|
|
3333
3333
|
postCountMeasurementFormSchemas(request: CountMeasurementFormSchemasRequest | undefined): Promise<MeasurementFormSchemaCountsDto>;
|
|
3334
3334
|
protected processPostCountMeasurementFormSchemas(response: Response): Promise<MeasurementFormSchemaCountsDto>;
|
|
3335
|
-
listMeasurementFormSchemaFiles(id: string): Promise<MeasurementFormSchemaFileDto[]>;
|
|
3336
|
-
protected processListMeasurementFormSchemaFiles(response: Response): Promise<MeasurementFormSchemaFileDto[]>;
|
|
3337
3335
|
listMeasurementFormSchemaVersions(id: string): Promise<MeasurementFormSchemaVersionDto[]>;
|
|
3338
3336
|
protected processListMeasurementFormSchemaVersions(response: Response): Promise<MeasurementFormSchemaVersionDto[]>;
|
|
3339
3337
|
listMeasurementFormSchemaInstances(id: string): Promise<MeasurementFormSchemaInstanceDto[]>;
|
|
@@ -3983,6 +3981,7 @@ export interface UtilizationListDto {
|
|
|
3983
3981
|
}
|
|
3984
3982
|
export interface MachineUtilizationDto {
|
|
3985
3983
|
assetId: number;
|
|
3984
|
+
assetExternalId: string;
|
|
3986
3985
|
name: string;
|
|
3987
3986
|
description?: string | null;
|
|
3988
3987
|
state: string;
|
|
@@ -4024,6 +4023,7 @@ export interface PowerOnUtilizationDto extends UtilizationAveragesDto {
|
|
|
4024
4023
|
}
|
|
4025
4024
|
export interface UtilizationDetailsDto {
|
|
4026
4025
|
machineId: number;
|
|
4026
|
+
machineExternalId: string;
|
|
4027
4027
|
machineName: string;
|
|
4028
4028
|
machineStateText?: string | null;
|
|
4029
4029
|
machineState?: MachineState | null;
|
|
@@ -4138,6 +4138,7 @@ export interface ResourceUtilizationListDto {
|
|
|
4138
4138
|
}
|
|
4139
4139
|
export interface ResourceUtilizationDto {
|
|
4140
4140
|
assetId: number;
|
|
4141
|
+
assetExternalId: string;
|
|
4141
4142
|
name: string;
|
|
4142
4143
|
description?: string | null;
|
|
4143
4144
|
state: string;
|
|
@@ -4148,6 +4149,7 @@ export interface ResourceUtilizationDto {
|
|
|
4148
4149
|
}
|
|
4149
4150
|
export interface ResourceUtilizationDetailsDto {
|
|
4150
4151
|
resourceId: number;
|
|
4152
|
+
resourceExternalId: string;
|
|
4151
4153
|
resourceName: string;
|
|
4152
4154
|
machineStateText?: string | null;
|
|
4153
4155
|
machineState?: MachineState | null;
|
|
@@ -4246,6 +4248,7 @@ export interface DataHealthDto {
|
|
|
4246
4248
|
}
|
|
4247
4249
|
export interface MachineDataHealthDto {
|
|
4248
4250
|
assetId: number;
|
|
4251
|
+
assetExternalId: string;
|
|
4249
4252
|
name: string;
|
|
4250
4253
|
description?: string | null;
|
|
4251
4254
|
state?: string | null;
|
|
@@ -4263,6 +4266,7 @@ export interface PowerRegionDto {
|
|
|
4263
4266
|
}
|
|
4264
4267
|
export interface ConsumptionDto {
|
|
4265
4268
|
assetId: number;
|
|
4269
|
+
assetExternalId: string;
|
|
4266
4270
|
assetName: string;
|
|
4267
4271
|
kwh: number;
|
|
4268
4272
|
co2Equivalent?: number | null;
|
|
@@ -4271,15 +4275,18 @@ export interface ConsumptionDto {
|
|
|
4271
4275
|
}
|
|
4272
4276
|
export interface AssetConsumptionDto {
|
|
4273
4277
|
timeseriesId: number;
|
|
4278
|
+
timeseriesExternalId?: string | null;
|
|
4274
4279
|
timeseriesName: string;
|
|
4275
4280
|
kwh: number;
|
|
4276
4281
|
assetId: number;
|
|
4282
|
+
assetExternalId?: string | null;
|
|
4277
4283
|
assetName: string;
|
|
4278
4284
|
co2Equivalent?: number | null;
|
|
4279
4285
|
co2EquivalentNotAdjustedForLocalProduction?: number | null;
|
|
4280
4286
|
}
|
|
4281
4287
|
export interface GetConsumption {
|
|
4282
4288
|
assetId?: number | null;
|
|
4289
|
+
assetExternalId?: string | null;
|
|
4283
4290
|
start?: Date | null;
|
|
4284
4291
|
end?: Date | null;
|
|
4285
4292
|
}
|
|
@@ -4289,8 +4296,10 @@ export interface PowerDto {
|
|
|
4289
4296
|
}
|
|
4290
4297
|
export interface AssetPowerDto {
|
|
4291
4298
|
timeseriesId?: number;
|
|
4299
|
+
timeseriesExternalId?: string | null;
|
|
4292
4300
|
timeseriesName?: string | null;
|
|
4293
4301
|
assetId?: number;
|
|
4302
|
+
assetExternalId?: string | null;
|
|
4294
4303
|
assetName?: string | null;
|
|
4295
4304
|
timeSeriesDataPoints?: NumericDataPointDto[] | null;
|
|
4296
4305
|
}
|
|
@@ -4302,7 +4311,8 @@ export interface NumericDataPointDto {
|
|
|
4302
4311
|
max?: number | null;
|
|
4303
4312
|
}
|
|
4304
4313
|
export interface GetPower {
|
|
4305
|
-
assetId
|
|
4314
|
+
assetId?: number | null;
|
|
4315
|
+
assetExternalId?: string | null;
|
|
4306
4316
|
granularity?: string | null;
|
|
4307
4317
|
start?: Date | null;
|
|
4308
4318
|
end?: Date | null;
|
|
@@ -4768,6 +4778,7 @@ export interface MachineStateDto {
|
|
|
4768
4778
|
state: string;
|
|
4769
4779
|
machineState: MachineState;
|
|
4770
4780
|
startTime: Date;
|
|
4781
|
+
assetExternalId: string;
|
|
4771
4782
|
}
|
|
4772
4783
|
export interface DowntimeMachineStateDto {
|
|
4773
4784
|
datapoint: MachineStateDatapoint;
|
|
@@ -4784,6 +4795,7 @@ export interface SingleResourceErpDataListDto {
|
|
|
4784
4795
|
activeOrders: ResourceErpDataDto[];
|
|
4785
4796
|
lastActiveEvent?: WorkorderOperationEventDto | null;
|
|
4786
4797
|
downtimePeriodReason?: DowntimePeriodReasonDto | null;
|
|
4798
|
+
assetExternalId: string;
|
|
4787
4799
|
}
|
|
4788
4800
|
export interface ResourceErpDataDto {
|
|
4789
4801
|
workOrderId: string;
|
|
@@ -5108,6 +5120,7 @@ export interface ResourceGroupUtilizationV2Dto {
|
|
|
5108
5120
|
}
|
|
5109
5121
|
export interface ResourceUtilizationV3Dto {
|
|
5110
5122
|
id?: number;
|
|
5123
|
+
externalId: string;
|
|
5111
5124
|
name: string;
|
|
5112
5125
|
description?: string | null;
|
|
5113
5126
|
utilization: UtilizationDetailsV2Dto;
|
|
@@ -6143,6 +6156,7 @@ export interface SingleMachineErpDataListDto {
|
|
|
6143
6156
|
activeOrders: MachineErpDataDto[];
|
|
6144
6157
|
lastActiveEvent?: WorkorderOperationEventDto | null;
|
|
6145
6158
|
downtimePeriodReason?: DowntimePeriodReasonDto | null;
|
|
6159
|
+
assetExternalId: string;
|
|
6146
6160
|
}
|
|
6147
6161
|
export interface MachineErpDataDto {
|
|
6148
6162
|
workOrderId: string;
|
|
@@ -6183,6 +6197,7 @@ export interface CrossCompanyUtilizationSummaryDto {
|
|
|
6183
6197
|
export interface LiveMachineDataDto {
|
|
6184
6198
|
assetId?: number;
|
|
6185
6199
|
dataPoints?: LiveMachineDataPointDto[];
|
|
6200
|
+
assetExternalId: string;
|
|
6186
6201
|
}
|
|
6187
6202
|
export interface LiveMachineDataPointDto {
|
|
6188
6203
|
externalId?: string;
|
|
@@ -6193,6 +6208,7 @@ export interface LiveMachineDataPointDto {
|
|
|
6193
6208
|
export interface TimeseriesGraphDto {
|
|
6194
6209
|
assetId?: number;
|
|
6195
6210
|
series?: TimeseriesGraphSeriesDto[];
|
|
6211
|
+
assetExternalId: string;
|
|
6196
6212
|
}
|
|
6197
6213
|
export interface TimeseriesGraphSeriesDto {
|
|
6198
6214
|
externalId?: string;
|
|
@@ -7211,11 +7227,13 @@ export interface AssetDto {
|
|
|
7211
7227
|
} | null;
|
|
7212
7228
|
aggregates?: any | null;
|
|
7213
7229
|
parentId?: number | null;
|
|
7230
|
+
parentExternalId?: string | null;
|
|
7214
7231
|
source?: string | null;
|
|
7215
7232
|
id?: number | null;
|
|
7216
7233
|
createdTime?: number | null;
|
|
7217
7234
|
lastUpdatedTime?: number | null;
|
|
7218
7235
|
rootId?: number | null;
|
|
7236
|
+
rootExternalId?: string | null;
|
|
7219
7237
|
}
|
|
7220
7238
|
export interface AssetStructureDto {
|
|
7221
7239
|
externalId?: string | null;
|
|
@@ -7232,7 +7250,8 @@ export interface AssetSimpleStructureDto {
|
|
|
7232
7250
|
id?: number | null;
|
|
7233
7251
|
}
|
|
7234
7252
|
export interface CreateAsset {
|
|
7235
|
-
parentId
|
|
7253
|
+
parentId?: number | null;
|
|
7254
|
+
parentExternalId?: string | null;
|
|
7236
7255
|
externalId: string;
|
|
7237
7256
|
name: string;
|
|
7238
7257
|
description: string;
|
|
@@ -7242,7 +7261,8 @@ export interface CreateAsset {
|
|
|
7242
7261
|
source?: string | null;
|
|
7243
7262
|
}
|
|
7244
7263
|
export interface UpdateAssetRequest {
|
|
7245
|
-
parentId
|
|
7264
|
+
parentId?: number | null;
|
|
7265
|
+
parentExternalId?: string | null;
|
|
7246
7266
|
name: string;
|
|
7247
7267
|
description: string;
|
|
7248
7268
|
metadata: {
|
|
@@ -9980,7 +10000,6 @@ export interface UploadRequest {
|
|
|
9980
10000
|
filename: string;
|
|
9981
10001
|
isMarkedDrawing?: boolean | null;
|
|
9982
10002
|
}
|
|
9983
|
-
export type SchemaFileSlot = "Drawing" | "ProjectFile" | "MarkedDrawing" | "SourceFile";
|
|
9984
10003
|
export interface MeasurementFormImportStatusDto {
|
|
9985
10004
|
progress: number;
|
|
9986
10005
|
totalElements: number;
|
|
@@ -10280,13 +10299,6 @@ export interface CountMeasurementFormSchemasRequest {
|
|
|
10280
10299
|
withoutCustomer?: boolean | null;
|
|
10281
10300
|
schemaCreator?: boolean | null;
|
|
10282
10301
|
}
|
|
10283
|
-
export interface MeasurementFormSchemaFileDto {
|
|
10284
|
-
slot: SchemaFileSlot;
|
|
10285
|
-
title: string;
|
|
10286
|
-
url: string;
|
|
10287
|
-
size?: number | null;
|
|
10288
|
-
lastModified?: Date | null;
|
|
10289
|
-
}
|
|
10290
10302
|
export interface MeasurementFormSchemaVersionDto {
|
|
10291
10303
|
id: string;
|
|
10292
10304
|
versionId: number;
|