@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.js
CHANGED
|
@@ -1350,16 +1350,15 @@ export class MachineUtilizationClient extends AuthorizedApiBase {
|
|
|
1350
1350
|
time zone. The current utilization is calculated starting from the start of the current date offset from UTC
|
|
1351
1351
|
by the offset used. Pass in utcOffset to avoid problems relating to clock drift between
|
|
1352
1352
|
client and server
|
|
1353
|
-
* @param
|
|
1353
|
+
* @param assetExternalId (optional)
|
|
1354
1354
|
* @param favorites (optional)
|
|
1355
1355
|
* @param startTimeToday (optional) UTC offset for start of today's utilization is extracted from this value
|
|
1356
1356
|
* @param utcOffset (optional) Explicit UTC offset for start of today's utilization
|
|
1357
|
-
* @param assetExternalId (optional)
|
|
1358
1357
|
*/
|
|
1359
|
-
getMachineUtilizations(
|
|
1358
|
+
getMachineUtilizations(assetExternalId, favorites, startTimeToday, utcOffset) {
|
|
1360
1359
|
let url_ = this.baseUrl + "/machineutilization?";
|
|
1361
|
-
if (
|
|
1362
|
-
url_ += "
|
|
1360
|
+
if (assetExternalId !== undefined && assetExternalId !== null)
|
|
1361
|
+
url_ += "assetExternalId=" + encodeURIComponent("" + assetExternalId) + "&";
|
|
1363
1362
|
if (favorites === null)
|
|
1364
1363
|
throw new globalThis.Error("The parameter 'favorites' cannot be null.");
|
|
1365
1364
|
else if (favorites !== undefined)
|
|
@@ -1368,8 +1367,6 @@ export class MachineUtilizationClient extends AuthorizedApiBase {
|
|
|
1368
1367
|
url_ += "startTimeToday=" + encodeURIComponent(startTimeToday ? "" + startTimeToday.toISOString() : "") + "&";
|
|
1369
1368
|
if (utcOffset !== undefined && utcOffset !== null)
|
|
1370
1369
|
url_ += "utcOffset=" + encodeURIComponent("" + utcOffset) + "&";
|
|
1371
|
-
if (assetExternalId !== undefined && assetExternalId !== null)
|
|
1372
|
-
url_ += "assetExternalId=" + encodeURIComponent("" + assetExternalId) + "&";
|
|
1373
1370
|
url_ = url_.replace(/[?&]$/, "");
|
|
1374
1371
|
let options_ = {
|
|
1375
1372
|
method: "GET",
|
|
@@ -1668,10 +1665,8 @@ export class MachineUtilizationClient extends AuthorizedApiBase {
|
|
|
1668
1665
|
}
|
|
1669
1666
|
return Promise.resolve(null);
|
|
1670
1667
|
}
|
|
1671
|
-
listPowerOnUtilizationDatapoints(
|
|
1668
|
+
listPowerOnUtilizationDatapoints(externalId, nDays, startTime, endTime) {
|
|
1672
1669
|
let url_ = this.baseUrl + "/machineutilization/power-on/datapoints?";
|
|
1673
|
-
if (id !== undefined && id !== null)
|
|
1674
|
-
url_ += "id=" + encodeURIComponent("" + id) + "&";
|
|
1675
1670
|
if (externalId !== undefined && externalId !== null)
|
|
1676
1671
|
url_ += "externalId=" + encodeURIComponent("" + externalId) + "&";
|
|
1677
1672
|
if (nDays !== undefined && nDays !== null)
|
|
@@ -1813,16 +1808,15 @@ export class ResourceUtilizationClient extends AuthorizedApiBase {
|
|
|
1813
1808
|
time zone. The current utilization is calculated starting from the start of the current date offset from UTC
|
|
1814
1809
|
by the offset used. Pass in utcOffset to avoid problems relating to clock drift between
|
|
1815
1810
|
client and server
|
|
1816
|
-
* @param
|
|
1811
|
+
* @param assetExternalId (optional)
|
|
1817
1812
|
* @param favorites (optional)
|
|
1818
1813
|
* @param startTimeToday (optional) UTC offset for start of today's utilization is extracted from this value
|
|
1819
1814
|
* @param utcOffset (optional) Explicit UTC offset for start of today's utilization
|
|
1820
|
-
* @param assetExternalId (optional)
|
|
1821
1815
|
*/
|
|
1822
|
-
getResourceUtilizations(
|
|
1816
|
+
getResourceUtilizations(assetExternalId, favorites, startTimeToday, utcOffset) {
|
|
1823
1817
|
let url_ = this.baseUrl + "/resourceutilization?";
|
|
1824
|
-
if (
|
|
1825
|
-
url_ += "
|
|
1818
|
+
if (assetExternalId !== undefined && assetExternalId !== null)
|
|
1819
|
+
url_ += "assetExternalId=" + encodeURIComponent("" + assetExternalId) + "&";
|
|
1826
1820
|
if (favorites === null)
|
|
1827
1821
|
throw new globalThis.Error("The parameter 'favorites' cannot be null.");
|
|
1828
1822
|
else if (favorites !== undefined)
|
|
@@ -1831,8 +1825,6 @@ export class ResourceUtilizationClient extends AuthorizedApiBase {
|
|
|
1831
1825
|
url_ += "startTimeToday=" + encodeURIComponent(startTimeToday ? "" + startTimeToday.toISOString() : "") + "&";
|
|
1832
1826
|
if (utcOffset !== undefined && utcOffset !== null)
|
|
1833
1827
|
url_ += "utcOffset=" + encodeURIComponent("" + utcOffset) + "&";
|
|
1834
|
-
if (assetExternalId !== undefined && assetExternalId !== null)
|
|
1835
|
-
url_ += "assetExternalId=" + encodeURIComponent("" + assetExternalId) + "&";
|
|
1836
1828
|
url_ = url_.replace(/[?&]$/, "");
|
|
1837
1829
|
let options_ = {
|
|
1838
1830
|
method: "GET",
|
|
@@ -2083,10 +2075,8 @@ export class ResourceUtilizationClient extends AuthorizedApiBase {
|
|
|
2083
2075
|
}
|
|
2084
2076
|
return Promise.resolve(null);
|
|
2085
2077
|
}
|
|
2086
|
-
listPowerOnUtilizationDatapoints(
|
|
2078
|
+
listPowerOnUtilizationDatapoints(externalId, nDays, startTime, endTime) {
|
|
2087
2079
|
let url_ = this.baseUrl + "/resourceutilization/power-on/datapoints?";
|
|
2088
|
-
if (id !== undefined && id !== null)
|
|
2089
|
-
url_ += "id=" + encodeURIComponent("" + id) + "&";
|
|
2090
2080
|
if (externalId !== undefined && externalId !== null)
|
|
2091
2081
|
url_ += "externalId=" + encodeURIComponent("" + externalId) + "&";
|
|
2092
2082
|
if (nDays !== undefined && nDays !== null)
|
|
@@ -2917,10 +2907,8 @@ export class SystemHealthDashboardClient extends AuthorizedApiBase {
|
|
|
2917
2907
|
this.http = http ? http : window;
|
|
2918
2908
|
this.baseUrl = baseUrl ?? "";
|
|
2919
2909
|
}
|
|
2920
|
-
getMachineDataHealth(
|
|
2910
|
+
getMachineDataHealth(assetExternalId) {
|
|
2921
2911
|
let url_ = this.baseUrl + "/systemhealthdashboard?";
|
|
2922
|
-
if (assetId !== undefined && assetId !== null)
|
|
2923
|
-
url_ += "assetId=" + encodeURIComponent("" + assetId) + "&";
|
|
2924
2912
|
if (assetExternalId !== undefined && assetExternalId !== null)
|
|
2925
2913
|
url_ += "assetExternalId=" + encodeURIComponent("" + assetExternalId) + "&";
|
|
2926
2914
|
url_ = url_.replace(/[?&]$/, "");
|
|
@@ -5081,10 +5069,8 @@ export class KpiResourceClient extends AuthorizedApiBase {
|
|
|
5081
5069
|
}
|
|
5082
5070
|
return Promise.resolve(null);
|
|
5083
5071
|
}
|
|
5084
|
-
getUptimeNormalTrend(
|
|
5072
|
+
getUptimeNormalTrend(assetExternalId, date, utcOffset) {
|
|
5085
5073
|
let url_ = this.baseUrl + "/kpiresource/normal-day-trendline?";
|
|
5086
|
-
if (assetId !== undefined && assetId !== null)
|
|
5087
|
-
url_ += "assetId=" + encodeURIComponent("" + assetId) + "&";
|
|
5088
5074
|
if (assetExternalId !== undefined && assetExternalId !== null)
|
|
5089
5075
|
url_ += "assetExternalId=" + encodeURIComponent("" + assetExternalId) + "&";
|
|
5090
5076
|
if (date !== undefined && date !== null)
|
|
@@ -5323,10 +5309,8 @@ export class ResourcesClient extends AuthorizedApiBase {
|
|
|
5323
5309
|
}
|
|
5324
5310
|
return Promise.resolve(null);
|
|
5325
5311
|
}
|
|
5326
|
-
listCurrentMachineStates(
|
|
5312
|
+
listCurrentMachineStates(assetExternalId) {
|
|
5327
5313
|
let url_ = this.baseUrl + "/resources/states/now?";
|
|
5328
|
-
if (assetId !== undefined && assetId !== null)
|
|
5329
|
-
url_ += "assetId=" + encodeURIComponent("" + assetId) + "&";
|
|
5330
5314
|
if (assetExternalId !== undefined && assetExternalId !== null)
|
|
5331
5315
|
url_ += "assetExternalId=" + encodeURIComponent("" + assetExternalId) + "&";
|
|
5332
5316
|
url_ = url_.replace(/[?&]$/, "");
|
|
@@ -6918,11 +6902,10 @@ export class UtilizationClient extends AuthorizedApiBase {
|
|
|
6918
6902
|
* @param startTime (optional)
|
|
6919
6903
|
* @param endTime (optional)
|
|
6920
6904
|
* @param ianaTimeZone (optional)
|
|
6921
|
-
* @param assetId (optional)
|
|
6922
6905
|
* @param assetExternalId (optional)
|
|
6923
6906
|
* @deprecated
|
|
6924
6907
|
*/
|
|
6925
|
-
getUtilizationDatapoints(utilizationType, startTime, endTime, ianaTimeZone,
|
|
6908
|
+
getUtilizationDatapoints(utilizationType, startTime, endTime, ianaTimeZone, assetExternalId) {
|
|
6926
6909
|
let url_ = this.baseUrl + "/utilization/datapoints?";
|
|
6927
6910
|
if (utilizationType === null)
|
|
6928
6911
|
throw new globalThis.Error("The parameter 'utilizationType' cannot be null.");
|
|
@@ -6936,8 +6919,6 @@ export class UtilizationClient extends AuthorizedApiBase {
|
|
|
6936
6919
|
url_ += "endTime=" + encodeURIComponent(endTime ? "" + endTime.toISOString() : "") + "&";
|
|
6937
6920
|
if (ianaTimeZone !== undefined && ianaTimeZone !== null)
|
|
6938
6921
|
url_ += "ianaTimeZone=" + encodeURIComponent("" + ianaTimeZone) + "&";
|
|
6939
|
-
if (assetId !== undefined && assetId !== null)
|
|
6940
|
-
url_ += "assetId=" + encodeURIComponent("" + assetId) + "&";
|
|
6941
6922
|
if (assetExternalId !== undefined && assetExternalId !== null)
|
|
6942
6923
|
url_ += "assetExternalId=" + encodeURIComponent("" + assetExternalId) + "&";
|
|
6943
6924
|
url_ = url_.replace(/[?&]$/, "");
|
|
@@ -7164,7 +7145,7 @@ export class UtilizationClient extends AuthorizedApiBase {
|
|
|
7164
7145
|
}
|
|
7165
7146
|
return Promise.resolve(null);
|
|
7166
7147
|
}
|
|
7167
|
-
getResourceUtilizationDatapoints(utilizationType, startTime, endTime, ianaTimeZone,
|
|
7148
|
+
getResourceUtilizationDatapoints(utilizationType, startTime, endTime, ianaTimeZone, assetExternalId) {
|
|
7168
7149
|
let url_ = this.baseUrl + "/pulseutilization/datapoints?";
|
|
7169
7150
|
if (utilizationType === null)
|
|
7170
7151
|
throw new globalThis.Error("The parameter 'utilizationType' cannot be null.");
|
|
@@ -7178,8 +7159,6 @@ export class UtilizationClient extends AuthorizedApiBase {
|
|
|
7178
7159
|
url_ += "endTime=" + encodeURIComponent(endTime ? "" + endTime.toISOString() : "") + "&";
|
|
7179
7160
|
if (ianaTimeZone !== undefined && ianaTimeZone !== null)
|
|
7180
7161
|
url_ += "ianaTimeZone=" + encodeURIComponent("" + ianaTimeZone) + "&";
|
|
7181
|
-
if (assetId !== undefined && assetId !== null)
|
|
7182
|
-
url_ += "assetId=" + encodeURIComponent("" + assetId) + "&";
|
|
7183
7162
|
if (assetExternalId !== undefined && assetExternalId !== null)
|
|
7184
7163
|
url_ += "assetExternalId=" + encodeURIComponent("" + assetExternalId) + "&";
|
|
7185
7164
|
url_ = url_.replace(/[?&]$/, "");
|
|
@@ -11786,10 +11765,8 @@ export class KpiClient extends AuthorizedApiBase {
|
|
|
11786
11765
|
}
|
|
11787
11766
|
return Promise.resolve(null);
|
|
11788
11767
|
}
|
|
11789
|
-
getUptimeNormalTrend(
|
|
11768
|
+
getUptimeNormalTrend(assetExternalId, date, utcOffset) {
|
|
11790
11769
|
let url_ = this.baseUrl + "/kpi/normal-day-trendline?";
|
|
11791
|
-
if (assetId !== undefined && assetId !== null)
|
|
11792
|
-
url_ += "assetId=" + encodeURIComponent("" + assetId) + "&";
|
|
11793
11770
|
if (assetExternalId !== undefined && assetExternalId !== null)
|
|
11794
11771
|
url_ += "assetExternalId=" + encodeURIComponent("" + assetExternalId) + "&";
|
|
11795
11772
|
if (date !== undefined && date !== null)
|
|
@@ -12028,10 +12005,8 @@ export class MachinesClient extends AuthorizedApiBase {
|
|
|
12028
12005
|
}
|
|
12029
12006
|
return Promise.resolve(null);
|
|
12030
12007
|
}
|
|
12031
|
-
listCurrentMachineStates(
|
|
12008
|
+
listCurrentMachineStates(assetExternalId) {
|
|
12032
12009
|
let url_ = this.baseUrl + "/machines/states/now?";
|
|
12033
|
-
if (assetId !== undefined && assetId !== null)
|
|
12034
|
-
url_ += "assetId=" + encodeURIComponent("" + assetId) + "&";
|
|
12035
12010
|
if (assetExternalId !== undefined && assetExternalId !== null)
|
|
12036
12011
|
url_ += "assetExternalId=" + encodeURIComponent("" + assetExternalId) + "&";
|
|
12037
12012
|
url_ = url_.replace(/[?&]$/, "");
|