@ignos/api-client 20261109.355.1-alpha → 20261109.356.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 +49 -89
- package/lib/ignosportal-api.js +17 -42
- package/package.json +1 -1
- package/src/ignosportal-api.ts +53 -109
package/lib/ignosportal-api.d.ts
CHANGED
|
@@ -220,13 +220,12 @@ export interface IMachineUtilizationClient {
|
|
|
220
220
|
time zone. The current utilization is calculated starting from the start of the current date offset from UTC
|
|
221
221
|
by the offset used. Pass in utcOffset to avoid problems relating to clock drift between
|
|
222
222
|
client and server
|
|
223
|
-
* @param
|
|
223
|
+
* @param assetExternalId (optional)
|
|
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)
|
|
228
227
|
*/
|
|
229
|
-
getMachineUtilizations(
|
|
228
|
+
getMachineUtilizations(assetExternalId: string | null | undefined, favorites: boolean | undefined, startTimeToday: Date | null | undefined, utcOffset: number | null | undefined): Promise<UtilizationListDto>;
|
|
230
229
|
getMachineUtilization(id: string, startTime: Date | undefined, endTime: Date | null | undefined): Promise<UtilizationDetailsDto>;
|
|
231
230
|
/**
|
|
232
231
|
* @param startTime (optional)
|
|
@@ -238,7 +237,7 @@ export interface IMachineUtilizationClient {
|
|
|
238
237
|
listMachineStates(id: string, startTime: Date | null | undefined, endTime: Date | null | undefined): Promise<MachineStateDatapoint[]>;
|
|
239
238
|
getMachineStatesSummary(id: string, startTime: Date | null | undefined, endTime: Date | null | undefined): Promise<MachineStatesSummaryDto>;
|
|
240
239
|
listMachineUptimesToday(request: ListMachineUptimesTodayRequest): Promise<MachineUptimesAggregateDto>;
|
|
241
|
-
listPowerOnUtilizationDatapoints(
|
|
240
|
+
listPowerOnUtilizationDatapoints(externalId: string | null | undefined, nDays: number | null | undefined, startTime: Date | null | undefined, endTime: Date | null | undefined): Promise<PowerOnUtilizationList>;
|
|
242
241
|
getFactoryUtilization(): Promise<PowerOnUtilizationDto>;
|
|
243
242
|
getProgramTimeline(id: string, startTime: Date | undefined, endTime: Date | undefined): Promise<ProgramDatapoint[]>;
|
|
244
243
|
}
|
|
@@ -255,13 +254,12 @@ export declare class MachineUtilizationClient extends AuthorizedApiBase implemen
|
|
|
255
254
|
time zone. The current utilization is calculated starting from the start of the current date offset from UTC
|
|
256
255
|
by the offset used. Pass in utcOffset to avoid problems relating to clock drift between
|
|
257
256
|
client and server
|
|
258
|
-
* @param
|
|
257
|
+
* @param assetExternalId (optional)
|
|
259
258
|
* @param favorites (optional)
|
|
260
259
|
* @param startTimeToday (optional) UTC offset for start of today's utilization is extracted from this value
|
|
261
260
|
* @param utcOffset (optional) Explicit UTC offset for start of today's utilization
|
|
262
|
-
* @param assetExternalId (optional)
|
|
263
261
|
*/
|
|
264
|
-
getMachineUtilizations(
|
|
262
|
+
getMachineUtilizations(assetExternalId: string | null | undefined, favorites: boolean | undefined, startTimeToday: Date | null | undefined, utcOffset: number | null | undefined): Promise<UtilizationListDto>;
|
|
265
263
|
protected processGetMachineUtilizations(response: Response): Promise<UtilizationListDto>;
|
|
266
264
|
getMachineUtilization(id: string, startTime: Date | undefined, endTime: Date | null | undefined): Promise<UtilizationDetailsDto>;
|
|
267
265
|
protected processGetMachineUtilization(response: Response): Promise<UtilizationDetailsDto>;
|
|
@@ -280,7 +278,7 @@ export declare class MachineUtilizationClient extends AuthorizedApiBase implemen
|
|
|
280
278
|
protected processGetMachineStatesSummary(response: Response): Promise<MachineStatesSummaryDto>;
|
|
281
279
|
listMachineUptimesToday(request: ListMachineUptimesTodayRequest): Promise<MachineUptimesAggregateDto>;
|
|
282
280
|
protected processListMachineUptimesToday(response: Response): Promise<MachineUptimesAggregateDto>;
|
|
283
|
-
listPowerOnUtilizationDatapoints(
|
|
281
|
+
listPowerOnUtilizationDatapoints(externalId: string | null | undefined, nDays: number | null | undefined, startTime: Date | null | undefined, endTime: Date | null | undefined): Promise<PowerOnUtilizationList>;
|
|
284
282
|
protected processListPowerOnUtilizationDatapoints(response: Response): Promise<PowerOnUtilizationList>;
|
|
285
283
|
getFactoryUtilization(): Promise<PowerOnUtilizationDto>;
|
|
286
284
|
protected processGetFactoryUtilization(response: Response): Promise<PowerOnUtilizationDto>;
|
|
@@ -295,19 +293,18 @@ export interface IResourceUtilizationClient {
|
|
|
295
293
|
time zone. The current utilization is calculated starting from the start of the current date offset from UTC
|
|
296
294
|
by the offset used. Pass in utcOffset to avoid problems relating to clock drift between
|
|
297
295
|
client and server
|
|
298
|
-
* @param
|
|
296
|
+
* @param assetExternalId (optional)
|
|
299
297
|
* @param favorites (optional)
|
|
300
298
|
* @param startTimeToday (optional) UTC offset for start of today's utilization is extracted from this value
|
|
301
299
|
* @param utcOffset (optional) Explicit UTC offset for start of today's utilization
|
|
302
|
-
* @param assetExternalId (optional)
|
|
303
300
|
*/
|
|
304
|
-
getResourceUtilizations(
|
|
301
|
+
getResourceUtilizations(assetExternalId: string | null | undefined, favorites: boolean | undefined, startTimeToday: Date | null | undefined, utcOffset: number | null | undefined): Promise<ResourceUtilizationListDto>;
|
|
305
302
|
getResourceUtilization(id: string, startTime: Date | undefined, endTime: Date | null | undefined): Promise<ResourceUtilizationDetailsDto>;
|
|
306
303
|
getResourceTimelines(id: string, startTime: Date | null | undefined, endTime: Date | null | undefined, filter: TimelineFilterDto | undefined): Promise<TimelinesDto>;
|
|
307
304
|
listMachineStates(id: string, startTime: Date | null | undefined, endTime: Date | null | undefined): Promise<MachineStateDatapoint[]>;
|
|
308
305
|
getMachineStatesSummary(id: string, startTime: Date | null | undefined, endTime: Date | null | undefined): Promise<MachineStatesSummaryDto>;
|
|
309
306
|
listResourceUptimesToday(request: ListResourceUptimesTodayRequest): Promise<ResourceUptimesAggregateDto>;
|
|
310
|
-
listPowerOnUtilizationDatapoints(
|
|
307
|
+
listPowerOnUtilizationDatapoints(externalId: string | null | undefined, nDays: number | null | undefined, startTime: Date | null | undefined, endTime: Date | null | undefined): Promise<PowerOnUtilizationList>;
|
|
311
308
|
getFactoryUtilization(): Promise<PowerOnUtilizationDto>;
|
|
312
309
|
getProgramTimeline(id: string, startTime: Date | undefined, endTime: Date | undefined): Promise<ProgramDatapoint[]>;
|
|
313
310
|
}
|
|
@@ -324,13 +321,12 @@ export declare class ResourceUtilizationClient extends AuthorizedApiBase impleme
|
|
|
324
321
|
time zone. The current utilization is calculated starting from the start of the current date offset from UTC
|
|
325
322
|
by the offset used. Pass in utcOffset to avoid problems relating to clock drift between
|
|
326
323
|
client and server
|
|
327
|
-
* @param
|
|
324
|
+
* @param assetExternalId (optional)
|
|
328
325
|
* @param favorites (optional)
|
|
329
326
|
* @param startTimeToday (optional) UTC offset for start of today's utilization is extracted from this value
|
|
330
327
|
* @param utcOffset (optional) Explicit UTC offset for start of today's utilization
|
|
331
|
-
* @param assetExternalId (optional)
|
|
332
328
|
*/
|
|
333
|
-
getResourceUtilizations(
|
|
329
|
+
getResourceUtilizations(assetExternalId: string | null | undefined, favorites: boolean | undefined, startTimeToday: Date | null | undefined, utcOffset: number | null | undefined): Promise<ResourceUtilizationListDto>;
|
|
334
330
|
protected processGetResourceUtilizations(response: Response): Promise<ResourceUtilizationListDto>;
|
|
335
331
|
getResourceUtilization(id: string, startTime: Date | undefined, endTime: Date | null | undefined): Promise<ResourceUtilizationDetailsDto>;
|
|
336
332
|
protected processGetResourceUtilization(response: Response): Promise<ResourceUtilizationDetailsDto>;
|
|
@@ -342,7 +338,7 @@ export declare class ResourceUtilizationClient extends AuthorizedApiBase impleme
|
|
|
342
338
|
protected processGetMachineStatesSummary(response: Response): Promise<MachineStatesSummaryDto>;
|
|
343
339
|
listResourceUptimesToday(request: ListResourceUptimesTodayRequest): Promise<ResourceUptimesAggregateDto>;
|
|
344
340
|
protected processListResourceUptimesToday(response: Response): Promise<ResourceUptimesAggregateDto>;
|
|
345
|
-
listPowerOnUtilizationDatapoints(
|
|
341
|
+
listPowerOnUtilizationDatapoints(externalId: string | null | undefined, nDays: number | null | undefined, startTime: Date | null | undefined, endTime: Date | null | undefined): Promise<PowerOnUtilizationList>;
|
|
346
342
|
protected processListPowerOnUtilizationDatapoints(response: Response): Promise<PowerOnUtilizationList>;
|
|
347
343
|
getFactoryUtilization(): Promise<PowerOnUtilizationDto>;
|
|
348
344
|
protected processGetFactoryUtilization(response: Response): Promise<PowerOnUtilizationDto>;
|
|
@@ -440,7 +436,7 @@ export declare class UploadClient extends AuthorizedApiBase implements IUploadCl
|
|
|
440
436
|
protected processCreateUploadInfoCdf(response: Response): Promise<UploadInfoCdfDto>;
|
|
441
437
|
}
|
|
442
438
|
export interface ISystemHealthDashboardClient {
|
|
443
|
-
getMachineDataHealth(
|
|
439
|
+
getMachineDataHealth(assetExternalId: string | null | undefined): Promise<DataHealthDto>;
|
|
444
440
|
}
|
|
445
441
|
export declare class SystemHealthDashboardClient extends AuthorizedApiBase implements ISystemHealthDashboardClient {
|
|
446
442
|
private http;
|
|
@@ -448,7 +444,7 @@ export declare class SystemHealthDashboardClient extends AuthorizedApiBase imple
|
|
|
448
444
|
constructor(configuration: IApiClientConfig, baseUrl?: string, http?: {
|
|
449
445
|
fetch(url: RequestInfo, init?: RequestInit): Promise<Response>;
|
|
450
446
|
});
|
|
451
|
-
getMachineDataHealth(
|
|
447
|
+
getMachineDataHealth(assetExternalId: string | null | undefined): Promise<DataHealthDto>;
|
|
452
448
|
protected processGetMachineDataHealth(response: Response): Promise<DataHealthDto>;
|
|
453
449
|
}
|
|
454
450
|
export interface IPowerClient {
|
|
@@ -655,7 +651,7 @@ export declare class KpiAdminResourceClient extends AuthorizedApiBase implements
|
|
|
655
651
|
export interface IKpiResourceClient {
|
|
656
652
|
getResourceKpi(resourceExternalId: string | undefined, previousPeriodStartDate: Date | undefined, startDate: Date | undefined, endDate: Date | undefined, utcOffset: number | undefined): Promise<ResourceKpiDto>;
|
|
657
653
|
getResourceDailyUptime(resourceExternalId: string | undefined, date: Date | undefined, utcOffset: number | undefined): Promise<ResourceDailyUptimeDto>;
|
|
658
|
-
getUptimeNormalTrend(
|
|
654
|
+
getUptimeNormalTrend(assetExternalId: string | null | undefined, date: Date | null | undefined, utcOffset: number | null | undefined): Promise<UptimeTrendDataPointDto[]>;
|
|
659
655
|
}
|
|
660
656
|
export declare class KpiResourceClient extends AuthorizedApiBase implements IKpiResourceClient {
|
|
661
657
|
private http;
|
|
@@ -667,7 +663,7 @@ export declare class KpiResourceClient extends AuthorizedApiBase implements IKpi
|
|
|
667
663
|
protected processGetResourceKpi(response: Response): Promise<ResourceKpiDto>;
|
|
668
664
|
getResourceDailyUptime(resourceExternalId: string | undefined, date: Date | undefined, utcOffset: number | undefined): Promise<ResourceDailyUptimeDto>;
|
|
669
665
|
protected processGetResourceDailyUptime(response: Response): Promise<ResourceDailyUptimeDto>;
|
|
670
|
-
getUptimeNormalTrend(
|
|
666
|
+
getUptimeNormalTrend(assetExternalId: string | null | undefined, date: Date | null | undefined, utcOffset: number | null | undefined): Promise<UptimeTrendDataPointDto[]>;
|
|
671
667
|
protected processGetUptimeNormalTrend(response: Response): Promise<UptimeTrendDataPointDto[]>;
|
|
672
668
|
}
|
|
673
669
|
export interface IResourcesClient {
|
|
@@ -676,7 +672,7 @@ export interface IResourcesClient {
|
|
|
676
672
|
createResourceGroup(request: CreateResourceGroup): Promise<CreateResourceGroupResponse>;
|
|
677
673
|
updateResourceGroup(id: string, request: UpdateResourceGroup): Promise<void>;
|
|
678
674
|
deleteResourceGroup(id: string): Promise<void>;
|
|
679
|
-
listCurrentMachineStates(
|
|
675
|
+
listCurrentMachineStates(assetExternalId: string | null | undefined): Promise<MachineStateListDto>;
|
|
680
676
|
listMachineStates(id: string, startTime: Date | null | undefined, endTime: Date | null | undefined): Promise<MachineStateDatapoint[]>;
|
|
681
677
|
listLastDowntimeMachineStates(id: string, endTime: Date | null | undefined, maxStates: number | null | undefined): Promise<DowntimeMachineStateDto[]>;
|
|
682
678
|
getMachineStateWithDowntimePeriods(id: string, timestamp: number | undefined): Promise<DowntimeMachineStateDto>;
|
|
@@ -713,7 +709,7 @@ export declare class ResourcesClient extends AuthorizedApiBase implements IResou
|
|
|
713
709
|
protected processUpdateResourceGroup(response: Response): Promise<void>;
|
|
714
710
|
deleteResourceGroup(id: string): Promise<void>;
|
|
715
711
|
protected processDeleteResourceGroup(response: Response): Promise<void>;
|
|
716
|
-
listCurrentMachineStates(
|
|
712
|
+
listCurrentMachineStates(assetExternalId: string | null | undefined): Promise<MachineStateListDto>;
|
|
717
713
|
protected processListCurrentMachineStates(response: Response): Promise<MachineStateListDto>;
|
|
718
714
|
listMachineStates(id: string, startTime: Date | null | undefined, endTime: Date | null | undefined): Promise<MachineStateDatapoint[]>;
|
|
719
715
|
protected processListMachineStates(response: Response): Promise<MachineStateDatapoint[]>;
|
|
@@ -853,11 +849,10 @@ export interface IUtilizationClient {
|
|
|
853
849
|
* @param startTime (optional)
|
|
854
850
|
* @param endTime (optional)
|
|
855
851
|
* @param ianaTimeZone (optional)
|
|
856
|
-
* @param assetId (optional)
|
|
857
852
|
* @param assetExternalId (optional)
|
|
858
853
|
* @deprecated
|
|
859
854
|
*/
|
|
860
|
-
getUtilizationDatapoints(utilizationType: UtilizationTypeDto | undefined, startTime: Date | undefined, endTime: Date | null | undefined, ianaTimeZone: string | null | undefined,
|
|
855
|
+
getUtilizationDatapoints(utilizationType: UtilizationTypeDto | undefined, startTime: Date | undefined, endTime: Date | null | undefined, ianaTimeZone: string | null | undefined, assetExternalId: string | null | undefined): Promise<MachineUtilizationDatapointListDto>;
|
|
861
856
|
getCompanyUtilizationDatapoints(request: UtilizationInputRequest): Promise<CompanyResourceUtilizationDatapointListDto>;
|
|
862
857
|
/**
|
|
863
858
|
* @param utilizationType (optional)
|
|
@@ -869,7 +864,7 @@ export interface IUtilizationClient {
|
|
|
869
864
|
getCrossCompanyUtilizationDatapoints(utilizationType: UtilizationTypeDto | undefined, startTime: Date | undefined, endTime: Date | null | undefined, ianaTimeZone: string | null | undefined): Promise<CrossCompanyUtilizationDatapointListDto>;
|
|
870
865
|
getCompanyResourceUtilization(utilizationType: ResourceUtilizationTypeDto | undefined, startTime: Date | undefined, endTime: Date | null | undefined, ianaTimeZone: string | null | undefined): Promise<CompanyResourceUtilizationDto>;
|
|
871
866
|
getCrossCompanyResourceUtilization(utilizationType: ResourceUtilizationTypeDto | undefined, startTime: Date | undefined, endTime: Date | null | undefined, ianaTimeZone: string | null | undefined): Promise<CrossCompanyResourceUtilizationDto>;
|
|
872
|
-
getResourceUtilizationDatapoints(utilizationType: ResourceUtilizationTypeDto | undefined, startTime: Date | undefined, endTime: Date | null | undefined, ianaTimeZone: string | null | undefined,
|
|
867
|
+
getResourceUtilizationDatapoints(utilizationType: ResourceUtilizationTypeDto | undefined, startTime: Date | undefined, endTime: Date | null | undefined, ianaTimeZone: string | null | undefined, assetExternalId: string | null | undefined): Promise<ResourceUtilizationDatapointListDto>;
|
|
873
868
|
getCompanyResourceUtilizationDatapoints(utilizationType: ResourceUtilizationTypeDto | undefined, startTime: Date | undefined, endTime: Date | null | undefined, ianaTimeZone: string | null | undefined): Promise<CompanyResourceUtilizationDatapointListDto>;
|
|
874
869
|
getCrossCompanyResourceUtilizationDatapoints(utilizationType: ResourceUtilizationTypeDto | undefined, startTime: Date | undefined, endTime: Date | null | undefined, ianaTimeZone: string | null | undefined): Promise<CrossCompanyResourceUtilizationDatapointListDto>;
|
|
875
870
|
}
|
|
@@ -895,11 +890,10 @@ export declare class UtilizationClient extends AuthorizedApiBase implements IUti
|
|
|
895
890
|
* @param startTime (optional)
|
|
896
891
|
* @param endTime (optional)
|
|
897
892
|
* @param ianaTimeZone (optional)
|
|
898
|
-
* @param assetId (optional)
|
|
899
893
|
* @param assetExternalId (optional)
|
|
900
894
|
* @deprecated
|
|
901
895
|
*/
|
|
902
|
-
getUtilizationDatapoints(utilizationType: UtilizationTypeDto | undefined, startTime: Date | undefined, endTime: Date | null | undefined, ianaTimeZone: string | null | undefined,
|
|
896
|
+
getUtilizationDatapoints(utilizationType: UtilizationTypeDto | undefined, startTime: Date | undefined, endTime: Date | null | undefined, ianaTimeZone: string | null | undefined, assetExternalId: string | null | undefined): Promise<MachineUtilizationDatapointListDto>;
|
|
903
897
|
protected processGetUtilizationDatapoints(response: Response): Promise<MachineUtilizationDatapointListDto>;
|
|
904
898
|
getCompanyUtilizationDatapoints(request: UtilizationInputRequest): Promise<CompanyResourceUtilizationDatapointListDto>;
|
|
905
899
|
protected processGetCompanyUtilizationDatapoints(response: Response): Promise<CompanyResourceUtilizationDatapointListDto>;
|
|
@@ -916,7 +910,7 @@ export declare class UtilizationClient extends AuthorizedApiBase implements IUti
|
|
|
916
910
|
protected processGetCompanyResourceUtilization(response: Response): Promise<CompanyResourceUtilizationDto>;
|
|
917
911
|
getCrossCompanyResourceUtilization(utilizationType: ResourceUtilizationTypeDto | undefined, startTime: Date | undefined, endTime: Date | null | undefined, ianaTimeZone: string | null | undefined): Promise<CrossCompanyResourceUtilizationDto>;
|
|
918
912
|
protected processGetCrossCompanyResourceUtilization(response: Response): Promise<CrossCompanyResourceUtilizationDto>;
|
|
919
|
-
getResourceUtilizationDatapoints(utilizationType: ResourceUtilizationTypeDto | undefined, startTime: Date | undefined, endTime: Date | null | undefined, ianaTimeZone: string | null | undefined,
|
|
913
|
+
getResourceUtilizationDatapoints(utilizationType: ResourceUtilizationTypeDto | undefined, startTime: Date | undefined, endTime: Date | null | undefined, ianaTimeZone: string | null | undefined, assetExternalId: string | null | undefined): Promise<ResourceUtilizationDatapointListDto>;
|
|
920
914
|
protected processGetResourceUtilizationDatapoints(response: Response): Promise<ResourceUtilizationDatapointListDto>;
|
|
921
915
|
getCompanyResourceUtilizationDatapoints(utilizationType: ResourceUtilizationTypeDto | undefined, startTime: Date | undefined, endTime: Date | null | undefined, ianaTimeZone: string | null | undefined): Promise<CompanyResourceUtilizationDatapointListDto>;
|
|
922
916
|
protected processGetCompanyResourceUtilizationDatapoints(response: Response): Promise<CompanyResourceUtilizationDatapointListDto>;
|
|
@@ -1395,7 +1389,7 @@ export declare class KpiAdminClient extends AuthorizedApiBase implements IKpiAdm
|
|
|
1395
1389
|
export interface IKpiClient {
|
|
1396
1390
|
getMachineKpi(machineExternalId: string | undefined, previousPeriodStartDate: Date | undefined, startDate: Date | undefined, endDate: Date | undefined, utcOffset: number | undefined): Promise<MachineKpiDto>;
|
|
1397
1391
|
getMachineDailyUptime(machineExternalId: string | undefined, date: Date | undefined, utcOffset: number | undefined): Promise<MachineDailyUptimeDto>;
|
|
1398
|
-
getUptimeNormalTrend(
|
|
1392
|
+
getUptimeNormalTrend(assetExternalId: string | null | undefined, date: Date | null | undefined, utcOffset: number | null | undefined): Promise<UptimeTrendDataPointDto[]>;
|
|
1399
1393
|
}
|
|
1400
1394
|
export declare class KpiClient extends AuthorizedApiBase implements IKpiClient {
|
|
1401
1395
|
private http;
|
|
@@ -1407,7 +1401,7 @@ export declare class KpiClient extends AuthorizedApiBase implements IKpiClient {
|
|
|
1407
1401
|
protected processGetMachineKpi(response: Response): Promise<MachineKpiDto>;
|
|
1408
1402
|
getMachineDailyUptime(machineExternalId: string | undefined, date: Date | undefined, utcOffset: number | undefined): Promise<MachineDailyUptimeDto>;
|
|
1409
1403
|
protected processGetMachineDailyUptime(response: Response): Promise<MachineDailyUptimeDto>;
|
|
1410
|
-
getUptimeNormalTrend(
|
|
1404
|
+
getUptimeNormalTrend(assetExternalId: string | null | undefined, date: Date | null | undefined, utcOffset: number | null | undefined): Promise<UptimeTrendDataPointDto[]>;
|
|
1411
1405
|
protected processGetUptimeNormalTrend(response: Response): Promise<UptimeTrendDataPointDto[]>;
|
|
1412
1406
|
}
|
|
1413
1407
|
export interface IMachinesClient {
|
|
@@ -1416,7 +1410,7 @@ export interface IMachinesClient {
|
|
|
1416
1410
|
createMachineGroup(request: CreateMachineGroup): Promise<CreateMachineGroupResponse>;
|
|
1417
1411
|
updateMachineGroup(id: string, request: UpdateMachineGroup): Promise<void>;
|
|
1418
1412
|
deleteMachineGroup(id: string): Promise<void>;
|
|
1419
|
-
listCurrentMachineStates(
|
|
1413
|
+
listCurrentMachineStates(assetExternalId: string | null | undefined): Promise<MachineStateListDto>;
|
|
1420
1414
|
listMachineStates(id: string, startTime: Date | null | undefined, endTime: Date | null | undefined): Promise<MachineStateDatapoint[]>;
|
|
1421
1415
|
listLastDowntimeMachineStates(id: string, endTime: Date | null | undefined, maxStates: number | null | undefined): Promise<DowntimeMachineStateDto[]>;
|
|
1422
1416
|
getMachineStateWithDowntimePeriods(id: string, timestamp: number | undefined): Promise<DowntimeMachineStateDto>;
|
|
@@ -1454,7 +1448,7 @@ export declare class MachinesClient extends AuthorizedApiBase implements IMachin
|
|
|
1454
1448
|
protected processUpdateMachineGroup(response: Response): Promise<void>;
|
|
1455
1449
|
deleteMachineGroup(id: string): Promise<void>;
|
|
1456
1450
|
protected processDeleteMachineGroup(response: Response): Promise<void>;
|
|
1457
|
-
listCurrentMachineStates(
|
|
1451
|
+
listCurrentMachineStates(assetExternalId: string | null | undefined): Promise<MachineStateListDto>;
|
|
1458
1452
|
protected processListCurrentMachineStates(response: Response): Promise<MachineStateListDto>;
|
|
1459
1453
|
listMachineStates(id: string, startTime: Date | null | undefined, endTime: Date | null | undefined): Promise<MachineStateDatapoint[]>;
|
|
1460
1454
|
protected processListMachineStates(response: Response): Promise<MachineStateDatapoint[]>;
|
|
@@ -3980,7 +3974,6 @@ export interface UtilizationListDto {
|
|
|
3980
3974
|
machines?: MachineUtilizationDto[] | null;
|
|
3981
3975
|
}
|
|
3982
3976
|
export interface MachineUtilizationDto {
|
|
3983
|
-
assetId: number;
|
|
3984
3977
|
assetExternalId: string;
|
|
3985
3978
|
name: string;
|
|
3986
3979
|
description?: string | null;
|
|
@@ -4022,7 +4015,6 @@ export interface PowerOnUtilizationDto extends UtilizationAveragesDto {
|
|
|
4022
4015
|
comparedToAverage?: number | null;
|
|
4023
4016
|
}
|
|
4024
4017
|
export interface UtilizationDetailsDto {
|
|
4025
|
-
machineId: number;
|
|
4026
4018
|
machineExternalId: string;
|
|
4027
4019
|
machineName: string;
|
|
4028
4020
|
machineStateText?: string | null;
|
|
@@ -4124,7 +4116,7 @@ export interface PowerOnUtilizationList {
|
|
|
4124
4116
|
}
|
|
4125
4117
|
export interface Machine {
|
|
4126
4118
|
externalId?: string;
|
|
4127
|
-
id?: number;
|
|
4119
|
+
id?: number | null;
|
|
4128
4120
|
name?: string;
|
|
4129
4121
|
description?: string | null;
|
|
4130
4122
|
datapoints?: NumericNullableValueWithTimestamp[];
|
|
@@ -4137,7 +4129,6 @@ export interface ResourceUtilizationListDto {
|
|
|
4137
4129
|
resources?: ResourceUtilizationDto[] | null;
|
|
4138
4130
|
}
|
|
4139
4131
|
export interface ResourceUtilizationDto {
|
|
4140
|
-
assetId: number;
|
|
4141
4132
|
assetExternalId: string;
|
|
4142
4133
|
name: string;
|
|
4143
4134
|
description?: string | null;
|
|
@@ -4148,7 +4139,6 @@ export interface ResourceUtilizationDto {
|
|
|
4148
4139
|
powerOn?: PowerOnUtilizationDto | null;
|
|
4149
4140
|
}
|
|
4150
4141
|
export interface ResourceUtilizationDetailsDto {
|
|
4151
|
-
resourceId: number;
|
|
4152
4142
|
resourceExternalId: string;
|
|
4153
4143
|
resourceName: string;
|
|
4154
4144
|
machineStateText?: string | null;
|
|
@@ -4237,6 +4227,7 @@ export interface UploadInfoDto {
|
|
|
4237
4227
|
accessKey?: string | null;
|
|
4238
4228
|
}
|
|
4239
4229
|
export interface UploadInfoCdfDto {
|
|
4230
|
+
externalId: string;
|
|
4240
4231
|
id: number;
|
|
4241
4232
|
url: string;
|
|
4242
4233
|
}
|
|
@@ -4247,7 +4238,6 @@ export interface DataHealthDto {
|
|
|
4247
4238
|
machines?: MachineDataHealthDto[] | null;
|
|
4248
4239
|
}
|
|
4249
4240
|
export interface MachineDataHealthDto {
|
|
4250
|
-
assetId: number;
|
|
4251
4241
|
assetExternalId: string;
|
|
4252
4242
|
name: string;
|
|
4253
4243
|
description?: string | null;
|
|
@@ -4265,7 +4255,6 @@ export interface PowerRegionDto {
|
|
|
4265
4255
|
description?: string | null;
|
|
4266
4256
|
}
|
|
4267
4257
|
export interface ConsumptionDto {
|
|
4268
|
-
assetId: number;
|
|
4269
4258
|
assetExternalId: string;
|
|
4270
4259
|
assetName: string;
|
|
4271
4260
|
kwh: number;
|
|
@@ -4274,18 +4263,15 @@ export interface ConsumptionDto {
|
|
|
4274
4263
|
items?: AssetConsumptionDto[] | null;
|
|
4275
4264
|
}
|
|
4276
4265
|
export interface AssetConsumptionDto {
|
|
4277
|
-
|
|
4278
|
-
timeseriesExternalId?: string | null;
|
|
4266
|
+
timeseriesExternalId: string;
|
|
4279
4267
|
timeseriesName: string;
|
|
4280
4268
|
kwh: number;
|
|
4281
|
-
|
|
4282
|
-
assetExternalId?: string | null;
|
|
4269
|
+
assetExternalId: string;
|
|
4283
4270
|
assetName: string;
|
|
4284
4271
|
co2Equivalent?: number | null;
|
|
4285
4272
|
co2EquivalentNotAdjustedForLocalProduction?: number | null;
|
|
4286
4273
|
}
|
|
4287
4274
|
export interface GetConsumption {
|
|
4288
|
-
assetId?: number | null;
|
|
4289
4275
|
assetExternalId?: string | null;
|
|
4290
4276
|
start?: Date | null;
|
|
4291
4277
|
end?: Date | null;
|
|
@@ -4295,10 +4281,8 @@ export interface PowerDto {
|
|
|
4295
4281
|
assets?: AssetPowerDto[] | null;
|
|
4296
4282
|
}
|
|
4297
4283
|
export interface AssetPowerDto {
|
|
4298
|
-
timeseriesId?: number;
|
|
4299
4284
|
timeseriesExternalId?: string | null;
|
|
4300
4285
|
timeseriesName?: string | null;
|
|
4301
|
-
assetId?: number;
|
|
4302
4286
|
assetExternalId?: string | null;
|
|
4303
4287
|
assetName?: string | null;
|
|
4304
4288
|
timeSeriesDataPoints?: NumericDataPointDto[] | null;
|
|
@@ -4311,8 +4295,7 @@ export interface NumericDataPointDto {
|
|
|
4311
4295
|
max?: number | null;
|
|
4312
4296
|
}
|
|
4313
4297
|
export interface GetPower {
|
|
4314
|
-
|
|
4315
|
-
assetExternalId?: string | null;
|
|
4298
|
+
assetExternalId: string;
|
|
4316
4299
|
granularity?: string | null;
|
|
4317
4300
|
start?: Date | null;
|
|
4318
4301
|
end?: Date | null;
|
|
@@ -4732,7 +4715,7 @@ export interface UptimeTrendDataPointDto {
|
|
|
4732
4715
|
uptime: number;
|
|
4733
4716
|
}
|
|
4734
4717
|
export interface ApplicationResourcesResourceDto {
|
|
4735
|
-
id
|
|
4718
|
+
id?: number | null;
|
|
4736
4719
|
externalId: string;
|
|
4737
4720
|
name: string;
|
|
4738
4721
|
description?: string | null;
|
|
@@ -4750,7 +4733,6 @@ export interface ApplicationResourcesResourceGroupDto {
|
|
|
4750
4733
|
resources: ResourceGroupMemberDto[];
|
|
4751
4734
|
}
|
|
4752
4735
|
export interface ResourceGroupMemberDto {
|
|
4753
|
-
id: number;
|
|
4754
4736
|
externalId: string;
|
|
4755
4737
|
name: string;
|
|
4756
4738
|
description?: string | null;
|
|
@@ -4772,13 +4754,12 @@ export interface MachineStateListDto {
|
|
|
4772
4754
|
machines?: MachineStateDto[] | null;
|
|
4773
4755
|
}
|
|
4774
4756
|
export interface MachineStateDto {
|
|
4775
|
-
|
|
4757
|
+
assetExternalId: string;
|
|
4776
4758
|
name: string;
|
|
4777
4759
|
description?: string | null;
|
|
4778
4760
|
state: string;
|
|
4779
4761
|
machineState: MachineState;
|
|
4780
4762
|
startTime: Date;
|
|
4781
|
-
assetExternalId: string;
|
|
4782
4763
|
}
|
|
4783
4764
|
export interface DowntimeMachineStateDto {
|
|
4784
4765
|
datapoint: MachineStateDatapoint;
|
|
@@ -4789,13 +4770,12 @@ export interface ResourceErpDataListDto {
|
|
|
4789
4770
|
resources: SingleResourceErpDataListDto[];
|
|
4790
4771
|
}
|
|
4791
4772
|
export interface SingleResourceErpDataListDto {
|
|
4792
|
-
|
|
4773
|
+
assetExternalId: string;
|
|
4793
4774
|
name: string;
|
|
4794
4775
|
description?: string;
|
|
4795
4776
|
activeOrders: ResourceErpDataDto[];
|
|
4796
4777
|
lastActiveEvent?: WorkorderOperationEventDto | null;
|
|
4797
4778
|
downtimePeriodReason?: DowntimePeriodReasonDto | null;
|
|
4798
|
-
assetExternalId: string;
|
|
4799
4779
|
}
|
|
4800
4780
|
export interface ResourceErpDataDto {
|
|
4801
4781
|
workOrderId: string;
|
|
@@ -4900,7 +4880,7 @@ export interface ResourceGroupUtilizationDto {
|
|
|
4900
4880
|
resources: ResourceUtilizationV2Dto[];
|
|
4901
4881
|
}
|
|
4902
4882
|
export interface ResourceUtilizationV2Dto {
|
|
4903
|
-
id?: number;
|
|
4883
|
+
id?: number | null;
|
|
4904
4884
|
name: string;
|
|
4905
4885
|
description?: string | null;
|
|
4906
4886
|
utilization: UtilizationDto;
|
|
@@ -4916,7 +4896,7 @@ export interface OperatorAndMachineDto {
|
|
|
4916
4896
|
resource?: ApplicationResourcesResourceDto | null;
|
|
4917
4897
|
}
|
|
4918
4898
|
export interface MachineDto {
|
|
4919
|
-
id
|
|
4899
|
+
id?: number | null;
|
|
4920
4900
|
externalId: string;
|
|
4921
4901
|
name: string;
|
|
4922
4902
|
description?: string | null;
|
|
@@ -5119,7 +5099,7 @@ export interface ResourceGroupUtilizationV2Dto {
|
|
|
5119
5099
|
resources: ResourceUtilizationV3Dto[];
|
|
5120
5100
|
}
|
|
5121
5101
|
export interface ResourceUtilizationV3Dto {
|
|
5122
|
-
id?: number;
|
|
5102
|
+
id?: number | null;
|
|
5123
5103
|
externalId: string;
|
|
5124
5104
|
name: string;
|
|
5125
5105
|
description?: string | null;
|
|
@@ -5154,7 +5134,7 @@ export interface MachineGroupUtilizationV2Dto {
|
|
|
5154
5134
|
machines: MachineUtilizationV3Dto[];
|
|
5155
5135
|
}
|
|
5156
5136
|
export interface MachineUtilizationV3Dto {
|
|
5157
|
-
id?: number;
|
|
5137
|
+
id?: number | null;
|
|
5158
5138
|
name: string;
|
|
5159
5139
|
description?: string | null;
|
|
5160
5140
|
utilization: UtilizationDetailsV2Dto;
|
|
@@ -5166,7 +5146,7 @@ export interface UtilizationDatapointListDto {
|
|
|
5166
5146
|
}
|
|
5167
5147
|
export interface MachineUtilizationDatapointListDto extends UtilizationDatapointListDto {
|
|
5168
5148
|
externalId: string;
|
|
5169
|
-
id
|
|
5149
|
+
id?: number | null;
|
|
5170
5150
|
name: string;
|
|
5171
5151
|
description?: string | null;
|
|
5172
5152
|
}
|
|
@@ -5181,7 +5161,7 @@ export interface ResourceGroupUtilizationDatapointListDto extends UtilizationDat
|
|
|
5181
5161
|
}
|
|
5182
5162
|
export interface ResourceUtilizationDatapointListDto extends UtilizationDatapointListDto {
|
|
5183
5163
|
externalId: string;
|
|
5184
|
-
id
|
|
5164
|
+
id?: number | null;
|
|
5185
5165
|
name: string;
|
|
5186
5166
|
description?: string | null;
|
|
5187
5167
|
}
|
|
@@ -6128,7 +6108,6 @@ export interface MachineGroupDto {
|
|
|
6128
6108
|
machines: MachineGroupMemberDto[];
|
|
6129
6109
|
}
|
|
6130
6110
|
export interface MachineGroupMemberDto {
|
|
6131
|
-
id: number;
|
|
6132
6111
|
externalId: string;
|
|
6133
6112
|
name: string;
|
|
6134
6113
|
description?: string | null;
|
|
@@ -6150,13 +6129,12 @@ export interface MachineErpDataListDto {
|
|
|
6150
6129
|
machines: SingleMachineErpDataListDto[];
|
|
6151
6130
|
}
|
|
6152
6131
|
export interface SingleMachineErpDataListDto {
|
|
6153
|
-
|
|
6132
|
+
assetExternalId: string;
|
|
6154
6133
|
name: string;
|
|
6155
6134
|
description?: string;
|
|
6156
6135
|
activeOrders: MachineErpDataDto[];
|
|
6157
6136
|
lastActiveEvent?: WorkorderOperationEventDto | null;
|
|
6158
6137
|
downtimePeriodReason?: DowntimePeriodReasonDto | null;
|
|
6159
|
-
assetExternalId: string;
|
|
6160
6138
|
}
|
|
6161
6139
|
export interface MachineErpDataDto {
|
|
6162
6140
|
workOrderId: string;
|
|
@@ -6185,7 +6163,7 @@ export interface MachineGroupUtilizationDto {
|
|
|
6185
6163
|
machines: MachineUtilizationV2Dto[];
|
|
6186
6164
|
}
|
|
6187
6165
|
export interface MachineUtilizationV2Dto {
|
|
6188
|
-
id?: number;
|
|
6166
|
+
id?: number | null;
|
|
6189
6167
|
name: string;
|
|
6190
6168
|
description?: string | null;
|
|
6191
6169
|
utilization: UtilizationDto;
|
|
@@ -6195,9 +6173,8 @@ export interface CrossCompanyUtilizationSummaryDto {
|
|
|
6195
6173
|
companies: MachineGroupUtilizationDto[];
|
|
6196
6174
|
}
|
|
6197
6175
|
export interface LiveMachineDataDto {
|
|
6198
|
-
|
|
6176
|
+
assetExternalId?: string;
|
|
6199
6177
|
dataPoints?: LiveMachineDataPointDto[];
|
|
6200
|
-
assetExternalId: string;
|
|
6201
6178
|
}
|
|
6202
6179
|
export interface LiveMachineDataPointDto {
|
|
6203
6180
|
externalId?: string;
|
|
@@ -6206,9 +6183,8 @@ export interface LiveMachineDataPointDto {
|
|
|
6206
6183
|
stringValue?: string | null;
|
|
6207
6184
|
}
|
|
6208
6185
|
export interface TimeseriesGraphDto {
|
|
6209
|
-
|
|
6186
|
+
assetExternalId?: string;
|
|
6210
6187
|
series?: TimeseriesGraphSeriesDto[];
|
|
6211
|
-
assetExternalId: string;
|
|
6212
6188
|
}
|
|
6213
6189
|
export interface TimeseriesGraphSeriesDto {
|
|
6214
6190
|
externalId?: string;
|
|
@@ -7222,52 +7198,36 @@ export interface AssetDto {
|
|
|
7222
7198
|
externalId?: string | null;
|
|
7223
7199
|
name?: string | null;
|
|
7224
7200
|
description?: string | null;
|
|
7225
|
-
metadata?: {
|
|
7226
|
-
[key: string]: string;
|
|
7227
|
-
} | null;
|
|
7228
|
-
aggregates?: any | null;
|
|
7229
|
-
parentId?: number | null;
|
|
7230
7201
|
parentExternalId?: string | null;
|
|
7202
|
+
rootExternalId?: string | null;
|
|
7231
7203
|
source?: string | null;
|
|
7232
7204
|
id?: number | null;
|
|
7233
7205
|
createdTime?: number | null;
|
|
7234
7206
|
lastUpdatedTime?: number | null;
|
|
7235
|
-
rootId?: number | null;
|
|
7236
|
-
rootExternalId?: string | null;
|
|
7237
7207
|
}
|
|
7238
7208
|
export interface AssetStructureDto {
|
|
7239
7209
|
externalId?: string | null;
|
|
7240
7210
|
name?: string | null;
|
|
7241
7211
|
aggregatesDisplay?: string | null;
|
|
7242
7212
|
aggregates?: AssetSimpleStructureDto[] | null;
|
|
7243
|
-
id?: number | null;
|
|
7244
7213
|
createdTime?: number | null;
|
|
7245
7214
|
lastUpdatedTime?: number | null;
|
|
7246
7215
|
}
|
|
7247
7216
|
export interface AssetSimpleStructureDto {
|
|
7248
7217
|
externalId?: string | null;
|
|
7249
7218
|
name?: string | null;
|
|
7250
|
-
id?: number | null;
|
|
7251
7219
|
}
|
|
7252
7220
|
export interface CreateAsset {
|
|
7253
|
-
|
|
7254
|
-
parentExternalId?: string | null;
|
|
7221
|
+
parentExternalId: string;
|
|
7255
7222
|
externalId: string;
|
|
7256
7223
|
name: string;
|
|
7257
7224
|
description: string;
|
|
7258
|
-
metadata: {
|
|
7259
|
-
[key: string]: string;
|
|
7260
|
-
};
|
|
7261
7225
|
source?: string | null;
|
|
7262
7226
|
}
|
|
7263
7227
|
export interface UpdateAssetRequest {
|
|
7264
|
-
|
|
7265
|
-
parentExternalId?: string | null;
|
|
7228
|
+
parentExternalId: string;
|
|
7266
7229
|
name: string;
|
|
7267
7230
|
description: string;
|
|
7268
|
-
metadata: {
|
|
7269
|
-
[key: string]: string;
|
|
7270
|
-
};
|
|
7271
7231
|
source?: string | null;
|
|
7272
7232
|
}
|
|
7273
7233
|
export interface AlertNotificationAccessDto {
|
|
@@ -8627,7 +8587,6 @@ export interface ElectricalIotConfigDto {
|
|
|
8627
8587
|
export interface CreateElectricalIotConfig {
|
|
8628
8588
|
typeId?: string | null;
|
|
8629
8589
|
serialNumber?: string | null;
|
|
8630
|
-
assetId?: number | null;
|
|
8631
8590
|
assetExternalId?: string | null;
|
|
8632
8591
|
}
|
|
8633
8592
|
export interface WeldingIotConfigDto {
|
|
@@ -9407,7 +9366,8 @@ export interface ProcessMaterialCertificate {
|
|
|
9407
9366
|
purchaseOrderLine?: number | null;
|
|
9408
9367
|
}
|
|
9409
9368
|
export interface UploadFileCdfDto {
|
|
9410
|
-
id
|
|
9369
|
+
id?: number | null;
|
|
9370
|
+
externalId: string;
|
|
9411
9371
|
}
|
|
9412
9372
|
export interface ImaMaterialCheckReportDto {
|
|
9413
9373
|
file: FileDto;
|