@kelvininc/js-client-sdk 7.5.0 → 7.9.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/CHANGELOG.md +83 -0
- package/dist/cjs/models/generated/aCPWorkloadManifestConfigItem.d.ts +19 -0
- package/dist/cjs/models/generated/aCPWorkloadManifestConfigItem.js +20 -0
- package/dist/cjs/models/generated/aCPWorkloadManifestConfigItem.js.map +1 -0
- package/dist/cjs/models/generated/aCPWorkloadManifests.d.ts +3 -0
- package/dist/cjs/models/generated/aCPWorkloadManifests.js +2 -0
- package/dist/cjs/models/generated/aCPWorkloadManifests.js.map +1 -1
- package/dist/cjs/models/generated/alarm.d.ts +4 -0
- package/dist/cjs/models/generated/alarm.js +2 -0
- package/dist/cjs/models/generated/alarm.js.map +1 -1
- package/dist/cjs/models/generated/alarmItem.d.ts +4 -0
- package/dist/cjs/models/generated/alarmItem.js +2 -0
- package/dist/cjs/models/generated/alarmItem.js.map +1 -1
- package/dist/cjs/models/generated/alarmSeverity.d.ts +25 -0
- package/dist/cjs/models/generated/alarmSeverity.js +23 -0
- package/dist/cjs/models/generated/alarmSeverity.js.map +1 -0
- package/dist/cjs/models/generated/alarmSeverityList.d.ts +18 -0
- package/dist/cjs/models/generated/alarmSeverityList.js +20 -0
- package/dist/cjs/models/generated/alarmSeverityList.js.map +1 -0
- package/dist/cjs/models/generated/asset.d.ts +59 -0
- package/dist/cjs/models/generated/asset.js +5 -0
- package/dist/cjs/models/generated/asset.js.map +1 -1
- package/dist/cjs/models/generated/assetClass.d.ts +21 -0
- package/dist/cjs/models/generated/assetClass.js.map +1 -1
- package/dist/cjs/models/generated/assetClassItem.d.ts +21 -0
- package/dist/cjs/models/generated/assetClassItem.js.map +1 -1
- package/dist/cjs/models/generated/assetClassListPaginated.d.ts +3 -0
- package/dist/cjs/models/generated/assetClassListPaginated.js.map +1 -1
- package/dist/cjs/models/generated/assetDataStreamItem.d.ts +25 -0
- package/dist/cjs/models/generated/assetDataStreamItem.js +20 -0
- package/dist/cjs/models/generated/assetDataStreamItem.js.map +1 -0
- package/dist/cjs/models/generated/assetDataStreamsListPaginated.d.ts +24 -0
- package/dist/cjs/models/generated/{appVersionStatusListPaginated.js → assetDataStreamsListPaginated.js} +6 -6
- package/dist/cjs/models/generated/assetDataStreamsListPaginated.js.map +1 -0
- package/dist/cjs/models/generated/assetHierarchies.d.ts +3 -0
- package/dist/cjs/models/generated/assetHierarchies.js.map +1 -1
- package/dist/cjs/models/generated/assetHierarchyItem.d.ts +30 -0
- package/dist/cjs/models/generated/assetHierarchyItem.js +4 -0
- package/dist/cjs/models/generated/assetHierarchyItem.js.map +1 -1
- package/dist/cjs/models/generated/assetHierarchyList.d.ts +3 -0
- package/dist/cjs/models/generated/assetHierarchyList.js.map +1 -1
- package/dist/cjs/models/generated/assetItem.d.ts +36 -0
- package/dist/cjs/models/generated/assetItem.js +2 -0
- package/dist/cjs/models/generated/assetItem.js.map +1 -1
- package/dist/cjs/models/generated/assetListPaginated.d.ts +3 -0
- package/dist/cjs/models/generated/assetListPaginated.js.map +1 -1
- package/dist/cjs/models/generated/assetLocationItem.d.ts +6 -0
- package/dist/cjs/models/generated/assetLocationItem.js.map +1 -1
- package/dist/cjs/models/generated/assetMetricItem.d.ts +25 -0
- package/dist/cjs/models/generated/assetMetricItem.js +20 -0
- package/dist/cjs/models/generated/assetMetricItem.js.map +1 -0
- package/dist/cjs/models/generated/assetOEE.d.ts +3 -0
- package/dist/cjs/models/generated/assetOEE.js.map +1 -1
- package/dist/cjs/models/generated/assetProperty.d.ts +9 -0
- package/dist/cjs/models/generated/assetProperty.js.map +1 -1
- package/dist/cjs/models/generated/assetStatisticsItem.d.ts +58 -0
- package/dist/cjs/models/generated/assetStatisticsItem.js +28 -0
- package/dist/cjs/models/generated/assetStatisticsItem.js.map +1 -0
- package/dist/cjs/models/generated/assetStatisticsPaginated.d.ts +24 -0
- package/dist/cjs/models/generated/assetStatisticsPaginated.js +22 -0
- package/dist/cjs/models/generated/assetStatisticsPaginated.js.map +1 -0
- package/dist/cjs/models/generated/assetStatus.d.ts +3 -0
- package/dist/cjs/models/generated/assetStatus.js.map +1 -1
- package/dist/cjs/models/generated/assetStatusCount.d.ts +15 -0
- package/dist/cjs/models/generated/assetStatusCount.js.map +1 -1
- package/dist/cjs/models/generated/assetStatusItem.d.ts +6 -0
- package/dist/cjs/models/generated/assetStatusItem.js.map +1 -1
- package/dist/cjs/models/generated/assetTemplate.d.ts +54 -0
- package/dist/cjs/models/generated/assetTemplate.js +4 -0
- package/dist/cjs/models/generated/assetTemplate.js.map +1 -1
- package/dist/cjs/models/generated/assetTemplateHierarchy.d.ts +30 -0
- package/dist/cjs/models/generated/assetTemplateHierarchy.js +4 -0
- package/dist/cjs/models/generated/assetTemplateHierarchy.js.map +1 -1
- package/dist/cjs/models/generated/assetTemplateItem.d.ts +42 -0
- package/dist/cjs/models/generated/assetTemplateItem.js.map +1 -1
- package/dist/cjs/models/generated/assetTemplateListPaginated.d.ts +3 -0
- package/dist/cjs/models/generated/assetTemplateListPaginated.js.map +1 -1
- package/dist/cjs/models/generated/assetTemplateProperties.d.ts +9 -0
- package/dist/cjs/models/generated/assetTemplateProperties.js.map +1 -1
- package/dist/cjs/models/generated/assetType.d.ts +30 -0
- package/dist/cjs/models/generated/assetType.js.map +1 -1
- package/dist/cjs/models/generated/assetTypeItem.d.ts +30 -0
- package/dist/cjs/models/generated/assetTypeItem.js.map +1 -1
- package/dist/cjs/models/generated/assetTypeListPaginated.d.ts +3 -0
- package/dist/cjs/models/generated/assetTypeListPaginated.js.map +1 -1
- package/dist/cjs/models/generated/assetTypeMetadata.d.ts +15 -0
- package/dist/cjs/models/generated/assetTypeMetadata.js.map +1 -1
- package/dist/cjs/models/generated/assetTypeMetadataItem.d.ts +15 -0
- package/dist/cjs/models/generated/assetTypeMetadataItem.js.map +1 -1
- package/dist/cjs/models/generated/assetTypeMetadataListPaginated.d.ts +3 -0
- package/dist/cjs/models/generated/assetTypeMetadataListPaginated.js.map +1 -1
- package/dist/cjs/models/generated/attachment.d.ts +23 -0
- package/dist/cjs/models/generated/attachment.js +22 -0
- package/dist/cjs/models/generated/attachment.js.map +1 -0
- package/dist/cjs/models/generated/cSVError.d.ts +18 -0
- package/dist/cjs/models/generated/cSVError.js.map +1 -1
- package/dist/cjs/models/generated/cSVErrorMessage.d.ts +3 -12
- package/dist/cjs/models/generated/cSVErrorMessage.js +1 -3
- package/dist/cjs/models/generated/cSVErrorMessage.js.map +1 -1
- package/dist/cjs/models/generated/cSVPosition.d.ts +12 -0
- package/dist/cjs/models/generated/cSVPosition.js.map +1 -1
- package/dist/cjs/models/generated/controlChange.d.ts +60 -0
- package/dist/cjs/models/generated/controlChange.js +27 -0
- package/dist/cjs/models/generated/controlChange.js.map +1 -0
- package/dist/cjs/models/generated/controlChangeGet.d.ts +81 -0
- package/dist/cjs/models/generated/controlChangeGet.js +32 -0
- package/dist/cjs/models/generated/controlChangeGet.js.map +1 -0
- package/dist/cjs/models/generated/controlChangeGetPaginated.d.ts +24 -0
- package/dist/cjs/models/generated/controlChangeGetPaginated.js +22 -0
- package/dist/cjs/models/generated/controlChangeGetPaginated.js.map +1 -0
- package/dist/cjs/models/generated/controlChangeGetStatus.d.ts +35 -0
- package/dist/cjs/models/generated/controlChangeGetStatus.js +22 -0
- package/dist/cjs/models/generated/controlChangeGetStatus.js.map +1 -0
- package/dist/cjs/models/generated/controlChangePaginated.d.ts +24 -0
- package/dist/cjs/models/generated/controlChangePaginated.js +22 -0
- package/dist/cjs/models/generated/controlChangePaginated.js.map +1 -0
- package/dist/cjs/models/generated/emissionsAsset.d.ts +19 -0
- package/dist/cjs/models/generated/emissionsAsset.js +20 -0
- package/dist/cjs/models/generated/emissionsAsset.js.map +1 -0
- package/dist/cjs/models/generated/emissionsAssetLists.d.ts +22 -0
- package/dist/cjs/models/generated/emissionsAssetLists.js +22 -0
- package/dist/cjs/models/generated/emissionsAssetLists.js.map +1 -0
- package/dist/cjs/models/generated/emissionsDashboard.d.ts +29 -0
- package/dist/cjs/models/generated/emissionsDashboard.js +27 -0
- package/dist/cjs/models/generated/emissionsDashboard.js.map +1 -0
- package/dist/cjs/models/generated/emissionsDashboardAnalytics.d.ts +26 -0
- package/dist/cjs/models/generated/emissionsDashboardAnalytics.js +24 -0
- package/dist/cjs/models/generated/emissionsDashboardAnalytics.js.map +1 -0
- package/dist/cjs/models/generated/emissionsDashboardAnalyticsHistorian.d.ts +25 -0
- package/dist/cjs/models/generated/emissionsDashboardAnalyticsHistorian.js +23 -0
- package/dist/cjs/models/generated/emissionsDashboardAnalyticsHistorian.js.map +1 -0
- package/dist/cjs/models/generated/emissionsDashboardTotals.d.ts +27 -0
- package/dist/cjs/models/generated/emissionsDashboardTotals.js +24 -0
- package/dist/cjs/models/generated/emissionsDashboardTotals.js.map +1 -0
- package/dist/cjs/models/generated/emissionsGreenhouse.d.ts +21 -0
- package/dist/cjs/models/generated/emissionsGreenhouse.js +21 -0
- package/dist/cjs/models/generated/emissionsGreenhouse.js.map +1 -0
- package/dist/cjs/models/generated/errorMessage.d.ts +9 -0
- package/dist/cjs/models/generated/errorMessage.js.map +1 -1
- package/dist/cjs/models/generated/errorMessages.d.ts +3 -0
- package/dist/cjs/models/generated/errorMessages.js.map +1 -1
- package/dist/cjs/models/generated/errorsError.d.ts +18 -0
- package/dist/cjs/models/generated/errorsError.js.map +1 -1
- package/dist/cjs/models/generated/errorsErrorMessage.d.ts +3 -9
- package/dist/cjs/models/generated/errorsErrorMessage.js +1 -4
- package/dist/cjs/models/generated/errorsErrorMessage.js.map +1 -1
- package/dist/cjs/models/generated/failureDetection.d.ts +14 -0
- package/dist/cjs/models/generated/failureDetection.js +2 -1
- package/dist/cjs/models/generated/failureDetection.js.map +1 -1
- package/dist/cjs/models/generated/failureDetectionProperty.d.ts +9 -0
- package/dist/cjs/models/generated/failureDetectionProperty.js.map +1 -1
- package/dist/cjs/models/generated/failureEventItem.d.ts +2 -0
- package/dist/cjs/models/generated/failureEventItem.js +1 -0
- package/dist/cjs/models/generated/failureEventItem.js.map +1 -1
- package/dist/cjs/models/generated/failureOverviewItem.d.ts +58 -0
- package/dist/cjs/models/generated/failureOverviewItem.js +28 -0
- package/dist/cjs/models/generated/failureOverviewItem.js.map +1 -0
- package/dist/cjs/models/generated/failureOverviewPaginated.d.ts +24 -0
- package/dist/cjs/models/generated/failureOverviewPaginated.js +22 -0
- package/dist/cjs/models/generated/failureOverviewPaginated.js.map +1 -0
- package/dist/cjs/models/generated/failureOverviewStatistics.d.ts +24 -0
- package/dist/cjs/models/generated/failureOverviewStatistics.js +22 -0
- package/dist/cjs/models/generated/failureOverviewStatistics.js.map +1 -0
- package/dist/cjs/models/generated/index.d.ts +50 -5
- package/dist/cjs/models/generated/index.js +50 -5
- package/dist/cjs/models/generated/index.js.map +1 -1
- package/dist/cjs/models/generated/mapFailureDetection.d.ts +17 -0
- package/dist/cjs/models/generated/mapFailureDetection.js +19 -0
- package/dist/cjs/models/generated/mapFailureDetection.js.map +1 -0
- package/dist/cjs/models/generated/mapItem.d.ts +9 -6
- package/dist/cjs/models/generated/mapItem.js +5 -3
- package/dist/cjs/models/generated/mapItem.js.map +1 -1
- package/dist/cjs/models/generated/mapModel.d.ts +7 -4
- package/dist/cjs/models/generated/mapModel.js +4 -2
- package/dist/cjs/models/generated/mapModel.js.map +1 -1
- package/dist/cjs/models/generated/mapOEE.d.ts +26 -0
- package/dist/cjs/models/generated/mapOEE.js +25 -0
- package/dist/cjs/models/generated/mapOEE.js.map +1 -0
- package/dist/{esm/models/generated/assetShift.d.ts → cjs/models/generated/mapShift.d.ts} +5 -5
- package/dist/cjs/models/generated/{assetShift.js → mapShift.js} +5 -5
- package/dist/cjs/models/generated/mapShift.js.map +1 -0
- package/dist/cjs/models/generated/metric.d.ts +30 -0
- package/dist/cjs/models/generated/metric.js.map +1 -1
- package/dist/cjs/models/generated/metricItem.d.ts +30 -0
- package/dist/cjs/models/generated/metricItem.js.map +1 -1
- package/dist/cjs/models/generated/metricListPaginated.d.ts +3 -0
- package/dist/cjs/models/generated/metricListPaginated.js.map +1 -1
- package/dist/cjs/models/generated/oEECalculation.d.ts +15 -0
- package/dist/cjs/models/generated/oEECalculation.js.map +1 -1
- package/dist/cjs/models/generated/oEEThresholds.d.ts +9 -0
- package/dist/cjs/models/generated/oEEThresholds.js.map +1 -1
- package/dist/cjs/models/generated/oEEValues.d.ts +12 -0
- package/dist/cjs/models/generated/oEEValues.js.map +1 -1
- package/dist/cjs/models/generated/pagination.d.ts +9 -0
- package/dist/cjs/models/generated/pagination.js.map +1 -1
- package/dist/cjs/models/generated/parameterAppVersionAsset.d.ts +29 -0
- package/dist/cjs/models/generated/parameterAppVersionAsset.js +25 -0
- package/dist/cjs/models/generated/parameterAppVersionAsset.js.map +1 -0
- package/dist/cjs/models/generated/parameterAppVersionAssetListPaginated.d.ts +21 -0
- package/dist/cjs/models/generated/parameterAppVersionAssetListPaginated.js +22 -0
- package/dist/cjs/models/generated/parameterAppVersionAssetListPaginated.js.map +1 -0
- package/dist/cjs/models/generated/parameterGetSchema.d.ts +28 -0
- package/dist/cjs/models/generated/parameterGetSchema.js +23 -0
- package/dist/cjs/models/generated/parameterGetSchema.js.map +1 -0
- package/dist/cjs/models/generated/parameterschemaParameterJSONSchema.d.ts +28 -0
- package/dist/cjs/models/generated/parameterschemaParameterJSONSchema.js +23 -0
- package/dist/cjs/models/generated/parameterschemaParameterJSONSchema.js.map +1 -0
- package/dist/cjs/models/generated/parameterschemaParameterJSONSchemaProperties.d.ts +35 -0
- package/dist/cjs/models/generated/parameterschemaParameterJSONSchemaProperties.js +28 -0
- package/dist/cjs/models/generated/parameterschemaParameterJSONSchemaProperties.js.map +1 -0
- package/dist/cjs/models/generated/reply.d.ts +26 -0
- package/dist/cjs/models/generated/reply.js +24 -0
- package/dist/cjs/models/generated/reply.js.map +1 -0
- package/dist/cjs/models/generated/responsibleFor.d.ts +19 -0
- package/dist/cjs/models/generated/{appVersionStatus.js → responsibleFor.js} +5 -8
- package/dist/cjs/models/generated/responsibleFor.js.map +1 -0
- package/dist/cjs/models/generated/rule.d.ts +37 -0
- package/dist/cjs/models/generated/rule.js +30 -0
- package/dist/cjs/models/generated/rule.js.map +1 -0
- package/dist/cjs/models/generated/ruleAction.d.ts +19 -0
- package/dist/cjs/models/generated/ruleAction.js +20 -0
- package/dist/cjs/models/generated/ruleAction.js.map +1 -0
- package/dist/cjs/models/generated/ruleInput.d.ts +19 -0
- package/dist/cjs/models/generated/ruleInput.js +20 -0
- package/dist/cjs/models/generated/ruleInput.js.map +1 -0
- package/dist/cjs/models/generated/{errorsPayloadErrors.d.ts → ruleLogs.d.ts} +5 -3
- package/dist/cjs/models/generated/{errorsPayloadErrors.js → ruleLogs.js} +7 -5
- package/dist/cjs/models/generated/ruleLogs.js.map +1 -0
- package/dist/cjs/models/generated/rulePayload.d.ts +23 -0
- package/dist/cjs/models/generated/rulePayload.js +23 -0
- package/dist/cjs/models/generated/rulePayload.js.map +1 -0
- package/dist/cjs/models/generated/ruleStatus.d.ts +21 -0
- package/dist/cjs/models/generated/ruleStatus.js +21 -0
- package/dist/cjs/models/generated/ruleStatus.js.map +1 -0
- package/dist/cjs/models/generated/rulesListPaginated.d.ts +21 -0
- package/dist/cjs/models/generated/rulesListPaginated.js +22 -0
- package/dist/cjs/models/generated/rulesListPaginated.js.map +1 -0
- package/dist/cjs/models/generated/semanticTypeItem.d.ts +12 -0
- package/dist/cjs/models/generated/semanticTypeItem.js.map +1 -1
- package/dist/cjs/models/generated/semanticTypeList.d.ts +3 -0
- package/dist/cjs/models/generated/semanticTypeList.js.map +1 -1
- package/dist/cjs/models/generated/severityStatistics.d.ts +12 -0
- package/dist/cjs/models/generated/severityStatistics.js.map +1 -1
- package/dist/cjs/models/generated/simpleAsset.d.ts +6 -0
- package/dist/cjs/models/generated/simpleAsset.js.map +1 -1
- package/dist/cjs/models/generated/statusStatistics.d.ts +9 -0
- package/dist/cjs/models/generated/statusStatistics.js.map +1 -1
- package/dist/cjs/models/generated/symbol.d.ts +27 -0
- package/dist/cjs/models/generated/symbol.js +24 -0
- package/dist/cjs/models/generated/symbol.js.map +1 -0
- package/dist/cjs/models/generated/symbolItem.d.ts +27 -0
- package/dist/cjs/models/generated/symbolItem.js +24 -0
- package/dist/cjs/models/generated/symbolItem.js.map +1 -0
- package/dist/cjs/models/generated/symbolsListPaginated.d.ts +21 -0
- package/dist/cjs/models/generated/symbolsListPaginated.js +22 -0
- package/dist/cjs/models/generated/symbolsListPaginated.js.map +1 -0
- package/dist/cjs/models/generated/teamMember.d.ts +3 -2
- package/dist/cjs/models/generated/teamMember.js +2 -1
- package/dist/cjs/models/generated/teamMember.js.map +1 -1
- package/dist/cjs/models/generated/thread.d.ts +37 -0
- package/dist/cjs/models/generated/thread.js +28 -0
- package/dist/cjs/models/generated/thread.js.map +1 -0
- package/dist/cjs/models/generated/threadContent.d.ts +25 -0
- package/dist/cjs/models/generated/threadContent.js +24 -0
- package/dist/cjs/models/generated/threadContent.js.map +1 -0
- package/dist/cjs/models/generated/userFollow.d.ts +19 -0
- package/dist/cjs/models/generated/userFollow.js +20 -0
- package/dist/cjs/models/generated/userFollow.js.map +1 -0
- package/dist/cjs/models/generated/view2D.d.ts +30 -0
- package/dist/cjs/models/generated/view2D.js +21 -0
- package/dist/cjs/models/generated/view2D.js.map +1 -0
- package/dist/cjs/models/generated/view3D.d.ts +35 -0
- package/dist/cjs/models/generated/view3D.js +22 -0
- package/dist/cjs/models/generated/view3D.js.map +1 -0
- package/dist/cjs/models/generated/visualization.d.ts +21 -0
- package/dist/cjs/models/generated/visualization.js +22 -0
- package/dist/cjs/models/generated/visualization.js.map +1 -0
- package/dist/cjs/models/model-helper.d.ts +7 -1
- package/dist/cjs/models/model-helper.js +33 -14
- package/dist/cjs/models/model-helper.js.map +1 -1
- package/dist/cjs/models/model.js +3 -4
- package/dist/cjs/models/model.js.map +1 -1
- package/dist/cjs/services/generated/api/aCP.service.js.map +1 -1
- package/dist/cjs/services/generated/api/alarm.service.d.ts +20 -7
- package/dist/cjs/services/generated/api/alarm.service.js +33 -5
- package/dist/cjs/services/generated/api/alarm.service.js.map +1 -1
- package/dist/cjs/services/generated/api/appRegistry.service.d.ts +2 -22
- package/dist/cjs/services/generated/api/appRegistry.service.js +0 -54
- package/dist/cjs/services/generated/api/appRegistry.service.js.map +1 -1
- package/dist/cjs/services/generated/api/asset.service.d.ts +152 -133
- package/dist/cjs/services/generated/api/asset.service.js +231 -151
- package/dist/cjs/services/generated/api/asset.service.js.map +1 -1
- package/dist/cjs/services/generated/api/bridge.service.js.map +1 -1
- package/dist/cjs/services/generated/api/controlChange.service.d.ts +80 -0
- package/dist/cjs/services/generated/api/controlChange.service.js +204 -0
- package/dist/cjs/services/generated/api/controlChange.service.js.map +1 -0
- package/dist/cjs/services/generated/api/dataLabel.service.d.ts +8 -1
- package/dist/cjs/services/generated/api/dataLabel.service.js +15 -0
- package/dist/cjs/services/generated/api/dataLabel.service.js.map +1 -1
- package/dist/cjs/services/generated/api/dataType.service.js.map +1 -1
- package/dist/cjs/services/generated/api/failureDetection.service.js.map +1 -1
- package/dist/cjs/services/generated/api/index.d.ts +5 -0
- package/dist/cjs/services/generated/api/index.js +5 -0
- package/dist/cjs/services/generated/api/index.js.map +1 -1
- package/dist/cjs/services/generated/api/instance.service.js.map +1 -1
- package/dist/cjs/services/generated/api/integration.service.js.map +1 -1
- package/dist/cjs/services/generated/api/map.service.d.ts +73 -5
- package/dist/cjs/services/generated/api/map.service.js +169 -3
- package/dist/cjs/services/generated/api/map.service.js.map +1 -1
- package/dist/cjs/services/generated/api/metric.service.d.ts +26 -26
- package/dist/cjs/services/generated/api/metric.service.js +26 -26
- package/dist/cjs/services/generated/api/metric.service.js.map +1 -1
- package/dist/cjs/services/generated/api/orchestration.service.js.map +1 -1
- package/dist/cjs/services/generated/api/parameters.service.d.ts +42 -0
- package/dist/cjs/services/generated/api/parameters.service.js +83 -0
- package/dist/cjs/services/generated/api/parameters.service.js.map +1 -0
- package/dist/cjs/services/generated/api/rule.service.d.ts +63 -0
- package/dist/cjs/services/generated/api/rule.service.js +146 -0
- package/dist/cjs/services/generated/api/rule.service.js.map +1 -0
- package/dist/cjs/services/generated/api/secret.service.js.map +1 -1
- package/dist/cjs/services/generated/api/storage.service.js.map +1 -1
- package/dist/cjs/services/generated/api/thread.service.d.ts +94 -0
- package/dist/cjs/services/generated/api/thread.service.js +224 -0
- package/dist/cjs/services/generated/api/thread.service.js.map +1 -0
- package/dist/cjs/services/generated/api/uI.service.d.ts +17 -0
- package/dist/cjs/services/generated/api/uI.service.js +31 -0
- package/dist/cjs/services/generated/api/uI.service.js.map +1 -0
- package/dist/cjs/services/generated/api/user.service.js.map +1 -1
- package/dist/cjs/services/generated/api/wireguard.service.js.map +1 -1
- package/dist/cjs/services/generated/api/workload.service.d.ts +2 -1
- package/dist/cjs/services/generated/api/workload.service.js +5 -1
- package/dist/cjs/services/generated/api/workload.service.js.map +1 -1
- package/dist/cjs/services/generated/models/aCPStatusUpdateData.d.ts +1 -0
- package/dist/cjs/services/generated/models/aCPStatusUpdateData.js.map +1 -1
- package/dist/cjs/services/generated/models/alarmCreateData.d.ts +5 -5
- package/dist/cjs/services/generated/models/alarmCreateData.js.map +1 -1
- package/dist/cjs/services/generated/models/alarmSeverityData.d.ts +8 -0
- package/dist/cjs/services/generated/models/{assetShiftGetData.js → alarmSeverityData.js} +1 -1
- package/dist/cjs/services/generated/models/alarmSeverityData.js.map +1 -0
- package/dist/cjs/services/generated/models/alarmSeverityUpdateData.d.ts +7 -0
- package/dist/cjs/services/generated/models/alarmSeverityUpdateData.js +3 -0
- package/dist/cjs/services/generated/models/alarmSeverityUpdateData.js.map +1 -0
- package/dist/cjs/services/generated/models/assetClassCreateData.d.ts +3 -3
- package/dist/cjs/services/generated/models/assetClassCreateData.js.map +1 -1
- package/dist/cjs/services/generated/models/assetClassUpdateData.d.ts +1 -1
- package/dist/cjs/services/generated/models/assetClassUpdateData.js.map +1 -1
- package/dist/cjs/services/generated/models/assetCreateData.d.ts +9 -4
- package/dist/cjs/services/generated/models/assetCreateData.js.map +1 -1
- package/dist/cjs/services/generated/models/assetCreateWithParentData.d.ts +9 -4
- package/dist/cjs/services/generated/models/assetCreateWithParentData.js.map +1 -1
- package/dist/cjs/services/generated/models/assetDataStreamsListData.d.ts +6 -0
- package/dist/cjs/services/generated/models/assetDataStreamsListData.js +3 -0
- package/dist/cjs/services/generated/models/assetDataStreamsListData.js.map +1 -0
- package/dist/cjs/services/generated/models/assetMetricItemData.d.ts +6 -0
- package/dist/cjs/services/generated/models/{assetShiftCreateData.js → assetMetricItemData.js} +1 -1
- package/dist/cjs/services/generated/models/assetMetricItemData.js.map +1 -0
- package/dist/cjs/services/generated/models/assetOEEGetData.d.ts +1 -1
- package/dist/cjs/services/generated/models/assetOEEGetData.js.map +1 -1
- package/dist/cjs/services/generated/models/assetStatisticsData.d.ts +9 -0
- package/dist/cjs/services/generated/models/assetStatisticsData.js +3 -0
- package/dist/cjs/services/generated/models/assetStatisticsData.js.map +1 -0
- package/dist/cjs/services/generated/models/assetTemplateCreateData.d.ts +8 -4
- package/dist/cjs/services/generated/models/assetTemplateCreateData.js.map +1 -1
- package/dist/cjs/services/generated/models/assetTemplateHierarchyData.d.ts +6 -2
- package/dist/cjs/services/generated/models/assetTemplateHierarchyData.js.map +1 -1
- package/dist/cjs/services/generated/models/assetTemplateUpdateData.d.ts +4 -0
- package/dist/cjs/services/generated/models/assetTemplateUpdateData.js.map +1 -1
- package/dist/cjs/services/generated/models/assetTypeCreateData.d.ts +3 -3
- package/dist/cjs/services/generated/models/assetTypeCreateData.js.map +1 -1
- package/dist/cjs/services/generated/models/assetTypeMetadataCreateData.d.ts +2 -2
- package/dist/cjs/services/generated/models/assetTypeMetadataCreateData.js.map +1 -1
- package/dist/cjs/services/generated/models/assetTypeMetadataUpdateData.d.ts +1 -1
- package/dist/cjs/services/generated/models/assetTypeMetadataUpdateData.js.map +1 -1
- package/dist/cjs/services/generated/models/assetUpdateData.d.ts +6 -1
- package/dist/cjs/services/generated/models/assetUpdateData.js.map +1 -1
- package/dist/cjs/services/generated/models/controlChangeCreateData.d.ts +11 -0
- package/dist/cjs/services/generated/models/controlChangeCreateData.js +3 -0
- package/dist/cjs/services/generated/models/controlChangeCreateData.js.map +1 -0
- package/dist/cjs/services/generated/models/controlChangeLastData.d.ts +9 -0
- package/dist/cjs/services/generated/models/controlChangeLastData.js +3 -0
- package/dist/cjs/services/generated/models/controlChangeLastData.js.map +1 -0
- package/dist/cjs/services/generated/models/controlChangeListData.d.ts +9 -0
- package/dist/cjs/services/generated/models/controlChangeListData.js +3 -0
- package/dist/cjs/services/generated/models/controlChangeListData.js.map +1 -0
- package/dist/cjs/services/generated/models/controlChangePayloadData.d.ts +9 -0
- package/dist/cjs/services/generated/models/controlChangePayloadData.js +3 -0
- package/dist/cjs/services/generated/models/controlChangePayloadData.js.map +1 -0
- package/dist/cjs/services/generated/models/controlChangeRangeData.d.ts +11 -0
- package/dist/cjs/services/generated/models/controlChangeRangeData.js +3 -0
- package/dist/cjs/services/generated/models/controlChangeRangeData.js.map +1 -0
- package/dist/cjs/services/generated/models/controlChangeStatusData.d.ts +11 -0
- package/dist/cjs/services/generated/models/controlChangeStatusData.js +3 -0
- package/dist/cjs/services/generated/models/controlChangeStatusData.js.map +1 -0
- package/dist/cjs/services/generated/models/controlChangeStatusPayloadData.d.ts +8 -0
- package/dist/cjs/services/generated/models/controlChangeStatusPayloadData.js +3 -0
- package/dist/cjs/services/generated/models/controlChangeStatusPayloadData.js.map +1 -0
- package/dist/cjs/services/generated/models/controlChangeUploadData.d.ts +9 -0
- package/dist/cjs/services/generated/models/controlChangeUploadData.js +3 -0
- package/dist/cjs/services/generated/models/controlChangeUploadData.js.map +1 -0
- package/dist/cjs/services/generated/models/controlChangeUploadRequestData.d.ts +11 -0
- package/dist/cjs/services/generated/models/controlChangeUploadRequestData.js +3 -0
- package/dist/cjs/services/generated/models/controlChangeUploadRequestData.js.map +1 -0
- package/dist/cjs/services/generated/models/failureOverviewData.d.ts +10 -0
- package/dist/cjs/services/generated/models/failureOverviewData.js +3 -0
- package/dist/cjs/services/generated/models/failureOverviewData.js.map +1 -0
- package/dist/cjs/services/generated/models/hierarchyUpdateItemData.d.ts +9 -4
- package/dist/cjs/services/generated/models/hierarchyUpdateItemData.js.map +1 -1
- package/dist/cjs/services/generated/models/index.d.ts +31 -3
- package/dist/cjs/services/generated/models/index.js +31 -3
- package/dist/cjs/services/generated/models/index.js.map +1 -1
- package/dist/cjs/services/generated/models/integrationAwsRegionUpdateData.d.ts +0 -1
- package/dist/cjs/services/generated/models/integrationAwsRegionUpdateData.js.map +1 -1
- package/dist/cjs/services/generated/models/integrationUpdateData.d.ts +0 -1
- package/dist/cjs/services/generated/models/integrationUpdateData.js.map +1 -1
- package/dist/cjs/services/generated/models/{assetOEECreateData.d.ts → mapOEECreateData.d.ts} +1 -1
- package/dist/cjs/services/generated/models/{assetOEECreateData.js → mapOEECreateData.js} +1 -1
- package/dist/cjs/services/generated/models/mapOEECreateData.js.map +1 -0
- package/dist/cjs/services/generated/models/{assetShiftGetData.d.ts → mapOEEGetData.d.ts} +2 -2
- package/dist/cjs/services/generated/models/mapOEEGetData.js +3 -0
- package/dist/cjs/services/generated/models/mapOEEGetData.js.map +1 -0
- package/dist/{esm/services/generated/models/assetShiftCreateData.d.ts → cjs/services/generated/models/mapShiftCreateData.d.ts} +1 -2
- package/dist/cjs/services/generated/models/mapShiftCreateData.js +3 -0
- package/dist/cjs/services/generated/models/mapShiftCreateData.js.map +1 -0
- package/dist/{esm/services/generated/models/assetShiftGetData.d.ts → cjs/services/generated/models/mapShiftGetData.d.ts} +2 -2
- package/dist/cjs/services/generated/models/mapShiftGetData.js +3 -0
- package/dist/cjs/services/generated/models/mapShiftGetData.js.map +1 -0
- package/dist/cjs/services/generated/models/mapUpdateData.d.ts +1 -0
- package/dist/cjs/services/generated/models/mapUpdateData.js.map +1 -1
- package/dist/cjs/services/generated/models/notificationsUserSettingData.d.ts +1 -1
- package/dist/cjs/services/generated/models/notificationsUserSettingData.js.map +1 -1
- package/dist/cjs/services/generated/models/parameterUpdateData.d.ts +6 -0
- package/dist/cjs/services/generated/models/parameterUpdateData.js +3 -0
- package/dist/cjs/services/generated/models/parameterUpdateData.js.map +1 -0
- package/dist/cjs/services/generated/models/responsibleForData.d.ts +7 -0
- package/dist/cjs/services/generated/models/responsibleForData.js +3 -0
- package/dist/cjs/services/generated/models/responsibleForData.js.map +1 -0
- package/dist/cjs/services/generated/models/ruleActionData.d.ts +7 -0
- package/dist/cjs/services/generated/models/ruleActionData.js +3 -0
- package/dist/cjs/services/generated/models/ruleActionData.js.map +1 -0
- package/dist/cjs/services/generated/models/ruleCreateData.d.ts +12 -0
- package/dist/cjs/services/generated/models/ruleCreateData.js +3 -0
- package/dist/cjs/services/generated/models/ruleCreateData.js.map +1 -0
- package/dist/cjs/services/generated/models/ruleInputData.d.ts +7 -0
- package/dist/cjs/services/generated/models/ruleInputData.js +3 -0
- package/dist/cjs/services/generated/models/ruleInputData.js.map +1 -0
- package/dist/cjs/services/generated/models/rulePayloadData.d.ts +10 -0
- package/dist/cjs/services/generated/models/rulePayloadData.js +3 -0
- package/dist/cjs/services/generated/models/rulePayloadData.js.map +1 -0
- package/dist/cjs/services/generated/models/ruleUpdateData.d.ts +11 -0
- package/dist/cjs/services/generated/models/ruleUpdateData.js +3 -0
- package/dist/cjs/services/generated/models/ruleUpdateData.js.map +1 -0
- package/dist/cjs/services/generated/models/symbolCreateData.d.ts +9 -0
- package/dist/cjs/services/generated/models/symbolCreateData.js +3 -0
- package/dist/cjs/services/generated/models/symbolCreateData.js.map +1 -0
- package/dist/cjs/services/generated/models/symbolUpdateData.d.ts +8 -0
- package/dist/cjs/services/generated/models/symbolUpdateData.js +3 -0
- package/dist/cjs/services/generated/models/symbolUpdateData.js.map +1 -0
- package/dist/cjs/services/generated/models/teamMemberData.d.ts +2 -1
- package/dist/cjs/services/generated/models/teamMemberData.js.map +1 -1
- package/dist/cjs/services/generated/models/view2DData.d.ts +8 -0
- package/dist/cjs/services/generated/models/view2DData.js +3 -0
- package/dist/cjs/services/generated/models/view2DData.js.map +1 -0
- package/dist/cjs/services/generated/models/view3DData.d.ts +9 -0
- package/dist/cjs/services/generated/models/view3DData.js +3 -0
- package/dist/cjs/services/generated/models/view3DData.js.map +1 -0
- package/dist/cjs/services/generated/models/visualizationData.d.ts +9 -0
- package/dist/cjs/services/generated/models/visualizationData.js +3 -0
- package/dist/cjs/services/generated/models/visualizationData.js.map +1 -0
- package/dist/cjs/services/generated/models/workloadDeployData.d.ts +2 -2
- package/dist/cjs/services/generated/models/workloadDeployData.js.map +1 -1
- package/dist/cjs/services/generated/types/alarm.service.types.d.ts +11 -2
- package/dist/cjs/services/generated/types/alarm.service.types.js.map +1 -1
- package/dist/cjs/services/generated/types/appRegistry.service.types.d.ts +0 -18
- package/dist/cjs/services/generated/types/appRegistry.service.types.js.map +1 -1
- package/dist/cjs/services/generated/types/asset.service.types.d.ts +36 -17
- package/dist/cjs/services/generated/types/asset.service.types.js.map +1 -1
- package/dist/cjs/services/generated/types/controlChange.service.types.d.ts +64 -0
- package/dist/cjs/services/generated/types/controlChange.service.types.js +3 -0
- package/dist/cjs/services/generated/types/controlChange.service.types.js.map +1 -0
- package/dist/cjs/services/generated/types/dataLabel.service.types.d.ts +6 -0
- package/dist/cjs/services/generated/types/dataLabel.service.types.js.map +1 -1
- package/dist/cjs/services/generated/types/index.d.ts +5 -0
- package/dist/cjs/services/generated/types/index.js +5 -0
- package/dist/cjs/services/generated/types/index.js.map +1 -1
- package/dist/cjs/services/generated/types/map.service.types.d.ts +61 -1
- package/dist/cjs/services/generated/types/map.service.types.js.map +1 -1
- package/dist/cjs/services/generated/types/parameters.service.types.d.ts +30 -0
- package/dist/cjs/services/generated/types/parameters.service.types.js +3 -0
- package/dist/cjs/services/generated/types/parameters.service.types.js.map +1 -0
- package/dist/cjs/services/generated/types/rule.service.types.d.ts +48 -0
- package/dist/cjs/services/generated/types/rule.service.types.js +3 -0
- package/dist/cjs/services/generated/types/rule.service.types.js.map +1 -0
- package/dist/cjs/services/generated/types/thread.service.types.d.ts +74 -0
- package/dist/cjs/services/generated/types/thread.service.types.js +3 -0
- package/dist/cjs/services/generated/types/thread.service.types.js.map +1 -0
- package/dist/cjs/services/generated/types/uI.service.types.d.ts +6 -0
- package/dist/cjs/services/generated/types/uI.service.types.js +3 -0
- package/dist/cjs/services/generated/types/uI.service.types.js.map +1 -0
- package/dist/cjs/services/generated/types/workload.service.types.d.ts +1 -0
- package/dist/cjs/services/generated/types/workload.service.types.js.map +1 -1
- package/dist/esm/models/generated/aCPWorkloadManifestConfigItem.d.ts +19 -0
- package/dist/esm/models/generated/aCPWorkloadManifestConfigItem.js +16 -0
- package/dist/esm/models/generated/aCPWorkloadManifestConfigItem.js.map +1 -0
- package/dist/esm/models/generated/aCPWorkloadManifests.d.ts +3 -0
- package/dist/esm/models/generated/aCPWorkloadManifests.js +2 -0
- package/dist/esm/models/generated/aCPWorkloadManifests.js.map +1 -1
- package/dist/esm/models/generated/alarm.d.ts +4 -0
- package/dist/esm/models/generated/alarm.js +2 -0
- package/dist/esm/models/generated/alarm.js.map +1 -1
- package/dist/esm/models/generated/alarmItem.d.ts +4 -0
- package/dist/esm/models/generated/alarmItem.js +2 -0
- package/dist/esm/models/generated/alarmItem.js.map +1 -1
- package/dist/esm/models/generated/alarmSeverity.d.ts +25 -0
- package/dist/esm/models/generated/alarmSeverity.js +19 -0
- package/dist/esm/models/generated/alarmSeverity.js.map +1 -0
- package/dist/esm/models/generated/alarmSeverityList.d.ts +18 -0
- package/dist/esm/models/generated/alarmSeverityList.js +16 -0
- package/dist/esm/models/generated/alarmSeverityList.js.map +1 -0
- package/dist/esm/models/generated/asset.d.ts +59 -0
- package/dist/esm/models/generated/asset.js +5 -0
- package/dist/esm/models/generated/asset.js.map +1 -1
- package/dist/esm/models/generated/assetClass.d.ts +21 -0
- package/dist/esm/models/generated/assetClass.js.map +1 -1
- package/dist/esm/models/generated/assetClassItem.d.ts +21 -0
- package/dist/esm/models/generated/assetClassItem.js.map +1 -1
- package/dist/esm/models/generated/assetClassListPaginated.d.ts +3 -0
- package/dist/esm/models/generated/assetClassListPaginated.js.map +1 -1
- package/dist/esm/models/generated/assetDataStreamItem.d.ts +25 -0
- package/dist/esm/models/generated/assetDataStreamItem.js +16 -0
- package/dist/esm/models/generated/assetDataStreamItem.js.map +1 -0
- package/dist/esm/models/generated/assetDataStreamsListPaginated.d.ts +24 -0
- package/dist/esm/models/generated/{appVersionStatusListPaginated.js → assetDataStreamsListPaginated.js} +4 -4
- package/dist/esm/models/generated/assetDataStreamsListPaginated.js.map +1 -0
- package/dist/esm/models/generated/assetHierarchies.d.ts +3 -0
- package/dist/esm/models/generated/assetHierarchies.js.map +1 -1
- package/dist/esm/models/generated/assetHierarchyItem.d.ts +30 -0
- package/dist/esm/models/generated/assetHierarchyItem.js +4 -0
- package/dist/esm/models/generated/assetHierarchyItem.js.map +1 -1
- package/dist/esm/models/generated/assetHierarchyList.d.ts +3 -0
- package/dist/esm/models/generated/assetHierarchyList.js.map +1 -1
- package/dist/esm/models/generated/assetItem.d.ts +36 -0
- package/dist/esm/models/generated/assetItem.js +2 -0
- package/dist/esm/models/generated/assetItem.js.map +1 -1
- package/dist/esm/models/generated/assetListPaginated.d.ts +3 -0
- package/dist/esm/models/generated/assetListPaginated.js.map +1 -1
- package/dist/esm/models/generated/assetLocationItem.d.ts +6 -0
- package/dist/esm/models/generated/assetLocationItem.js.map +1 -1
- package/dist/esm/models/generated/assetMetricItem.d.ts +25 -0
- package/dist/esm/models/generated/assetMetricItem.js +16 -0
- package/dist/esm/models/generated/assetMetricItem.js.map +1 -0
- package/dist/esm/models/generated/assetOEE.d.ts +3 -0
- package/dist/esm/models/generated/assetOEE.js.map +1 -1
- package/dist/esm/models/generated/assetProperty.d.ts +9 -0
- package/dist/esm/models/generated/assetProperty.js.map +1 -1
- package/dist/esm/models/generated/assetStatisticsItem.d.ts +58 -0
- package/dist/esm/models/generated/assetStatisticsItem.js +24 -0
- package/dist/esm/models/generated/assetStatisticsItem.js.map +1 -0
- package/dist/esm/models/generated/assetStatisticsPaginated.d.ts +24 -0
- package/dist/esm/models/generated/assetStatisticsPaginated.js +18 -0
- package/dist/esm/models/generated/assetStatisticsPaginated.js.map +1 -0
- package/dist/esm/models/generated/assetStatus.d.ts +3 -0
- package/dist/esm/models/generated/assetStatus.js.map +1 -1
- package/dist/esm/models/generated/assetStatusCount.d.ts +15 -0
- package/dist/esm/models/generated/assetStatusCount.js.map +1 -1
- package/dist/esm/models/generated/assetStatusItem.d.ts +6 -0
- package/dist/esm/models/generated/assetStatusItem.js.map +1 -1
- package/dist/esm/models/generated/assetTemplate.d.ts +54 -0
- package/dist/esm/models/generated/assetTemplate.js +4 -0
- package/dist/esm/models/generated/assetTemplate.js.map +1 -1
- package/dist/esm/models/generated/assetTemplateHierarchy.d.ts +30 -0
- package/dist/esm/models/generated/assetTemplateHierarchy.js +4 -0
- package/dist/esm/models/generated/assetTemplateHierarchy.js.map +1 -1
- package/dist/esm/models/generated/assetTemplateItem.d.ts +42 -0
- package/dist/esm/models/generated/assetTemplateItem.js.map +1 -1
- package/dist/esm/models/generated/assetTemplateListPaginated.d.ts +3 -0
- package/dist/esm/models/generated/assetTemplateListPaginated.js.map +1 -1
- package/dist/esm/models/generated/assetTemplateProperties.d.ts +9 -0
- package/dist/esm/models/generated/assetTemplateProperties.js.map +1 -1
- package/dist/esm/models/generated/assetType.d.ts +30 -0
- package/dist/esm/models/generated/assetType.js.map +1 -1
- package/dist/esm/models/generated/assetTypeItem.d.ts +30 -0
- package/dist/esm/models/generated/assetTypeItem.js.map +1 -1
- package/dist/esm/models/generated/assetTypeListPaginated.d.ts +3 -0
- package/dist/esm/models/generated/assetTypeListPaginated.js.map +1 -1
- package/dist/esm/models/generated/assetTypeMetadata.d.ts +15 -0
- package/dist/esm/models/generated/assetTypeMetadata.js.map +1 -1
- package/dist/esm/models/generated/assetTypeMetadataItem.d.ts +15 -0
- package/dist/esm/models/generated/assetTypeMetadataItem.js.map +1 -1
- package/dist/esm/models/generated/assetTypeMetadataListPaginated.d.ts +3 -0
- package/dist/esm/models/generated/assetTypeMetadataListPaginated.js.map +1 -1
- package/dist/esm/models/generated/attachment.d.ts +23 -0
- package/dist/esm/models/generated/attachment.js +18 -0
- package/dist/esm/models/generated/attachment.js.map +1 -0
- package/dist/esm/models/generated/cSVError.d.ts +18 -0
- package/dist/esm/models/generated/cSVError.js.map +1 -1
- package/dist/esm/models/generated/cSVErrorMessage.d.ts +3 -12
- package/dist/esm/models/generated/cSVErrorMessage.js +1 -3
- package/dist/esm/models/generated/cSVErrorMessage.js.map +1 -1
- package/dist/esm/models/generated/cSVPosition.d.ts +12 -0
- package/dist/esm/models/generated/cSVPosition.js.map +1 -1
- package/dist/esm/models/generated/controlChange.d.ts +60 -0
- package/dist/esm/models/generated/controlChange.js +23 -0
- package/dist/esm/models/generated/controlChange.js.map +1 -0
- package/dist/esm/models/generated/controlChangeGet.d.ts +81 -0
- package/dist/esm/models/generated/controlChangeGet.js +28 -0
- package/dist/esm/models/generated/controlChangeGet.js.map +1 -0
- package/dist/esm/models/generated/controlChangeGetPaginated.d.ts +24 -0
- package/dist/esm/models/generated/controlChangeGetPaginated.js +18 -0
- package/dist/esm/models/generated/controlChangeGetPaginated.js.map +1 -0
- package/dist/esm/models/generated/controlChangeGetStatus.d.ts +35 -0
- package/dist/esm/models/generated/controlChangeGetStatus.js +18 -0
- package/dist/esm/models/generated/controlChangeGetStatus.js.map +1 -0
- package/dist/esm/models/generated/controlChangePaginated.d.ts +24 -0
- package/dist/esm/models/generated/controlChangePaginated.js +18 -0
- package/dist/esm/models/generated/controlChangePaginated.js.map +1 -0
- package/dist/esm/models/generated/emissionsAsset.d.ts +19 -0
- package/dist/esm/models/generated/emissionsAsset.js +16 -0
- package/dist/esm/models/generated/emissionsAsset.js.map +1 -0
- package/dist/esm/models/generated/emissionsAssetLists.d.ts +22 -0
- package/dist/esm/models/generated/emissionsAssetLists.js +18 -0
- package/dist/esm/models/generated/emissionsAssetLists.js.map +1 -0
- package/dist/esm/models/generated/emissionsDashboard.d.ts +29 -0
- package/dist/esm/models/generated/emissionsDashboard.js +23 -0
- package/dist/esm/models/generated/emissionsDashboard.js.map +1 -0
- package/dist/esm/models/generated/emissionsDashboardAnalytics.d.ts +26 -0
- package/dist/esm/models/generated/emissionsDashboardAnalytics.js +20 -0
- package/dist/esm/models/generated/emissionsDashboardAnalytics.js.map +1 -0
- package/dist/esm/models/generated/emissionsDashboardAnalyticsHistorian.d.ts +25 -0
- package/dist/esm/models/generated/emissionsDashboardAnalyticsHistorian.js +19 -0
- package/dist/esm/models/generated/emissionsDashboardAnalyticsHistorian.js.map +1 -0
- package/dist/esm/models/generated/emissionsDashboardTotals.d.ts +27 -0
- package/dist/esm/models/generated/emissionsDashboardTotals.js +20 -0
- package/dist/esm/models/generated/emissionsDashboardTotals.js.map +1 -0
- package/dist/esm/models/generated/emissionsGreenhouse.d.ts +21 -0
- package/dist/esm/models/generated/emissionsGreenhouse.js +17 -0
- package/dist/esm/models/generated/emissionsGreenhouse.js.map +1 -0
- package/dist/esm/models/generated/errorMessage.d.ts +9 -0
- package/dist/esm/models/generated/errorMessage.js.map +1 -1
- package/dist/esm/models/generated/errorMessages.d.ts +3 -0
- package/dist/esm/models/generated/errorMessages.js.map +1 -1
- package/dist/esm/models/generated/errorsError.d.ts +18 -0
- package/dist/esm/models/generated/errorsError.js.map +1 -1
- package/dist/esm/models/generated/errorsErrorMessage.d.ts +3 -9
- package/dist/esm/models/generated/errorsErrorMessage.js +1 -4
- package/dist/esm/models/generated/errorsErrorMessage.js.map +1 -1
- package/dist/esm/models/generated/failureDetection.d.ts +14 -0
- package/dist/esm/models/generated/failureDetection.js +2 -1
- package/dist/esm/models/generated/failureDetection.js.map +1 -1
- package/dist/esm/models/generated/failureDetectionProperty.d.ts +9 -0
- package/dist/esm/models/generated/failureDetectionProperty.js.map +1 -1
- package/dist/esm/models/generated/failureEventItem.d.ts +2 -0
- package/dist/esm/models/generated/failureEventItem.js +1 -0
- package/dist/esm/models/generated/failureEventItem.js.map +1 -1
- package/dist/esm/models/generated/failureOverviewItem.d.ts +58 -0
- package/dist/esm/models/generated/failureOverviewItem.js +24 -0
- package/dist/esm/models/generated/failureOverviewItem.js.map +1 -0
- package/dist/esm/models/generated/failureOverviewPaginated.d.ts +24 -0
- package/dist/esm/models/generated/failureOverviewPaginated.js +18 -0
- package/dist/esm/models/generated/failureOverviewPaginated.js.map +1 -0
- package/dist/esm/models/generated/failureOverviewStatistics.d.ts +24 -0
- package/dist/esm/models/generated/failureOverviewStatistics.js +18 -0
- package/dist/esm/models/generated/failureOverviewStatistics.js.map +1 -0
- package/dist/esm/models/generated/index.d.ts +50 -5
- package/dist/esm/models/generated/index.js +50 -5
- package/dist/esm/models/generated/index.js.map +1 -1
- package/dist/esm/models/generated/mapFailureDetection.d.ts +17 -0
- package/dist/esm/models/generated/mapFailureDetection.js +15 -0
- package/dist/esm/models/generated/mapFailureDetection.js.map +1 -0
- package/dist/esm/models/generated/mapItem.d.ts +9 -6
- package/dist/esm/models/generated/mapItem.js +5 -3
- package/dist/esm/models/generated/mapItem.js.map +1 -1
- package/dist/esm/models/generated/mapModel.d.ts +7 -4
- package/dist/esm/models/generated/mapModel.js +4 -2
- package/dist/esm/models/generated/mapModel.js.map +1 -1
- package/dist/esm/models/generated/mapOEE.d.ts +26 -0
- package/dist/esm/models/generated/mapOEE.js +21 -0
- package/dist/esm/models/generated/mapOEE.js.map +1 -0
- package/dist/{cjs/models/generated/assetShift.d.ts → esm/models/generated/mapShift.d.ts} +5 -5
- package/dist/esm/models/generated/{assetShift.js → mapShift.js} +3 -3
- package/dist/esm/models/generated/mapShift.js.map +1 -0
- package/dist/esm/models/generated/metric.d.ts +30 -0
- package/dist/esm/models/generated/metric.js.map +1 -1
- package/dist/esm/models/generated/metricItem.d.ts +30 -0
- package/dist/esm/models/generated/metricItem.js.map +1 -1
- package/dist/esm/models/generated/metricListPaginated.d.ts +3 -0
- package/dist/esm/models/generated/metricListPaginated.js.map +1 -1
- package/dist/esm/models/generated/oEECalculation.d.ts +15 -0
- package/dist/esm/models/generated/oEECalculation.js.map +1 -1
- package/dist/esm/models/generated/oEEThresholds.d.ts +9 -0
- package/dist/esm/models/generated/oEEThresholds.js.map +1 -1
- package/dist/esm/models/generated/oEEValues.d.ts +12 -0
- package/dist/esm/models/generated/oEEValues.js.map +1 -1
- package/dist/esm/models/generated/pagination.d.ts +9 -0
- package/dist/esm/models/generated/pagination.js.map +1 -1
- package/dist/esm/models/generated/parameterAppVersionAsset.d.ts +29 -0
- package/dist/esm/models/generated/parameterAppVersionAsset.js +21 -0
- package/dist/esm/models/generated/parameterAppVersionAsset.js.map +1 -0
- package/dist/esm/models/generated/parameterAppVersionAssetListPaginated.d.ts +21 -0
- package/dist/esm/models/generated/parameterAppVersionAssetListPaginated.js +18 -0
- package/dist/esm/models/generated/parameterAppVersionAssetListPaginated.js.map +1 -0
- package/dist/esm/models/generated/parameterGetSchema.d.ts +28 -0
- package/dist/esm/models/generated/parameterGetSchema.js +19 -0
- package/dist/esm/models/generated/parameterGetSchema.js.map +1 -0
- package/dist/esm/models/generated/parameterschemaParameterJSONSchema.d.ts +28 -0
- package/dist/esm/models/generated/parameterschemaParameterJSONSchema.js +19 -0
- package/dist/esm/models/generated/parameterschemaParameterJSONSchema.js.map +1 -0
- package/dist/esm/models/generated/parameterschemaParameterJSONSchemaProperties.d.ts +35 -0
- package/dist/esm/models/generated/parameterschemaParameterJSONSchemaProperties.js +24 -0
- package/dist/esm/models/generated/parameterschemaParameterJSONSchemaProperties.js.map +1 -0
- package/dist/esm/models/generated/reply.d.ts +26 -0
- package/dist/esm/models/generated/reply.js +20 -0
- package/dist/esm/models/generated/reply.js.map +1 -0
- package/dist/esm/models/generated/responsibleFor.d.ts +19 -0
- package/dist/esm/models/generated/{appVersionStatus.js → responsibleFor.js} +3 -6
- package/dist/esm/models/generated/responsibleFor.js.map +1 -0
- package/dist/esm/models/generated/rule.d.ts +37 -0
- package/dist/esm/models/generated/rule.js +26 -0
- package/dist/esm/models/generated/rule.js.map +1 -0
- package/dist/esm/models/generated/ruleAction.d.ts +19 -0
- package/dist/esm/models/generated/ruleAction.js +16 -0
- package/dist/esm/models/generated/ruleAction.js.map +1 -0
- package/dist/esm/models/generated/ruleInput.d.ts +19 -0
- package/dist/esm/models/generated/ruleInput.js +16 -0
- package/dist/esm/models/generated/ruleInput.js.map +1 -0
- package/dist/esm/models/generated/{errorsPayloadErrors.d.ts → ruleLogs.d.ts} +5 -3
- package/dist/esm/models/generated/{errorsPayloadErrors.js → ruleLogs.js} +5 -3
- package/dist/esm/models/generated/ruleLogs.js.map +1 -0
- package/dist/esm/models/generated/rulePayload.d.ts +23 -0
- package/dist/esm/models/generated/rulePayload.js +19 -0
- package/dist/esm/models/generated/rulePayload.js.map +1 -0
- package/dist/esm/models/generated/ruleStatus.d.ts +21 -0
- package/dist/esm/models/generated/ruleStatus.js +17 -0
- package/dist/esm/models/generated/ruleStatus.js.map +1 -0
- package/dist/esm/models/generated/rulesListPaginated.d.ts +21 -0
- package/dist/esm/models/generated/rulesListPaginated.js +18 -0
- package/dist/esm/models/generated/rulesListPaginated.js.map +1 -0
- package/dist/esm/models/generated/semanticTypeItem.d.ts +12 -0
- package/dist/esm/models/generated/semanticTypeItem.js.map +1 -1
- package/dist/esm/models/generated/semanticTypeList.d.ts +3 -0
- package/dist/esm/models/generated/semanticTypeList.js.map +1 -1
- package/dist/esm/models/generated/severityStatistics.d.ts +12 -0
- package/dist/esm/models/generated/severityStatistics.js.map +1 -1
- package/dist/esm/models/generated/simpleAsset.d.ts +6 -0
- package/dist/esm/models/generated/simpleAsset.js.map +1 -1
- package/dist/esm/models/generated/statusStatistics.d.ts +9 -0
- package/dist/esm/models/generated/statusStatistics.js.map +1 -1
- package/dist/esm/models/generated/symbol.d.ts +27 -0
- package/dist/esm/models/generated/symbol.js +20 -0
- package/dist/esm/models/generated/symbol.js.map +1 -0
- package/dist/esm/models/generated/symbolItem.d.ts +27 -0
- package/dist/esm/models/generated/symbolItem.js +20 -0
- package/dist/esm/models/generated/symbolItem.js.map +1 -0
- package/dist/esm/models/generated/symbolsListPaginated.d.ts +21 -0
- package/dist/esm/models/generated/symbolsListPaginated.js +18 -0
- package/dist/esm/models/generated/symbolsListPaginated.js.map +1 -0
- package/dist/esm/models/generated/teamMember.d.ts +3 -2
- package/dist/esm/models/generated/teamMember.js +2 -1
- package/dist/esm/models/generated/teamMember.js.map +1 -1
- package/dist/esm/models/generated/thread.d.ts +37 -0
- package/dist/esm/models/generated/thread.js +24 -0
- package/dist/esm/models/generated/thread.js.map +1 -0
- package/dist/esm/models/generated/threadContent.d.ts +25 -0
- package/dist/esm/models/generated/threadContent.js +20 -0
- package/dist/esm/models/generated/threadContent.js.map +1 -0
- package/dist/esm/models/generated/userFollow.d.ts +19 -0
- package/dist/esm/models/generated/userFollow.js +16 -0
- package/dist/esm/models/generated/userFollow.js.map +1 -0
- package/dist/esm/models/generated/view2D.d.ts +30 -0
- package/dist/esm/models/generated/view2D.js +17 -0
- package/dist/esm/models/generated/view2D.js.map +1 -0
- package/dist/esm/models/generated/view3D.d.ts +35 -0
- package/dist/esm/models/generated/view3D.js +18 -0
- package/dist/esm/models/generated/view3D.js.map +1 -0
- package/dist/esm/models/generated/visualization.d.ts +21 -0
- package/dist/esm/models/generated/visualization.js +18 -0
- package/dist/esm/models/generated/visualization.js.map +1 -0
- package/dist/esm/models/model-helper.d.ts +7 -1
- package/dist/esm/models/model-helper.js +32 -14
- package/dist/esm/models/model-helper.js.map +1 -1
- package/dist/esm/models/model.js +3 -4
- package/dist/esm/models/model.js.map +1 -1
- package/dist/esm/services/generated/api/aCP.service.js.map +1 -1
- package/dist/esm/services/generated/api/alarm.service.d.ts +20 -7
- package/dist/esm/services/generated/api/alarm.service.js +34 -6
- package/dist/esm/services/generated/api/alarm.service.js.map +1 -1
- package/dist/esm/services/generated/api/appRegistry.service.d.ts +2 -22
- package/dist/esm/services/generated/api/appRegistry.service.js +1 -55
- package/dist/esm/services/generated/api/appRegistry.service.js.map +1 -1
- package/dist/esm/services/generated/api/asset.service.d.ts +152 -133
- package/dist/esm/services/generated/api/asset.service.js +232 -152
- package/dist/esm/services/generated/api/asset.service.js.map +1 -1
- package/dist/esm/services/generated/api/bridge.service.js.map +1 -1
- package/dist/esm/services/generated/api/controlChange.service.d.ts +80 -0
- package/dist/esm/services/generated/api/controlChange.service.js +200 -0
- package/dist/esm/services/generated/api/controlChange.service.js.map +1 -0
- package/dist/esm/services/generated/api/dataLabel.service.d.ts +8 -1
- package/dist/esm/services/generated/api/dataLabel.service.js +15 -0
- package/dist/esm/services/generated/api/dataLabel.service.js.map +1 -1
- package/dist/esm/services/generated/api/dataType.service.js.map +1 -1
- package/dist/esm/services/generated/api/failureDetection.service.js.map +1 -1
- package/dist/esm/services/generated/api/index.d.ts +5 -0
- package/dist/esm/services/generated/api/index.js +5 -0
- package/dist/esm/services/generated/api/index.js.map +1 -1
- package/dist/esm/services/generated/api/instance.service.js.map +1 -1
- package/dist/esm/services/generated/api/integration.service.js.map +1 -1
- package/dist/esm/services/generated/api/map.service.d.ts +73 -5
- package/dist/esm/services/generated/api/map.service.js +170 -4
- package/dist/esm/services/generated/api/map.service.js.map +1 -1
- package/dist/esm/services/generated/api/metric.service.d.ts +26 -26
- package/dist/esm/services/generated/api/metric.service.js +26 -26
- package/dist/esm/services/generated/api/metric.service.js.map +1 -1
- package/dist/esm/services/generated/api/orchestration.service.js.map +1 -1
- package/dist/esm/services/generated/api/parameters.service.d.ts +42 -0
- package/dist/esm/services/generated/api/parameters.service.js +79 -0
- package/dist/esm/services/generated/api/parameters.service.js.map +1 -0
- package/dist/esm/services/generated/api/rule.service.d.ts +63 -0
- package/dist/esm/services/generated/api/rule.service.js +142 -0
- package/dist/esm/services/generated/api/rule.service.js.map +1 -0
- package/dist/esm/services/generated/api/secret.service.js.map +1 -1
- package/dist/esm/services/generated/api/storage.service.js.map +1 -1
- package/dist/esm/services/generated/api/thread.service.d.ts +94 -0
- package/dist/esm/services/generated/api/thread.service.js +220 -0
- package/dist/esm/services/generated/api/thread.service.js.map +1 -0
- package/dist/esm/services/generated/api/uI.service.d.ts +17 -0
- package/dist/esm/services/generated/api/uI.service.js +27 -0
- package/dist/esm/services/generated/api/uI.service.js.map +1 -0
- package/dist/esm/services/generated/api/user.service.js.map +1 -1
- package/dist/esm/services/generated/api/wireguard.service.js.map +1 -1
- package/dist/esm/services/generated/api/workload.service.d.ts +2 -1
- package/dist/esm/services/generated/api/workload.service.js +5 -1
- package/dist/esm/services/generated/api/workload.service.js.map +1 -1
- package/dist/esm/services/generated/models/aCPStatusUpdateData.d.ts +1 -0
- package/dist/esm/services/generated/models/aCPStatusUpdateData.js.map +1 -1
- package/dist/esm/services/generated/models/alarmCreateData.d.ts +5 -5
- package/dist/esm/services/generated/models/alarmCreateData.js.map +1 -1
- package/dist/esm/services/generated/models/alarmSeverityData.d.ts +8 -0
- package/dist/esm/services/generated/models/alarmSeverityData.js +1 -0
- package/dist/esm/services/generated/models/alarmSeverityData.js.map +1 -0
- package/dist/esm/services/generated/models/alarmSeverityUpdateData.d.ts +7 -0
- package/dist/esm/services/generated/models/alarmSeverityUpdateData.js +1 -0
- package/dist/esm/services/generated/models/alarmSeverityUpdateData.js.map +1 -0
- package/dist/esm/services/generated/models/assetClassCreateData.d.ts +3 -3
- package/dist/esm/services/generated/models/assetClassCreateData.js.map +1 -1
- package/dist/esm/services/generated/models/assetClassUpdateData.d.ts +1 -1
- package/dist/esm/services/generated/models/assetClassUpdateData.js.map +1 -1
- package/dist/esm/services/generated/models/assetCreateData.d.ts +9 -4
- package/dist/esm/services/generated/models/assetCreateData.js.map +1 -1
- package/dist/esm/services/generated/models/assetCreateWithParentData.d.ts +9 -4
- package/dist/esm/services/generated/models/assetCreateWithParentData.js.map +1 -1
- package/dist/esm/services/generated/models/assetDataStreamsListData.d.ts +6 -0
- package/dist/esm/services/generated/models/assetDataStreamsListData.js +1 -0
- package/dist/esm/services/generated/models/assetDataStreamsListData.js.map +1 -0
- package/dist/esm/services/generated/models/assetMetricItemData.d.ts +6 -0
- package/dist/esm/services/generated/models/assetMetricItemData.js +1 -0
- package/dist/esm/services/generated/models/assetMetricItemData.js.map +1 -0
- package/dist/esm/services/generated/models/assetOEEGetData.d.ts +1 -1
- package/dist/esm/services/generated/models/assetOEEGetData.js.map +1 -1
- package/dist/esm/services/generated/models/assetStatisticsData.d.ts +9 -0
- package/dist/esm/services/generated/models/assetStatisticsData.js +1 -0
- package/dist/esm/services/generated/models/assetStatisticsData.js.map +1 -0
- package/dist/esm/services/generated/models/assetTemplateCreateData.d.ts +8 -4
- package/dist/esm/services/generated/models/assetTemplateCreateData.js.map +1 -1
- package/dist/esm/services/generated/models/assetTemplateHierarchyData.d.ts +6 -2
- package/dist/esm/services/generated/models/assetTemplateHierarchyData.js.map +1 -1
- package/dist/esm/services/generated/models/assetTemplateUpdateData.d.ts +4 -0
- package/dist/esm/services/generated/models/assetTemplateUpdateData.js.map +1 -1
- package/dist/esm/services/generated/models/assetTypeCreateData.d.ts +3 -3
- package/dist/esm/services/generated/models/assetTypeCreateData.js.map +1 -1
- package/dist/esm/services/generated/models/assetTypeMetadataCreateData.d.ts +2 -2
- package/dist/esm/services/generated/models/assetTypeMetadataCreateData.js.map +1 -1
- package/dist/esm/services/generated/models/assetTypeMetadataUpdateData.d.ts +1 -1
- package/dist/esm/services/generated/models/assetTypeMetadataUpdateData.js.map +1 -1
- package/dist/esm/services/generated/models/assetUpdateData.d.ts +6 -1
- package/dist/esm/services/generated/models/assetUpdateData.js.map +1 -1
- package/dist/esm/services/generated/models/controlChangeCreateData.d.ts +11 -0
- package/dist/esm/services/generated/models/controlChangeCreateData.js +1 -0
- package/dist/esm/services/generated/models/controlChangeCreateData.js.map +1 -0
- package/dist/esm/services/generated/models/controlChangeLastData.d.ts +9 -0
- package/dist/esm/services/generated/models/controlChangeLastData.js +1 -0
- package/dist/esm/services/generated/models/controlChangeLastData.js.map +1 -0
- package/dist/esm/services/generated/models/controlChangeListData.d.ts +9 -0
- package/dist/esm/services/generated/models/controlChangeListData.js +1 -0
- package/dist/esm/services/generated/models/controlChangeListData.js.map +1 -0
- package/dist/esm/services/generated/models/controlChangePayloadData.d.ts +9 -0
- package/dist/esm/services/generated/models/controlChangePayloadData.js +1 -0
- package/dist/esm/services/generated/models/controlChangePayloadData.js.map +1 -0
- package/dist/esm/services/generated/models/controlChangeRangeData.d.ts +11 -0
- package/dist/esm/services/generated/models/controlChangeRangeData.js +1 -0
- package/dist/esm/services/generated/models/controlChangeRangeData.js.map +1 -0
- package/dist/esm/services/generated/models/controlChangeStatusData.d.ts +11 -0
- package/dist/esm/services/generated/models/controlChangeStatusData.js +1 -0
- package/dist/esm/services/generated/models/controlChangeStatusData.js.map +1 -0
- package/dist/esm/services/generated/models/controlChangeStatusPayloadData.d.ts +8 -0
- package/dist/esm/services/generated/models/controlChangeStatusPayloadData.js +1 -0
- package/dist/esm/services/generated/models/controlChangeStatusPayloadData.js.map +1 -0
- package/dist/esm/services/generated/models/controlChangeUploadData.d.ts +9 -0
- package/dist/esm/services/generated/models/controlChangeUploadData.js +1 -0
- package/dist/esm/services/generated/models/controlChangeUploadData.js.map +1 -0
- package/dist/esm/services/generated/models/controlChangeUploadRequestData.d.ts +11 -0
- package/dist/esm/services/generated/models/controlChangeUploadRequestData.js +1 -0
- package/dist/esm/services/generated/models/controlChangeUploadRequestData.js.map +1 -0
- package/dist/esm/services/generated/models/failureOverviewData.d.ts +10 -0
- package/dist/esm/services/generated/models/failureOverviewData.js +1 -0
- package/dist/esm/services/generated/models/failureOverviewData.js.map +1 -0
- package/dist/esm/services/generated/models/hierarchyUpdateItemData.d.ts +9 -4
- package/dist/esm/services/generated/models/hierarchyUpdateItemData.js.map +1 -1
- package/dist/esm/services/generated/models/index.d.ts +31 -3
- package/dist/esm/services/generated/models/index.js +31 -3
- package/dist/esm/services/generated/models/index.js.map +1 -1
- package/dist/esm/services/generated/models/integrationAwsRegionUpdateData.d.ts +0 -1
- package/dist/esm/services/generated/models/integrationAwsRegionUpdateData.js.map +1 -1
- package/dist/esm/services/generated/models/integrationUpdateData.d.ts +0 -1
- package/dist/esm/services/generated/models/integrationUpdateData.js.map +1 -1
- package/dist/esm/services/generated/models/{assetOEECreateData.d.ts → mapOEECreateData.d.ts} +1 -1
- package/dist/esm/services/generated/models/mapOEECreateData.js +1 -0
- package/dist/esm/services/generated/models/mapOEECreateData.js.map +1 -0
- package/dist/esm/services/generated/models/mapOEEGetData.d.ts +7 -0
- package/dist/esm/services/generated/models/mapOEEGetData.js +1 -0
- package/dist/esm/services/generated/models/mapOEEGetData.js.map +1 -0
- package/dist/{cjs/services/generated/models/assetShiftCreateData.d.ts → esm/services/generated/models/mapShiftCreateData.d.ts} +1 -2
- package/dist/esm/services/generated/models/mapShiftCreateData.js +1 -0
- package/dist/esm/services/generated/models/mapShiftCreateData.js.map +1 -0
- package/dist/esm/services/generated/models/mapShiftGetData.d.ts +7 -0
- package/dist/esm/services/generated/models/mapShiftGetData.js +1 -0
- package/dist/esm/services/generated/models/mapShiftGetData.js.map +1 -0
- package/dist/esm/services/generated/models/mapUpdateData.d.ts +1 -0
- package/dist/esm/services/generated/models/mapUpdateData.js.map +1 -1
- package/dist/esm/services/generated/models/notificationsUserSettingData.d.ts +1 -1
- package/dist/esm/services/generated/models/notificationsUserSettingData.js.map +1 -1
- package/dist/esm/services/generated/models/parameterUpdateData.d.ts +6 -0
- package/dist/esm/services/generated/models/parameterUpdateData.js +1 -0
- package/dist/esm/services/generated/models/parameterUpdateData.js.map +1 -0
- package/dist/esm/services/generated/models/responsibleForData.d.ts +7 -0
- package/dist/esm/services/generated/models/responsibleForData.js +1 -0
- package/dist/esm/services/generated/models/responsibleForData.js.map +1 -0
- package/dist/esm/services/generated/models/ruleActionData.d.ts +7 -0
- package/dist/esm/services/generated/models/ruleActionData.js +1 -0
- package/dist/esm/services/generated/models/ruleActionData.js.map +1 -0
- package/dist/esm/services/generated/models/ruleCreateData.d.ts +12 -0
- package/dist/esm/services/generated/models/ruleCreateData.js +1 -0
- package/dist/esm/services/generated/models/ruleCreateData.js.map +1 -0
- package/dist/esm/services/generated/models/ruleInputData.d.ts +7 -0
- package/dist/esm/services/generated/models/ruleInputData.js +1 -0
- package/dist/esm/services/generated/models/ruleInputData.js.map +1 -0
- package/dist/esm/services/generated/models/rulePayloadData.d.ts +10 -0
- package/dist/esm/services/generated/models/rulePayloadData.js +1 -0
- package/dist/esm/services/generated/models/rulePayloadData.js.map +1 -0
- package/dist/esm/services/generated/models/ruleUpdateData.d.ts +11 -0
- package/dist/esm/services/generated/models/ruleUpdateData.js +1 -0
- package/dist/esm/services/generated/models/ruleUpdateData.js.map +1 -0
- package/dist/esm/services/generated/models/symbolCreateData.d.ts +9 -0
- package/dist/esm/services/generated/models/symbolCreateData.js +1 -0
- package/dist/esm/services/generated/models/symbolCreateData.js.map +1 -0
- package/dist/esm/services/generated/models/symbolUpdateData.d.ts +8 -0
- package/dist/esm/services/generated/models/symbolUpdateData.js +1 -0
- package/dist/esm/services/generated/models/symbolUpdateData.js.map +1 -0
- package/dist/esm/services/generated/models/teamMemberData.d.ts +2 -1
- package/dist/esm/services/generated/models/teamMemberData.js.map +1 -1
- package/dist/esm/services/generated/models/view2DData.d.ts +8 -0
- package/dist/esm/services/generated/models/view2DData.js +1 -0
- package/dist/esm/services/generated/models/view2DData.js.map +1 -0
- package/dist/esm/services/generated/models/view3DData.d.ts +9 -0
- package/dist/esm/services/generated/models/view3DData.js +1 -0
- package/dist/esm/services/generated/models/view3DData.js.map +1 -0
- package/dist/esm/services/generated/models/visualizationData.d.ts +9 -0
- package/dist/esm/services/generated/models/visualizationData.js +1 -0
- package/dist/esm/services/generated/models/visualizationData.js.map +1 -0
- package/dist/esm/services/generated/models/workloadDeployData.d.ts +2 -2
- package/dist/esm/services/generated/models/workloadDeployData.js.map +1 -1
- package/dist/esm/services/generated/types/alarm.service.types.d.ts +11 -2
- package/dist/esm/services/generated/types/alarm.service.types.js.map +1 -1
- package/dist/esm/services/generated/types/appRegistry.service.types.d.ts +0 -18
- package/dist/esm/services/generated/types/appRegistry.service.types.js.map +1 -1
- package/dist/esm/services/generated/types/asset.service.types.d.ts +36 -17
- package/dist/esm/services/generated/types/asset.service.types.js.map +1 -1
- package/dist/esm/services/generated/types/controlChange.service.types.d.ts +64 -0
- package/dist/esm/services/generated/types/controlChange.service.types.js +1 -0
- package/dist/esm/services/generated/types/controlChange.service.types.js.map +1 -0
- package/dist/esm/services/generated/types/dataLabel.service.types.d.ts +6 -0
- package/dist/esm/services/generated/types/dataLabel.service.types.js.map +1 -1
- package/dist/esm/services/generated/types/index.d.ts +5 -0
- package/dist/esm/services/generated/types/index.js +5 -0
- package/dist/esm/services/generated/types/index.js.map +1 -1
- package/dist/esm/services/generated/types/map.service.types.d.ts +61 -1
- package/dist/esm/services/generated/types/map.service.types.js.map +1 -1
- package/dist/esm/services/generated/types/parameters.service.types.d.ts +30 -0
- package/dist/esm/services/generated/types/parameters.service.types.js +1 -0
- package/dist/esm/services/generated/types/parameters.service.types.js.map +1 -0
- package/dist/esm/services/generated/types/rule.service.types.d.ts +48 -0
- package/dist/esm/services/generated/types/rule.service.types.js +1 -0
- package/dist/esm/services/generated/types/rule.service.types.js.map +1 -0
- package/dist/esm/services/generated/types/thread.service.types.d.ts +74 -0
- package/dist/esm/services/generated/types/thread.service.types.js +1 -0
- package/dist/esm/services/generated/types/thread.service.types.js.map +1 -0
- package/dist/esm/services/generated/types/uI.service.types.d.ts +6 -0
- package/dist/esm/services/generated/types/uI.service.types.js +1 -0
- package/dist/esm/services/generated/types/uI.service.types.js.map +1 -0
- package/dist/esm/services/generated/types/workload.service.types.d.ts +1 -0
- package/dist/esm/services/generated/types/workload.service.types.js.map +1 -1
- package/package.json +3 -3
- package/dist/cjs/models/generated/appVersionStatus.d.ts +0 -25
- package/dist/cjs/models/generated/appVersionStatus.js.map +0 -1
- package/dist/cjs/models/generated/appVersionStatusItem.d.ts +0 -25
- package/dist/cjs/models/generated/appVersionStatusItem.js +0 -23
- package/dist/cjs/models/generated/appVersionStatusItem.js.map +0 -1
- package/dist/cjs/models/generated/appVersionStatusListPaginated.d.ts +0 -21
- package/dist/cjs/models/generated/appVersionStatusListPaginated.js.map +0 -1
- package/dist/cjs/models/generated/assetShift.js.map +0 -1
- package/dist/cjs/models/generated/errorsPayloadErrors.js.map +0 -1
- package/dist/cjs/services/generated/models/assetOEECreateData.js.map +0 -1
- package/dist/cjs/services/generated/models/assetShiftCreateData.js.map +0 -1
- package/dist/cjs/services/generated/models/assetShiftGetData.js.map +0 -1
- package/dist/esm/models/generated/appVersionStatus.d.ts +0 -25
- package/dist/esm/models/generated/appVersionStatus.js.map +0 -1
- package/dist/esm/models/generated/appVersionStatusItem.d.ts +0 -25
- package/dist/esm/models/generated/appVersionStatusItem.js +0 -19
- package/dist/esm/models/generated/appVersionStatusItem.js.map +0 -1
- package/dist/esm/models/generated/appVersionStatusListPaginated.d.ts +0 -21
- package/dist/esm/models/generated/appVersionStatusListPaginated.js.map +0 -1
- package/dist/esm/models/generated/assetShift.js.map +0 -1
- package/dist/esm/models/generated/errorsPayloadErrors.js.map +0 -1
- package/dist/esm/services/generated/models/assetOEECreateData.js +0 -1
- package/dist/esm/services/generated/models/assetOEECreateData.js.map +0 -1
- package/dist/esm/services/generated/models/assetShiftCreateData.js +0 -1
- package/dist/esm/services/generated/models/assetShiftCreateData.js.map +0 -1
- package/dist/esm/services/generated/models/assetShiftGetData.js +0 -1
- package/dist/esm/services/generated/models/assetShiftGetData.js.map +0 -1
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { Asset, AssetClass, AssetClassListPaginated, AssetHierarchies, AssetHierarchyList, AssetListPaginated, AssetOEE,
|
|
1
|
+
import { Asset, AssetClass, AssetClassListPaginated, AssetDataStreamsListPaginated, AssetHierarchies, AssetHierarchyList, AssetListPaginated, AssetOEE, AssetStatisticsPaginated, AssetStatus, AssetStatusCount, AssetTemplate, AssetTemplateListPaginated, AssetType, AssetTypeListPaginated, AssetTypeMetadata, AssetTypeMetadataListPaginated, FailureOverviewPaginated } from '../../../models';
|
|
2
2
|
import { BaseService } from '../../base.service';
|
|
3
3
|
/**
|
|
4
4
|
* @category Service
|
|
@@ -6,9 +6,9 @@ import { BaseService } from '../../base.service';
|
|
|
6
6
|
export class AssetService extends BaseService {
|
|
7
7
|
/**
|
|
8
8
|
* Create Asset
|
|
9
|
-
* Create Asset **Permission Required:** `kelvin.permission.asset.create`
|
|
9
|
+
* Create Asset Create a <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target=\"_blank\">Kelvin Assets</a> and optionally create a full <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-hierarchy' target='_blank'>hierarchy</a> under the <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target=\"_blank\">Kelvin Asset</a> with one API request. If the top <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target=\"_blank\">Kelvin Assets</a> is a <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-groups' target='_blank'>Kelvin Asset Group</a>, then multiple <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset\" target=\"_blank\">Kelvin Asset</a> can be created in the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-hierarchy' target='_blank'>hierarchy</a> and below the <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset\" target=\"_blank\">Kelvin Asset</a>, multiple <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#component' target='_blank'>Kelvin Components</a>, <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#part' target='_blank'>Kelvin Parts</a> and <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#sensor' target='_blank'>Kelvin Sensors</a> can be created according to <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-hierarchy' target='_blank'>hierarchy</a> rules. If the top <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target=\"_blank\">Kelvin Assets</a> is a <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset\" target=\"_blank\">Kelvin Asset</a>, then below the <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset\" target=\"_blank\">Kelvin Asset</a>, only multiple <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#component' target='_blank'>Kelvin Components</a>, <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#part' target='_blank'>Kelvin Parts</a> and <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#sensor' target='_blank'>Kelvin Sensors</a> can be created according to <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-hierarchy' target='_blank'>hierarchy</a> rules. To create any <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target=\"_blank\">Kelvin Assets</a> you first need to create a <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type\" target=\"_blank\">Kelvin Asset Type</a> and <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class\" target=\"_blank\">Kelvin Asset Class</a>. A Kelvin Asset Class is linked to an entity type which defines how the Kelvin Asset will be referenced in Kelvin Assets. for example: Kelvin Assets that is defined as a Group can only be linked to a Kelvin Type and Kelvin Class that is saved as entity type **group**. There are five entity types; `group`, `asset`, `component`, `part` and `sensor`. Detailed information about these entity types and how they are used can be found at <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target=\"_blank\">https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/</a>. **Permission Required:** `kelvin.permission.asset.create`
|
|
10
10
|
* @param asset Asset create schema
|
|
11
|
-
* @param dryRun
|
|
11
|
+
* @param dryRun Perform a trial run to create the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> without saving the changes.</p> This is very useful when you want to test your new <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Asset</a> structure without making any changes on the Kelvin Platform.
|
|
12
12
|
* @param {IKvHttpRequestOptions} options Request optional parameters
|
|
13
13
|
*/
|
|
14
14
|
static createAsset({ asset, dryRun }, options) {
|
|
@@ -27,8 +27,8 @@ export class AssetService extends BaseService {
|
|
|
27
27
|
}
|
|
28
28
|
/**
|
|
29
29
|
* Create Asset Class
|
|
30
|
-
* Create Asset Class **Permission Required:** `kelvin.permission.asset_class.create`
|
|
31
|
-
* @param assetClass
|
|
30
|
+
* Create Asset Class To create a <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target=\"_blank\">Kelvin Asset</a> you first need to create a <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type\" target=\"_blank\">Kelvin Asset Type</a> and <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class\" target=\"_blank\">Kelvin Asset Class</a>. A <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class' target='_blank'>Kelvin Asset Class</a> is linked to an <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets#entity-type' target='_blank'>Entity Type</a> which defines how the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset' target='_blank'>Kelvin Asset</a> will be referenced in <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a>. For example: <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset' target='_blank'>Kelvin Asset</a> that is defined as a Group can only be linked to a <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type' target='_blank'>Kelvin Asset Type</a> and <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class' target='_blank'>Kelvin Asset Class</a> that is saved as <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets#entity-type' target='_blank'>Entity Type</a> **group**. There are five <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets#entity-type' target='_blank'>Entity Type</a>; `group`, `asset`, `component`, `part` and `sensor`. Detailed information about these <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets#entity-type' target='_blank'>Entity Type</a> and how they are used can be found at <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target=\"_blank\">https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/</a>. A <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type' target='_blank'>Kelvin Asset Type</a> is directly linked to a <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class' target='_blank'>Kelvin Asset Class</a>. There can be many <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type' target='_blank'>Kelvin Asset Type</a> linked to one <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class' target='_blank'>Kelvin Asset Class</a>. **Permission Required:** `kelvin.permission.asset_class.create`
|
|
31
|
+
* @param assetClass Asset Class Create Parameters
|
|
32
32
|
* @param {IKvHttpRequestOptions} options Request optional parameters
|
|
33
33
|
*/
|
|
34
34
|
static createAssetClass({ assetClass }, options) {
|
|
@@ -40,40 +40,9 @@ export class AssetService extends BaseService {
|
|
|
40
40
|
requestConfig.options = options;
|
|
41
41
|
return this.request(`/assets/class/create`, requestConfig, AssetClass);
|
|
42
42
|
}
|
|
43
|
-
/**
|
|
44
|
-
* Create Asset OEE
|
|
45
|
-
* Create Asset OEE **Permission Required:** `kelvin.permission.asset.create`
|
|
46
|
-
* @param assetsOee Asset OEE create schema
|
|
47
|
-
* @param assetName Asset name
|
|
48
|
-
* @param {IKvHttpRequestOptions} options Request optional parameters
|
|
49
|
-
*/
|
|
50
|
-
static createAssetOEE({ assetsOee, assetName }, options) {
|
|
51
|
-
const requestConfig = {
|
|
52
|
-
method: 'post'
|
|
53
|
-
};
|
|
54
|
-
requestConfig.data = assetsOee;
|
|
55
|
-
requestConfig.mediaType = 'application/json';
|
|
56
|
-
requestConfig.options = options;
|
|
57
|
-
return this.request(`/assets/oee/${encodeURIComponent(String(assetName))}/create`, requestConfig, AssetOEE);
|
|
58
|
-
}
|
|
59
|
-
/**
|
|
60
|
-
* Create Asset Shift
|
|
61
|
-
* Create Asset Shift **Permission Required:** `kelvin.permission.asset.create`
|
|
62
|
-
* @param assetShift Asset Shift create schema
|
|
63
|
-
* @param {IKvHttpRequestOptions} options Request optional parameters
|
|
64
|
-
*/
|
|
65
|
-
static createAssetShift({ assetShift }, options) {
|
|
66
|
-
const requestConfig = {
|
|
67
|
-
method: 'post'
|
|
68
|
-
};
|
|
69
|
-
requestConfig.data = assetShift;
|
|
70
|
-
requestConfig.mediaType = 'application/json';
|
|
71
|
-
requestConfig.options = options;
|
|
72
|
-
return this.request(`/assets/shift/create`, requestConfig, AssetShift);
|
|
73
|
-
}
|
|
74
43
|
/**
|
|
75
44
|
* Create Asset Template
|
|
76
|
-
* Create Asset Template **Permission Required:** `kelvin.permission.asset.create`
|
|
45
|
+
* Create Asset Template Create a custom <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/asset-groups' target='_blank'>Kelvin Group</a> or <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Asset</a> template with a full <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-hierarchy' target='_blank'>hierarchy</a> of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset' target='_blank'>Kelvin Assets</a>, <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#component' target='_blank'>Kelvin Components</a>, <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#part' target='_blank'>Kelvin Parts</a> and <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#sensor' target='_blank'>Kelvin Sensors</a>. For each <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Asset</a>, this template can also create all the parameters for <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-ai-failure-detection/' target='_blank'>Kelvin Failure Detection AI</a>, <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metrics</a> and visualization information for <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-maps/' target='_blank'>Kelvin Maps</a> **Permission Required:** `kelvin.permission.asset.create`
|
|
77
46
|
* @param assetTemplate Asset Template create schema
|
|
78
47
|
* @param {IKvHttpRequestOptions} options Request optional parameters
|
|
79
48
|
*/
|
|
@@ -88,8 +57,8 @@ export class AssetService extends BaseService {
|
|
|
88
57
|
}
|
|
89
58
|
/**
|
|
90
59
|
* Create Asset Type
|
|
91
|
-
* Create Asset Type **Permission Required:** `kelvin.permission.asset_type.create`
|
|
92
|
-
* @param assettype
|
|
60
|
+
* Create Asset Type To create a <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target=\"_blank\">Kelvin Asset</a> you first need to create a <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type\" target=\"_blank\">Kelvin Asset Type</a> and <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class\" target=\"_blank\">Kelvin Asset Class</a>. A <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class' target='_blank'>Kelvin Asset Class</a> is linked to an <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets#entity-type' target='_blank'>Entity Type</a> which defines how the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset' target='_blank'>Kelvin Asset</a> will be referenced in <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a>. For example: <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset' target='_blank'>Kelvin Asset</a> that is defined as a Group can only be linked to a <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type' target='_blank'>Kelvin Asset Type</a> and <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class' target='_blank'>Kelvin Asset Class</a> that is saved as <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets#entity-type' target='_blank'>Entity Type</a> **group**. There are five <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets#entity-type' target='_blank'>Entity Type</a>; `group`, `asset`, `component`, `part` and `sensor`. Detailed information about these <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets#entity-type' target='_blank'>Entity Type</a> and how they are used can be found at <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target=\"_blank\">https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/</a>. A <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target=\"_blank\">Kelvin Asset</a> is directly linked to a <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type\" target=\"_blank\">Kelvin Asset Type</a>. There can be many <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target=\"_blank\">Kelvin Assets</a> linked to one <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type\" target=\"_blank\">Kelvin Asset Type</a>. **Permission Required:** `kelvin.permission.asset_type.create`
|
|
61
|
+
* @param assettype Asset Type create schema
|
|
93
62
|
* @param {IKvHttpRequestOptions} options Request optional parameters
|
|
94
63
|
*/
|
|
95
64
|
static createAssetType({ assettype }, options) {
|
|
@@ -103,8 +72,8 @@ export class AssetService extends BaseService {
|
|
|
103
72
|
}
|
|
104
73
|
/**
|
|
105
74
|
* Create Asset Type Metadata
|
|
106
|
-
* Create Asset Type Metadata **Permission Required:** `kelvin.permission.asset_type.create`
|
|
107
|
-
* @param assetTypeName Asset Type name
|
|
75
|
+
* Create Asset Type Metadata Creates a custom JSON payload that can be attached to a <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type\" target=\"_blank\">Kelvin Asset Type</a>. You can create multiple different types of metadata payloads for each <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type\" target=\"_blank\">Kelvin Asset Types</a>. When performing a `get` or `list` API request on <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type\" target=\"_blank\">Kelvin Asset Types</a> or <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target=\"_blank\">Kelvin Assets</a> then you can also add a metadata parameter. The <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets#asset-type-metadata' target='_blank'>Kelvin Asset Type Metadata</a> payload will then be embedded in the response. For listing <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type\" target=\"_blank\">Kelvin Asset Types</a> you can also perform filters on the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets#asset-type-metadata' target='_blank'>Kelvin Asset Type Metadata</a> payload to only return <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type\" target=\"_blank\">Kelvin Asset Types</a> with <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets#asset-type-metadata' target='_blank'>Kelvin Asset Type Metadata</a> payload parameters matching the filters. This <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets#asset-type-metadata' target='_blank'>Kelvin Asset Type Metadata</a> does not affect the operations of <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target=\"_blank\">Kelvin Assets</a> on the Kelvin Platform. <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets#asset-type-metadata' target='_blank'>Kelvin Asset Type Metadata</a> is not available in the <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/overview/#kelvin-manager-ui\" target=\"_blank\">Kelvin Manager UI</a>. **Permission Required:** `kelvin.permission.asset_type.create`
|
|
76
|
+
* @param assetTypeName Unique identifier name of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type' target='_blank'>Kelvin Asset Type</a> to attach the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets#asset-type-metadata' target='_blank'>Kelvin Asset Type Metadata</a> to.</p> This must contain only lowercase alphanumeric characters. The `.`, `_` and `-` characters are also allowed to separate words instead of a space BUT can not be at the beginning or end of the name.
|
|
108
77
|
* @param assettypemetadata Asset Type Metadata create schema
|
|
109
78
|
* @param {IKvHttpRequestOptions} options Request optional parameters
|
|
110
79
|
*/
|
|
@@ -119,8 +88,8 @@ export class AssetService extends BaseService {
|
|
|
119
88
|
}
|
|
120
89
|
/**
|
|
121
90
|
* Delete Asset
|
|
122
|
-
* Delete Asset **Permission Required:** `kelvin.permission.asset.delete`
|
|
123
|
-
* @param assetName Asset name
|
|
91
|
+
* Delete Asset Permanently delete an existing <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Asset</a>. This cannot be undone once the API request has been submitted. <span style=\"color: #ff0000;font-weight: bold;\">WARNING</span> : This command will also delete any <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> that are in the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-hierarchy' target='_blank'>hierarchy</a> below the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Asset</a> being deleted. For example; if a <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset' target='_blank'>Kelvin Asset</a> has also two <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#component' target='_blank'>Kelvin Components</a> and one <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#sensor' target='_blank'>Kelvin Sensor</a> linked in the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-hierarchy' target='_blank'>hierarchy</a> below the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset' target='_blank'>Kelvin Asset</a>, when deleting the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset' target='_blank'>Kelvin Asset</a>, the two <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#component' target='_blank'>Kelvin Components</a> and one <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#sensor' target='_blank'>Kelvin Sensor</a> will also be automatically deleted. If you delete one <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#component' target='_blank'>Kelvin Component</a>, then the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset' target='_blank'>Kelvin Asset</a>, and the remaining <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#component' target='_blank'>Kelvin Component</a> and <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#sensor' target='_blank'>Kelvin Sensor</a> will still remain active as long as they are not positioned below the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#component' target='_blank'>Kelvin Component</a> in the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-hierarchy' target='_blank'>hierarchy</a>. **Permission Required:** `kelvin.permission.asset.delete`
|
|
92
|
+
* @param assetName <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Asset</a> name to delete.</p> This is the unique identifier name and not the display name (title) of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Asset</a>.</p> This must contain only lowercase alphanumeric characters. The `.`, `_` and `-` characters are also allowed to separate words instead of a space BUT can not be at the beginning or end of the name.
|
|
124
93
|
* @param {IKvHttpRequestOptions} options Request optional parameters
|
|
125
94
|
*/
|
|
126
95
|
static deleteAsset({ assetName }, options) {
|
|
@@ -133,8 +102,8 @@ export class AssetService extends BaseService {
|
|
|
133
102
|
}
|
|
134
103
|
/**
|
|
135
104
|
* Delete Asset Class
|
|
136
|
-
* Delete Asset Class **Permission Required:** `kelvin.permission.asset_class.delete`
|
|
137
|
-
* @param assetClassName Asset Class
|
|
105
|
+
* Delete Asset Class Permanently delete an existing <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class' target='_blank'>Kelvin Asset Class</a>. This cannot be undone once the API request has been submitted. This command can not delete <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class' target='_blank'>Kelvin Asset Classes</a> that are currently linked to any <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type' target='_blank'>Kelvin Asset Types</a> and will return an error 403. **Permission Required:** `kelvin.permission.asset_class.delete`
|
|
106
|
+
* @param assetClassName <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class' target='_blank'>Kelvin Asset Class </a> name to delete.</p> This is the unique identifier name and not the display name (title) of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class' target='_blank'>Kelvin Asset Class</a>.</p> This must contain only lowercase alphanumeric characters. The `.`, `_` and `-` characters are also allowed to separate words instead of a space BUT can not be at the beginning or end of the name.
|
|
138
107
|
* @param {IKvHttpRequestOptions} options Request optional parameters
|
|
139
108
|
*/
|
|
140
109
|
static deleteAssetClass({ assetClassName }, options) {
|
|
@@ -147,8 +116,8 @@ export class AssetService extends BaseService {
|
|
|
147
116
|
}
|
|
148
117
|
/**
|
|
149
118
|
* Delete Asset Template
|
|
150
|
-
* Delete Asset Template **Permission Required:** `kelvin.permission.asset.delete`
|
|
151
|
-
* @param assetTemplateName
|
|
119
|
+
* Delete Asset Template Permanently delete an existing <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#kelvin-templates' target='_blank'>Kelvin Template</a>. This cannot be undone once the API request has been submitted. **Permission Required:** `kelvin.permission.asset.delete`
|
|
120
|
+
* @param assetTemplateName <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#kelvin-templates' target='_blank'>Kelvin Template</a> name to retrieve.</p> This is the unique identifier name and not the display name (title) of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#kelvin-templates' target='_blank'>Kelvin Template</a>.
|
|
152
121
|
* @param {IKvHttpRequestOptions} options Request optional parameters
|
|
153
122
|
*/
|
|
154
123
|
static deleteAssetTemplate({ assetTemplateName }, options) {
|
|
@@ -161,8 +130,8 @@ export class AssetService extends BaseService {
|
|
|
161
130
|
}
|
|
162
131
|
/**
|
|
163
132
|
* Delete Asset Type
|
|
164
|
-
* Delete Asset Type **Permission Required:** `kelvin.permission.asset_type.delete`
|
|
165
|
-
* @param assetTypeName Asset Type name
|
|
133
|
+
* Delete Asset Type Permanently delete an existing <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type' target='_blank'>Kelvin Asset Type</a>. This cannot be undone once the API request has been submitted. This command can not delete <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type' target='_blank'>Kelvin Asset Types</a> that are currently linked to any <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> and will return an error 403. **Permission Required:** `kelvin.permission.asset_type.delete`
|
|
134
|
+
* @param assetTypeName <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type' target='_blank'>Kelvin Asset Type</a> name to delete.</p> This is the unique identifier name and not the display name (title) of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type' target='_blank'>Kelvin Asset Type</a>.
|
|
166
135
|
* @param {IKvHttpRequestOptions} options Request optional parameters
|
|
167
136
|
*/
|
|
168
137
|
static deleteAssetType({ assetTypeName }, options) {
|
|
@@ -175,9 +144,9 @@ export class AssetService extends BaseService {
|
|
|
175
144
|
}
|
|
176
145
|
/**
|
|
177
146
|
* Delete Asset Type Metadata
|
|
178
|
-
* Delete Asset Type Metadata **Permission Required:** `kelvin.permission.asset_type.delete`
|
|
179
|
-
* @param assetTypeName Asset Type name
|
|
180
|
-
* @param assetTypeMetadataName Asset Type Metadata name
|
|
147
|
+
* Delete Asset Type Metadata Permanently delete an existing <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets#asset-type-metadata' target='_blank'>Kelvin Asset Type Metadata</a> object associated with a specific <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type' target='_blank'>Kelvin Asset Type</a>. This cannot be undone once the API request has been submitted. This will only delete the specific <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets#asset-type-metadata' target='_blank'>Kelvin Asset Type Metadata</a> object linked to the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type' target='_blank'>Kelvin Asset Type</a>. If there is a <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets#asset-type-metadata' target='_blank'>Kelvin Asset Type Metadata</a> object with the same name and payload BUT associated with a different <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type' target='_blank'>Kelvin Asset Type</a>, this will not be deleted. **Permission Required:** `kelvin.permission.asset_type.delete`
|
|
148
|
+
* @param assetTypeName <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type' target='_blank'>Kelvin Asset Type</a> name to delete.</p> This is the unique identifier name and not the display name (title) of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type' target='_blank'>Kelvin Asset Type</a>.</p> This must contain only lowercase alphanumeric characters. The `.`, `_` and `-` characters are also allowed to separate words instead of a space BUT can not be at the beginning or end of the name.
|
|
149
|
+
* @param assetTypeMetadataName <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets#asset-type-metadata' target='_blank'>Kelvin Asset Type Metadata</a> unique identifier name to delete.</p> This must contain only lowercase alphanumeric characters. The `.`, `_` and `-` characters are also allowed to separate words instead of a space BUT can not be at the beginning or end of the name.
|
|
181
150
|
* @param {IKvHttpRequestOptions} options Request optional parameters
|
|
182
151
|
*/
|
|
183
152
|
static deleteAssetTypeMetadata({ assetTypeName, assetTypeMetadataName }, options) {
|
|
@@ -190,9 +159,9 @@ export class AssetService extends BaseService {
|
|
|
190
159
|
}
|
|
191
160
|
/**
|
|
192
161
|
* Get Asset
|
|
193
|
-
* Get Asset **Permission Required:** `kelvin.permission.asset.read`
|
|
194
|
-
* @param assetName Asset name
|
|
195
|
-
* @param metadata
|
|
162
|
+
* Get Asset Retrieve the properties of a <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Asset</a> and all children <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> in it's <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-hierarchy' target='_blank'>hierarchy</a>. **Permission Required:** `kelvin.permission.asset.read`
|
|
163
|
+
* @param assetName <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Asset</a> name to retrieve.</p> This is the unique identifier name and not the display name (title) of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Asset</a>.</p> This must contain only lowercase alphanumeric characters. The `.`, `_` and `-` characters are also allowed to separate words instead of a space BUT can not be at the beginning or end of the name.
|
|
164
|
+
* @param metadata Array of Kelvin Asset Type Metadata names. Kelvin Asset Type Metadata payload(s) of the names provided will be attached to any <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Asset</a> response object that are linked to any of the Kelvin Asset Type Metadata name(s) in this list.</p> The relationship between <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Asset</a> and Kelvin Asset Type Metadata objects is via the common link to the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type' target='_blank'>Kelvin Asset Type</a>.
|
|
196
165
|
* @param {IKvHttpRequestOptions} options Request optional parameters
|
|
197
166
|
*/
|
|
198
167
|
static getAsset({ assetName, metadata }, options) {
|
|
@@ -210,8 +179,8 @@ export class AssetService extends BaseService {
|
|
|
210
179
|
}
|
|
211
180
|
/**
|
|
212
181
|
* Get Asset Class
|
|
213
|
-
* Get Asset Class **Permission Required:** `kelvin.permission.asset_class.read`
|
|
214
|
-
* @param assetClassName Asset Class
|
|
182
|
+
* Get Asset Class Retrieves the properties of a <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class\" target=\"_blank\">Kelvin Asset Class</a>. **Permission Required:** `kelvin.permission.asset_class.read`
|
|
183
|
+
* @param assetClassName <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class' target='_blank'>Kelvin Asset Class</a> name to retrieve.</p> This is the unique identifier name and not the display name (title) of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class' target='_blank'>Kelvin Asset Class</a>.</p> This must contain only lowercase alphanumeric characters. The `.`, `_` and `-` characters are also allowed to separate words instead of a space BUT can not be at the beginning or end of the name.
|
|
215
184
|
* @param {IKvHttpRequestOptions} options Request optional parameters
|
|
216
185
|
*/
|
|
217
186
|
static getAssetClass({ assetClassName }, options) {
|
|
@@ -224,7 +193,7 @@ export class AssetService extends BaseService {
|
|
|
224
193
|
}
|
|
225
194
|
/**
|
|
226
195
|
* Get Asset Hierarchies
|
|
227
|
-
* Get Asset Hierarchies **Permission Required:** `kelvin.permission.asset.read`
|
|
196
|
+
* Get Asset Hierarchies Retrieve a full list of all <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> stored on the <a href='https://docs.kelvininc.com/latest/kelvin-overview/overview/#kelvin-platform' target='_blank'>Kelvin Platform</a>. The list will contain all <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-groups' target='_blank'>Kelvin Asset Group</a> and <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset' target='_blank'>Kelvin Asset</a> information inclusive of their <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-hierarchy' target='_blank'>hierarchy</a>. There are no options to filter the list, so this list can get very big if there are large numbers of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> present on the <a href='https://docs.kelvininc.com/latest/kelvin-overview/overview/#kelvin-platform' target='_blank'>Kelvin Platform</a>. **Permission Required:** `kelvin.permission.asset.read`
|
|
228
197
|
* @param {IKvHttpRequestOptions} options Request optional parameters
|
|
229
198
|
*/
|
|
230
199
|
static getAssetHierarchies(options) {
|
|
@@ -237,12 +206,13 @@ export class AssetService extends BaseService {
|
|
|
237
206
|
}
|
|
238
207
|
/**
|
|
239
208
|
* Get Asset Hierarchy
|
|
240
|
-
* Get Asset Hierarchy **Permission Required:** `kelvin.permission.asset.read`
|
|
241
|
-
* @param assetName Asset name
|
|
242
|
-
* @param entityTypeDepth Sets the start entity type depth in which the hierarchy is returned.
|
|
209
|
+
* Get Asset Hierarchy Retrieve a full list of one <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> and it's <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-hierarchy' target='_blank'>hierarchy</a> stored on the <a href='https://docs.kelvininc.com/latest/kelvin-overview/overview/#kelvin-platform' target='_blank'>Kelvin Platform</a>. **Permission Required:** `kelvin.permission.asset.read`
|
|
210
|
+
* @param assetName Unique identifier name of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Asset</a> to retrieve the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-hierarchy' target='_blank'>hierarchy</a>.</p> This must contain only lowercase alphanumeric characters. The `.`, `_` and `-` characters are also allowed to separate words instead of a space BUT can not be at the beginning or end of the name.
|
|
211
|
+
* @param entityTypeDepth Sets the start entity type depth in which the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-hierarchy' target='_blank'>hierarchy</a> is returned.
|
|
212
|
+
* @param assetTypeDepth Sets the start asset type depth in which the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-hierarchy' target='_blank'>hierarchy</a> is returned. Only valid when entity_type_depth = group
|
|
243
213
|
* @param {IKvHttpRequestOptions} options Request optional parameters
|
|
244
214
|
*/
|
|
245
|
-
static getAssetHierarchy({ assetName, entityTypeDepth }, options) {
|
|
215
|
+
static getAssetHierarchy({ assetName, entityTypeDepth, assetTypeDepth }, options) {
|
|
246
216
|
const requestConfig = {
|
|
247
217
|
method: 'get'
|
|
248
218
|
};
|
|
@@ -250,6 +220,9 @@ export class AssetService extends BaseService {
|
|
|
250
220
|
if (entityTypeDepth != null) {
|
|
251
221
|
queryParameters['entity_type_depth'] = entityTypeDepth;
|
|
252
222
|
}
|
|
223
|
+
if (assetTypeDepth != null) {
|
|
224
|
+
queryParameters['asset_type_depth'] = assetTypeDepth;
|
|
225
|
+
}
|
|
253
226
|
requestConfig.params = queryParameters;
|
|
254
227
|
requestConfig.mediaType = 'application/json';
|
|
255
228
|
requestConfig.options = options;
|
|
@@ -259,7 +232,7 @@ export class AssetService extends BaseService {
|
|
|
259
232
|
* Get Asset OEE
|
|
260
233
|
* Get Asset OEE **Permission Required:** `kelvin.permission.asset.read`
|
|
261
234
|
* @param assetNames Asset OEE get schema
|
|
262
|
-
* @param timestamp Timestamp to search for specific OEE values for a given point in time (supports RFC3339 and Unix timestamps with nanosecond precision)
|
|
235
|
+
* @param timestamp Timestamp to search for specific <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> related <a href='https://docs.kelvininc.com/latest/documentation/kelvin-maps/kelvin-maps-asset-details/#performance-details' target='_blank'>OEE</a> values for a given point in time (supports RFC3339 and Unix timestamps with nanosecond precision).</p> If no timestamp is given in the query or body parameters, then the current time will be selected.
|
|
263
236
|
* @param {IKvHttpRequestOptions} options Request optional parameters
|
|
264
237
|
*/
|
|
265
238
|
static getAssetOEE({ assetNames, timestamp }, options) {
|
|
@@ -277,29 +250,45 @@ export class AssetService extends BaseService {
|
|
|
277
250
|
return this.request(`/assets/oee/get`, requestConfig, AssetOEE);
|
|
278
251
|
}
|
|
279
252
|
/**
|
|
280
|
-
* Get Asset
|
|
281
|
-
* Get Asset
|
|
282
|
-
* @param
|
|
283
|
-
* @param
|
|
253
|
+
* Get Asset Statistics
|
|
254
|
+
* Get Asset Statistics Returns a list of the requested <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> with details on the failure quotient, number of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> in the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-hierarchy' target='_blank'>hierarchy</a> (children) and the current OEE calculations. **Pagination Sortable Columns:** `asset.name`, `asset.asset_type_name`, `asset.device_type_name` **Permission Required:** `kelvin.permission.asset.read`
|
|
255
|
+
* @param asset Asset statistics schema
|
|
256
|
+
* @param pageSize Number of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Asset</a> Statistic objects to be returned. Page size can be between 1 and 1000 objects.</p> The default is 20 Kelvin Asset Statistic objects.
|
|
257
|
+
* @param startingAfter An alphanumeric string to move to the next page of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Asset</a> statistics in the list.</p> The alphanumeric string which are the bookmarks for the beginning and end of the current list is given in the previous JSON response value under the key pagination -> previous_page and pagination -> next_page respectively.</p> The pagination -> next_page alphanumeric string should be used here to show a list of the next page of results.
|
|
258
|
+
* @param endingBefore An alphanumeric string to move to the previous page of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Asset</a> statistics in the list.</p> The alphanumeric string which are the bookmarks for the beginning and end of the current list is given in the previous JSON response value under the key pagination -> previous_page and pagination -> next_page respectively.</p> The pagination -> previous_page alphanumeric string should be used here to show a list of the previous page of results.
|
|
259
|
+
* @param sortBy Sort the results by one of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Asset</a> parameters. Only one parameter can be selected.</p> There are three parameter options; `asset.name`, `asset.asset_type_name` and `asset.device_type_name`.</p> The default is `asset.name`
|
|
260
|
+
* @param sortAsc Sorting order for the results according to the `sort_by` parameter.</p> There are two options; `true` (ascending order) and `false` (descending order).</p> The default is `true` (ascending).
|
|
284
261
|
* @param {IKvHttpRequestOptions} options Request optional parameters
|
|
285
262
|
*/
|
|
286
|
-
static
|
|
263
|
+
static getAssetStatistics({ asset, pageSize, startingAfter, endingBefore, sortBy, sortAsc }, options) {
|
|
287
264
|
const requestConfig = {
|
|
288
265
|
method: 'post'
|
|
289
266
|
};
|
|
290
267
|
const queryParameters = {};
|
|
291
|
-
if (
|
|
292
|
-
queryParameters['
|
|
268
|
+
if (pageSize != null) {
|
|
269
|
+
queryParameters['page_size'] = pageSize;
|
|
270
|
+
}
|
|
271
|
+
if (startingAfter != null) {
|
|
272
|
+
queryParameters['starting_after'] = startingAfter;
|
|
273
|
+
}
|
|
274
|
+
if (endingBefore != null) {
|
|
275
|
+
queryParameters['ending_before'] = endingBefore;
|
|
276
|
+
}
|
|
277
|
+
if (sortBy != null) {
|
|
278
|
+
queryParameters['sort_by'] = sortBy;
|
|
279
|
+
}
|
|
280
|
+
if (sortAsc != null) {
|
|
281
|
+
queryParameters['sort_asc'] = sortAsc;
|
|
293
282
|
}
|
|
294
283
|
requestConfig.params = queryParameters;
|
|
295
|
-
requestConfig.data =
|
|
284
|
+
requestConfig.data = asset;
|
|
296
285
|
requestConfig.mediaType = 'application/json';
|
|
297
286
|
requestConfig.options = options;
|
|
298
|
-
return this.request(`/assets/
|
|
287
|
+
return this.request(`/assets/statistics/get`, requestConfig, AssetStatisticsPaginated);
|
|
299
288
|
}
|
|
300
289
|
/**
|
|
301
290
|
* Get Asset Status Count
|
|
302
|
-
* Get Asset Status Count **Permission Required:** `kelvin.permission.asset.read`
|
|
291
|
+
* Get Asset Status Count Summary total count of all <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> into four statuses. There are four status (state) values that can be returned; `online` where the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> and all assets below in the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-hierarchy' target='_blank'>hierarchy</a> (if applicable) are all online and receiving information, `offline` where the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> and all assets below in the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-hierarchy' target='_blank'>hierarchy</a> (if applicable) are all offline, `partially_online` where the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> and some assets below in the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-hierarchy' target='_blank'>hierarchy</a> (if applicable) are online and receiving information and `unknown` where the status (state) has never received any data to a <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</a> and/or is not declared on any <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</a> as a <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Asset</a> / <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics' target='_blank'>Kelvin Metric</a> pair. **Permission Required:** `kelvin.permission.asset.read`
|
|
303
292
|
* @param {IKvHttpRequestOptions} options Request optional parameters
|
|
304
293
|
*/
|
|
305
294
|
static getAssetStatusCount(options) {
|
|
@@ -312,7 +301,7 @@ export class AssetService extends BaseService {
|
|
|
312
301
|
}
|
|
313
302
|
/**
|
|
314
303
|
* Get Asset Statuses
|
|
315
|
-
* Get Asset Statuses **Permission Required:** `kelvin.permission.asset.read`
|
|
304
|
+
* Get Asset Statuses Returns a list of all <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> and the current status (state). There are four status (state) values that can be returned; `online` where the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> and all assets below in the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-hierarchy' target='_blank'>hierarchy</a> (if applicable) are all online and receiving information, `offline` where the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> and all assets below in the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-hierarchy' target='_blank'>hierarchy</a> (if applicable) are all offline, `partially_online` where the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> and some assets below in the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-hierarchy' target='_blank'>hierarchy</a> (if applicable) are online and receiving information and `unknown` where the status (state) has never received any data to a <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</a> and/or is not declared on any <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</a> as a <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Asset</a> / <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics' target='_blank'>Kelvin Metric</a> pair. **Permission Required:** `kelvin.permission.asset.read`
|
|
316
305
|
* @param {IKvHttpRequestOptions} options Request optional parameters
|
|
317
306
|
*/
|
|
318
307
|
static getAssetStatuses(options) {
|
|
@@ -325,8 +314,8 @@ export class AssetService extends BaseService {
|
|
|
325
314
|
}
|
|
326
315
|
/**
|
|
327
316
|
* Get Asset Template
|
|
328
|
-
* Get Asset Template **Permission Required:** `kelvin.permission.asset.read`
|
|
329
|
-
* @param assetTemplateName
|
|
317
|
+
* Get Asset Template Retrieves the properties of a <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#kelvin-templates\" target=\"_blank\">Kelvin Template</a>. **Permission Required:** `kelvin.permission.asset.read`
|
|
318
|
+
* @param assetTemplateName <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#kelvin-templates' target='_blank'>Kelvin Template</a> name to retrieve.</p> This is the unique identifier name and not the display name (title) of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#kelvin-templates' target='_blank'>Kelvin Template</a>.</p> This must contain only lowercase alphanumeric characters. The `.`, `_` and `-` characters are also allowed to separate words instead of a space BUT can not be at the beginning or end of the name.
|
|
330
319
|
* @param {IKvHttpRequestOptions} options Request optional parameters
|
|
331
320
|
*/
|
|
332
321
|
static getAssetTemplate({ assetTemplateName }, options) {
|
|
@@ -339,9 +328,9 @@ export class AssetService extends BaseService {
|
|
|
339
328
|
}
|
|
340
329
|
/**
|
|
341
330
|
* Get Asset Type
|
|
342
|
-
* Get Asset Type **Permission Required:** `kelvin.permission.asset_type.read`
|
|
343
|
-
* @param assetTypeName Asset Type name
|
|
344
|
-
* @param metadata
|
|
331
|
+
* Get Asset Type Retrieves the properties of a <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type\" target=\"_blank\">Kelvin Asset Type</a>. **Permission Required:** `kelvin.permission.asset_type.read`
|
|
332
|
+
* @param assetTypeName <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type' target='_blank'>Kelvin Asset Type</a> name to retrieve.</p> This is the unique identifier name and not the display name (title) of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type' target='_blank'>Kelvin Asset Type</a>.</p> This must contain only lowercase alphanumeric characters. The `.`, `_` and `-` characters are also allowed to separate words instead of a space BUT can not be at the beginning or end of the name.
|
|
333
|
+
* @param metadata Array of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets#asset-type-metadata' target='_blank'>Kelvin Asset Type Metadata</a> names. If the metadata name exists for the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type' target='_blank'>Kelvin Asset Type</a>, then the payload for the metadata name will be attached in the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type' target='_blank'>Kelvin Asset Type</a> response object.</p> <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets#asset-type-metadata' target='_blank'>Kelvin Asset Type Metadata</a> objects are created using the API endpoint `/assets/types/{asset_type_name}/metadata/` and is linked to a <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type' target='_blank'>Kelvin Asset Type</a>. The same name can be used for different <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type' target='_blank'>Kelvin Asset Type</a> for easy filtering across multiple <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type' target='_blank'>Kelvin Asset Type</a>.
|
|
345
334
|
* @param {IKvHttpRequestOptions} options Request optional parameters
|
|
346
335
|
*/
|
|
347
336
|
static getAssetType({ assetTypeName, metadata }, options) {
|
|
@@ -359,9 +348,9 @@ export class AssetService extends BaseService {
|
|
|
359
348
|
}
|
|
360
349
|
/**
|
|
361
350
|
* Get Asset Type Metadata
|
|
362
|
-
* Get Asset Type Metadata **Permission Required:** `kelvin.permission.asset_type.read`
|
|
363
|
-
* @param assetTypeName Asset Type name
|
|
364
|
-
* @param assetTypeMetadataName Asset Type Metadata name
|
|
351
|
+
* Get Asset Type Metadata Retrieves the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets#asset-type-metadata' target='_blank'>Kelvin Asset Type Metadata</a> object associated with a <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type\" target=\"_blank\">Kelvin Asset Type</a>. This will only retrieve the specific <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets#asset-type-metadata' target='_blank'>Kelvin Asset Type Metadata</a> object linked to the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type' target='_blank'>Kelvin Asset Type</a>. If there is a <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets#asset-type-metadata' target='_blank'>Kelvin Asset Type Metadata</a> object with the same name and payload BUT associated with a different <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type' target='_blank'>Kelvin Asset Type</a>, this will not be retrieved. **Permission Required:** `kelvin.permission.asset_type.read`
|
|
352
|
+
* @param assetTypeName <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type' target='_blank'>Kelvin Asset Type</a> name to retrieve.</p> This is the unique identifier name and not the display name (title) of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type' target='_blank'>Kelvin Asset Type</a>.</p> This must contain only lowercase alphanumeric characters. The `.`, `_` and `-` characters are also allowed to separate words instead of a space BUT can not be at the beginning or end of the name.
|
|
353
|
+
* @param assetTypeMetadataName <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets#asset-type-metadata' target='_blank'>Kelvin Asset Type Metadata</a> unique identifier name to retrieve.</p> This must contain only lowercase alphanumeric characters. The `.`, `_` and `-` characters are also allowed to separate words instead of a space BUT can not be at the beginning or end of the name.
|
|
365
354
|
* @param {IKvHttpRequestOptions} options Request optional parameters
|
|
366
355
|
*/
|
|
367
356
|
static getAssetTypeMetadata({ assetTypeName, assetTypeMetadataName }, options) {
|
|
@@ -374,19 +363,23 @@ export class AssetService extends BaseService {
|
|
|
374
363
|
}
|
|
375
364
|
/**
|
|
376
365
|
* List Asset
|
|
377
|
-
* List Asset **Pagination Sortable Columns:** `asset.name`, `asset.title`, `asset.created`, `asset.updated`, `asset_type.name`, `asset_type.title`, `status_state`, `status_last_seen` **Permission Required:** `kelvin.permission.asset.read`
|
|
378
|
-
* @param search Search assets
|
|
379
|
-
* @param
|
|
380
|
-
* @param
|
|
381
|
-
* @param
|
|
382
|
-
* @param
|
|
383
|
-
* @param
|
|
384
|
-
* @param
|
|
385
|
-
* @param
|
|
386
|
-
* @param
|
|
387
|
-
* @param
|
|
388
|
-
|
|
389
|
-
|
|
366
|
+
* List Asset Returns a dictionary with a data property containing a filtered array of all <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target=\"_blank\">Kelvin Assets</a> objects on the <a href='https://docs.kelvininc.com/latest/kelvin-overview/overview/#kelvin-platform' target='_blank'>Kelvin Platform</a>. <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target=\"_blank\">Kelvin Assets</a> are categorized by entity types and, unless specified, all entity types are included in the filter. There are five entity types; `group`, `asset`, `component`, `part` and `sensor`. Detailed information about these entity types and how they are used can be found at <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target=\"_blank\">https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/</a>. **Pagination Sortable Columns:** `asset.name`, `asset.title`, `asset.created`, `asset.updated`, `asset_type.name`, `asset_type.title`, `status_state`, `status_last_seen` **Permission Required:** `kelvin.permission.asset.read`
|
|
367
|
+
* @param search Search and filter the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Asset</a> list. Both the Display Name and the Name will be included in the search field criteria. This is given as an array, for example `[pump,fan]`.</p> The search is case insensitive and will find partial matches as well. For example if a <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset' target='_blank'>Kelvin Asset</a> name or display name is `centrifugal_pump`, then a match will be made if the search string is `pum` or `FUGaL`.
|
|
368
|
+
* @param names Filter on the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Asset</a> parameter `name`. This is given as an array, for example `[pump,fan]`.</p> The filter is done on the full name only according to unique identifier name rules (Must contain only lowercase alphanumeric characters. The `.`, `_` and `-` characters are also allowed to separate words instead of a space but not at the beginning or end).</p> For example a search with `[pump,fan]` will return <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Asset</a> with the name `pump` but not with the names `pumps` or `centrifugal-fan`.
|
|
369
|
+
* @param assetTypeName Filter on the parameter <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type' target='_blank'>Kelvin Asset Type</a> by its name. This is given as an array, for example `[pump,fan]`.</p> The filter is done on the full name only according to unique identifier name rules (Must contain only lowercase alphanumeric characters. The `.`, `_` and `-` characters are also allowed to separate words instead of a space but not at the beginning or end).</p> For example a filter with `[pump,fan]` will return <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type' target='_blank'>Kelvin Asset Type</a> with the name `pump` but not with the names `pumps` or `centrifugal-fan`.
|
|
370
|
+
* @param statusState Filter <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Asset</a> by its current status. Multiple parameters can be given in an array, for example `[online,partially_online]` and will be filtered as `OR`.</p> There are four parameter options; `online`, `offline`, `partially_online` and `unknown`.
|
|
371
|
+
* @param entityTypeName Filter and return the results of one or more of the entity type names. This is given as an array, for example `[group,asset]`. Prefix any entity type name with the character `!` for a NOT operation.</p> There are five entity type names available to choose from; `group`, `asset`, `component`, `part`, `sensor`.</p> The default will select all available entity type name options.</p>
|
|
372
|
+
* @param map Filter for assets that belong to the map
|
|
373
|
+
* @param propertiesFilter Filter <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> that contain a property with a specified value. The property must be declared using its `name`` and not its `title` (Display Name). Multiple properties or multiple values can be filtered within this array. For example `[demo_property=demo_value]` or `[demo_property_1=demo_value,demo_property_2=88]`.</p> All values to be filtered must be an exact match and is case sensitive. Also there must be no spaces before or after the equal sign.</p> For example; `[demo_property=88]` is accepted but `[demo_property = 88]` will cause a 400 error.
|
|
374
|
+
* @param properties Only returns specified properties in each <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a>.</p> This does not filter the array of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> returned, only filters the properties in each <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a>. If the property does not exist in a <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a>, then the properties parameter is returned with no contents. If this is the only parameter used, then all <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a>on the <a href='https://docs.kelvininc.com/latest/kelvin-overview/overview/#kelvin-platform' target='_blank'>Kelvin Platform</a> will be returned.</p> The default is to return all properties for each <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a>.
|
|
375
|
+
* @param pageSize Number of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Asset</a> objects to be returned. Page size can be between 1 and 1000 objects.</p> The default is 20 <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset' target='_blank'>Kelvin Asset</a> objects.
|
|
376
|
+
* @param startingAfter An alphanumeric string to move to the next page of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> in the list.</p> The alphanumeric string which are the bookmarks for the beginning and end of the current list is given in the previous JSON response value under the key pagination -> previous_page and pagination -> next_page respectively.</p> The pagination -> next_page alphanumeric string should be used here to show a list of the next page of results.
|
|
377
|
+
* @param endingBefore An alphanumeric string to move to the previous page of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> in the list.</p> The alphanumeric string which are the bookmarks for the beginning and end of the current list is given in the previous JSON response value under the key pagination -> previous_page and pagination -> next_page respectively.</p> The pagination -> previous_page alphanumeric string should be used here to show a list of the previous page of results.
|
|
378
|
+
* @param sortBy Sort the results by one of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> parameters. Only one parameter can be selected.</p> There are eight parameter options; `asset.name`, `asset.title`, `asset.created`, `asset.updated`, `asset_type.name`, `asset_type.title`, `status_state` and `status_last_seen`.</p> The default is `asset.name`
|
|
379
|
+
* @param sortAsc Sorting order for the results according to the `sort_by` parameter.</p> There are two options; `true` (ascending order) and `false` (descending order).</p> The default is `true` (ascending).
|
|
380
|
+
* @param {IKvHttpRequestOptions} options Request optional parameters
|
|
381
|
+
*/
|
|
382
|
+
static listAsset({ search, names, assetTypeName, statusState, entityTypeName, map, propertiesFilter, properties, pageSize, startingAfter, endingBefore, sortBy, sortAsc } = {}, options) {
|
|
390
383
|
const requestConfig = {
|
|
391
384
|
method: 'get'
|
|
392
385
|
};
|
|
@@ -394,6 +387,9 @@ export class AssetService extends BaseService {
|
|
|
394
387
|
if (search != null) {
|
|
395
388
|
queryParameters['search'] = search;
|
|
396
389
|
}
|
|
390
|
+
if (names != null) {
|
|
391
|
+
queryParameters['names'] = names;
|
|
392
|
+
}
|
|
397
393
|
if (assetTypeName != null) {
|
|
398
394
|
queryParameters['asset_type_name'] = assetTypeName;
|
|
399
395
|
}
|
|
@@ -403,6 +399,15 @@ export class AssetService extends BaseService {
|
|
|
403
399
|
if (entityTypeName != null) {
|
|
404
400
|
queryParameters['entity_type_name'] = entityTypeName;
|
|
405
401
|
}
|
|
402
|
+
if (map != null) {
|
|
403
|
+
queryParameters['map'] = map;
|
|
404
|
+
}
|
|
405
|
+
if (propertiesFilter != null) {
|
|
406
|
+
queryParameters['properties_filter'] = propertiesFilter;
|
|
407
|
+
}
|
|
408
|
+
if (properties != null) {
|
|
409
|
+
queryParameters['properties'] = properties;
|
|
410
|
+
}
|
|
406
411
|
if (pageSize != null) {
|
|
407
412
|
queryParameters['page_size'] = pageSize;
|
|
408
413
|
}
|
|
@@ -425,15 +430,15 @@ export class AssetService extends BaseService {
|
|
|
425
430
|
}
|
|
426
431
|
/**
|
|
427
432
|
* List Asset Class
|
|
428
|
-
* List Asset Class **Pagination Sortable Columns:** `asset_class.name`, `asset_class.title`, `asset_class.created`, `asset_class.updated`, `asset_class.owner`, `asset_class.device_type_name` **Permission Required:** `kelvin.permission.asset_class.read`
|
|
429
|
-
* @param search Search Asset Class
|
|
430
|
-
* @param pageSize Number of objects to be returned
|
|
431
|
-
* @param startingAfter
|
|
432
|
-
* @param endingBefore
|
|
433
|
-
* @param sortBy
|
|
434
|
-
* @param sortAsc
|
|
435
|
-
* @param owner Filter Asset Class by owner
|
|
436
|
-
* @param entityTypeName Filter
|
|
433
|
+
* List Asset Class Returns a filtered dictionary with a data object containing an array of <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class\" target=\"_blank\">Kelvin Asset Classes</a> objects on the Kelvin Platform that meet the criteria of any parameters passed with the API request. If no query parameters are given with the API request, then the defaults will be used to return the <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class\" target=\"_blank\">Kelvin Asset Class</a> list. The defaults are the first 20 <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class\" target=\"_blank\">Kelvin Asset Classe</a> objects returned in alphabetical order by the unique identifier name. **Pagination Sortable Columns:** `asset_class.name`, `asset_class.title`, `asset_class.created`, `asset_class.updated`, `asset_class.owner`, `asset_class.device_type_name` **Permission Required:** `kelvin.permission.asset_class.read`
|
|
434
|
+
* @param search Search and filter the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class' target='_blank'>Kelvin Asset Class</a> list. Both the Display Name and the Name will be included in the search field criteria. This is given as an array, for example `[pump,fan]`.</p> The search is case insensitive and will find partial matches as well. For example if a <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class' target='_blank'>Kelvin Asset Class</a> name is `centrifugal_pump`, then a match will be made if the search string is `pum` or `FUGaL`.
|
|
435
|
+
* @param pageSize Number of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class' target='_blank'>Kelvin Asset Class</a> objects to be returned. Page size can be between 1 and 1000 objects.</p> The default is 20 <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class' target='_blank'>Kelvin Asset Class</a> objects.
|
|
436
|
+
* @param startingAfter An alphanumeric string to move to the next page of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class' target='_blank'>Kelvin Asset Classes</a> in the list.</p> The alphanumeric string which are the bookmarks for the beginning and end of the current list is given in the previous JSON response parameter under pagination -> previous_page and pagination -> next_page respectively.</p> The pagination -> next_page alphanumeric string should be used here to show a list of the next page of results.
|
|
437
|
+
* @param endingBefore An alphanumeric string to move to the previous page of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class' target='_blank'>Kelvin Asset Classes</a> in the list.</p> The alphanumeric string which are the bookmarks for the beginning and end of the current list is given in the previous JSON response parameter under pagination -> previous_page and pagination -> next_page respectively.</p> The pagination -> previous_page alphanumeric string should be used here to show a list of the previous page of results.
|
|
438
|
+
* @param sortBy Sort the results by one of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class' target='_blank'>Kelvin Asset Class</a> parameters. Only one parameter can be selected.</p> There are six parameter options; `asset_class.name`, `asset_class.title`, `asset_class.created`, `asset_class.updated`, `asset_class.owner` and `asset_class.device_type_name`.</p> The default is `asset_class.name`
|
|
439
|
+
* @param sortAsc Sorting order for the results according to the `sort_by` parameter.</p> There are two options; `true` (ascending order) and `false` (descending order).</p> The default is `true` (ascending).
|
|
440
|
+
* @param owner Filter <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class' target='_blank'>Kelvin Asset Class</a> by owner.</p> There are two types of owners; `custom` (any user) or `kelvin` (core <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class' target='_blank'>Kelvin Asset Class</a>).</p> The default will select all owner options.
|
|
441
|
+
* @param entityTypeName Filter and return the results of one or more of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets#entity-type' target='_blank'>Entity Type</a> names. This is given as an array, for example `[group,asset]`. Prefix any entity type name with the character `!` for a NOT operation.</p> There are five <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets#entity-type' target='_blank'>Entity Type</a> names available to choose from; `group`, `asset`, `component`, `part`, `sensor`.</p> The default will select all available <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets#entity-type' target='_blank'>Entity Type</a> name options.</p>
|
|
437
442
|
* @param {IKvHttpRequestOptions} options Request optional parameters
|
|
438
443
|
*/
|
|
439
444
|
static listAssetClass({ search, pageSize, startingAfter, endingBefore, sortBy, sortAsc, owner, entityTypeName } = {}, options) {
|
|
@@ -470,19 +475,57 @@ export class AssetService extends BaseService {
|
|
|
470
475
|
requestConfig.options = options;
|
|
471
476
|
return this.request(`/assets/class/list`, requestConfig, AssetClassListPaginated);
|
|
472
477
|
}
|
|
478
|
+
/**
|
|
479
|
+
* List Asset Data Streams
|
|
480
|
+
* List Asset Data Streams Returns an array of dictionary objects with all the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Asset</a> / <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics' target='_blank'>Kelvin Metric</a> pairs for the requested <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Asset</a>. If the optional `include_asset_children` in the request body is true, then the returned dictionary will also filter for all children <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Asset</a> in the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-hierarchy' target='_blank'>hierarchy</a> below the `asset_name`. **Pagination Sortable Columns:** `datastream.asset_name`, `datastream.metric_name` **Permission Required:** `kelvin.permission.asset.read`
|
|
481
|
+
* @param assetName Unique identifier name of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Asset</a>.</p> This must contain only lowercase alphanumeric characters. The `.`, `_` and `-` characters are also allowed to separate words instead of a space BUT can not be at the beginning or end of the name.
|
|
482
|
+
* @param assetDatastreams Asset Data Streams list schema
|
|
483
|
+
* @param pageSize Number of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Asset</a> / <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics' target='_blank'>Kelvin Metric</a> pair objects to be returned. Page size can be between 1 and 1000 objects.</p> The default is 20 Kelvin Asset/Kelvin Metric pair objects.
|
|
484
|
+
* @param startingAfter An alphanumeric string to move to the next page of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Asset</a> / <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics' target='_blank'>Kelvin Metric</a> pair objects in the list.</p> The alphanumeric string which are the bookmarks for the beginning and end of the current list is given in the previous JSON response value under the key pagination -> previous_page and pagination -> next_page respectively.</p> The pagination -> next_page alphanumeric string should be used here to show a list of the next page of results.
|
|
485
|
+
* @param endingBefore An alphanumeric string to move to the previous page of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Asset</a> / <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics' target='_blank'>Kelvin Metric</a> pair objects in the list.</p> The alphanumeric string which are the bookmarks for the beginning and end of the current list is given in the previous JSON response value under the key pagination -> previous_page and pagination -> next_page respectively.</p> The pagination -> previous_page alphanumeric string should be used here to show a list of the previous page of results.
|
|
486
|
+
* @param sortBy Sort the results by one of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Asset</a> / <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics' target='_blank'>Kelvin Metric</a> pair objects. Only one parameter can be selected.</p> There are two parameter options; `datastream.asset_name` and `datastream.metric_name`.</p> The default is `datastream.asset_name`
|
|
487
|
+
* @param sortAsc Sorting order for the results according to the `sort_by` parameter.</p> There are two options; `true` (ascending order) and `false` (descending order).</p> The default is `true` (ascending).
|
|
488
|
+
* @param {IKvHttpRequestOptions} options Request optional parameters
|
|
489
|
+
*/
|
|
490
|
+
static listAssetDataStreams({ assetName, assetDatastreams, pageSize, startingAfter, endingBefore, sortBy, sortAsc }, options) {
|
|
491
|
+
const requestConfig = {
|
|
492
|
+
method: 'post'
|
|
493
|
+
};
|
|
494
|
+
const queryParameters = {};
|
|
495
|
+
if (pageSize != null) {
|
|
496
|
+
queryParameters['page_size'] = pageSize;
|
|
497
|
+
}
|
|
498
|
+
if (startingAfter != null) {
|
|
499
|
+
queryParameters['starting_after'] = startingAfter;
|
|
500
|
+
}
|
|
501
|
+
if (endingBefore != null) {
|
|
502
|
+
queryParameters['ending_before'] = endingBefore;
|
|
503
|
+
}
|
|
504
|
+
if (sortBy != null) {
|
|
505
|
+
queryParameters['sort_by'] = sortBy;
|
|
506
|
+
}
|
|
507
|
+
if (sortAsc != null) {
|
|
508
|
+
queryParameters['sort_asc'] = sortAsc;
|
|
509
|
+
}
|
|
510
|
+
requestConfig.params = queryParameters;
|
|
511
|
+
requestConfig.data = assetDatastreams;
|
|
512
|
+
requestConfig.mediaType = 'application/json';
|
|
513
|
+
requestConfig.options = options;
|
|
514
|
+
return this.request(`/assets/${encodeURIComponent(String(assetName))}/datastreams/list`, requestConfig, AssetDataStreamsListPaginated);
|
|
515
|
+
}
|
|
473
516
|
/**
|
|
474
517
|
* List Asset Template
|
|
475
|
-
* List Asset Template **Pagination Sortable Columns:** `asset_template.name`, `asset_template.title`, `asset_template.created`, `asset_template.updated`, `asset_template.asset_type_name`, `asset_template.device_type_name` **Permission Required:** `kelvin.permission.asset.read`
|
|
476
|
-
* @param search Search Asset
|
|
477
|
-
* @param pageSize Number of objects to be returned
|
|
478
|
-
* @param startingAfter
|
|
479
|
-
* @param endingBefore
|
|
480
|
-
* @param sortBy
|
|
481
|
-
* @param sortAsc
|
|
482
|
-
* @param assetTypeNames Asset Type
|
|
483
|
-
* @param entityTypeNames
|
|
484
|
-
* @param assetClassNames Asset Class
|
|
485
|
-
* @param owner
|
|
518
|
+
* List Asset Template Returns a dictionary with a data property containing a filtered array of all <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#kelvin-templates\" target=\"_blank\">Kelvin Templates</a> objects on the <a href='https://docs.kelvininc.com/latest/kelvin-overview/overview/#kelvin-platform' target='_blank'>Kelvin Platform</a>. **Pagination Sortable Columns:** `asset_template.name`, `asset_template.title`, `asset_template.created`, `asset_template.updated`, `asset_template.asset_type_name`, `asset_template.device_type_name` **Permission Required:** `kelvin.permission.asset.read`
|
|
519
|
+
* @param search Search and filter the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#kelvin-templates' target='_blank'>Kelvin Templates</a> list. Both the Display Name and the Name will be included in the search field criteria. This is given as an array, for example `[pump,fan]`.</p> The search is case insensitive and will find partial matches as well. For example if a Kelvin Asset Type name is `centrifugal_pump`, then a match will be made if the search string is `pum` or `FUGaL`.
|
|
520
|
+
* @param pageSize Number of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#kelvin-templates' target='_blank'>Kelvin Template</a> objects to be returned. Page size can be between 1 and 1000 objects.</p> The default is 20 Kelvin Template objects.
|
|
521
|
+
* @param startingAfter An alphanumeric string to move to the next page of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#kelvin-templates' target='_blank'>Kelvin Templates</a> in the list.</p> The alphanumeric string which are the bookmarks for the beginning and end of the current list is given in the previous JSON response value under the key pagination -> previous_page and pagination -> next_page respectively.</p> The pagination -> next_page alphanumeric string should be used here to show a list of the next page of results.
|
|
522
|
+
* @param endingBefore An alphanumeric string to move to the previous page of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#kelvin-templates' target='_blank'>Kelvin Templates</a> in the list.</p> The alphanumeric string which are the bookmarks for the beginning and end of the current list is given in the previous JSON response value under the key pagination -> previous_page and pagination -> next_page respectively.</p> The pagination -> previous_page alphanumeric string should be used here to show a list of the previous page of results.
|
|
523
|
+
* @param sortBy Sort the results by one of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#kelvin-templates' target='_blank'>Kelvin Template</a> parameters. Only one parameter can be selected.</p> There are six parameter options; `asset_template.name`, `asset_template.title`, `asset_template.created`, `asset_template.updated`, `asset_template.asset_type_name` and `asset_template.device_type_name`.</p> The default is `asset_template.name`
|
|
524
|
+
* @param sortAsc Sorting order for the results according to the `sort_by` parameter.</p> There are two options; `true` (ascending order) and `false` (descending order).</p> The default is `true` (ascending).
|
|
525
|
+
* @param assetTypeNames Filter on the parameter <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type' target='_blank'>Kelvin Asset Type</a> by its name. This is given as an array, for example `[pump,fan]`.</p> The search is done on the full name only according to unique identifier name rules (Must contain only lowercase alphanumeric characters. The `.`, `_` and `-` characters are also allowed to separate words instead of a space but not at the beginning or end). For example a search with `[pump,fan]` will return <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class' target='_blank'>Kelvin Asset Class</a> with the name `pump` but not with the names `pumps` or `centrifugal-fan`.
|
|
526
|
+
* @param entityTypeNames Filter and return the results of one or more of the entity type names. This is given as an array, for example `[group,asset]`. Prefix any entity type name with the character `!` for a NOT operation.</p> There are five entity type names available to choose from; `group`, `asset`, `component`, `part`, `sensor`.</p> The default will select all available entity type name options.</p>
|
|
527
|
+
* @param assetClassNames Filter on the parameter <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class' target='_blank'>Kelvin Asset Class</a> by its name. This is given as an array, for example `[pump,fan]`.</p> The search is done on the full name only according to unique identifier name rules (Must contain only lowercase alphanumeric characters. The `.`, `_` and `-` characters are also allowed to separate words instead of a space but not at the beginning or end). For example a search with `[pump,fan]` will return <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class' target='_blank'>Kelvin Asset Class</a> with the name `pump` but not with the names `pumps` or `centrifugal-fan`.
|
|
528
|
+
* @param owner Filter <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#kelvin-templates' target='_blank'>Kelvin Templates</a> by owner.</p> There are two types of owners; `custom` (any user) or `kelvin` (core kelvin).
|
|
486
529
|
* @param {IKvHttpRequestOptions} options Request optional parameters
|
|
487
530
|
*/
|
|
488
531
|
static listAssetTemplate({ search, pageSize, startingAfter, endingBefore, sortBy, sortAsc, assetTypeNames, entityTypeNames, assetClassNames, owner } = {}, options) {
|
|
@@ -527,18 +570,18 @@ export class AssetService extends BaseService {
|
|
|
527
570
|
}
|
|
528
571
|
/**
|
|
529
572
|
* List Asset Type
|
|
530
|
-
* List Asset Type **Pagination Sortable Columns:** `asset_type.name`, `asset_type.title`, `asset_type.created`, `asset_type.updated`, `asset_type.owner`, `asset_class.name`, `asset_class.title`, `asset_class.device_type_name` **Permission Required:** `kelvin.permission.asset_type.read`
|
|
531
|
-
* @param search Search asset
|
|
532
|
-
* @param assetClassName Filter asset
|
|
533
|
-
* @param metadata
|
|
534
|
-
* @param metadataFilter
|
|
535
|
-
* @param pageSize Number of objects to be returned
|
|
536
|
-
* @param startingAfter
|
|
537
|
-
* @param endingBefore
|
|
538
|
-
* @param sortBy
|
|
539
|
-
* @param sortAsc
|
|
540
|
-
* @param owner Filter Asset
|
|
541
|
-
* @param entityTypeName Filter
|
|
573
|
+
* List Asset Type Returns a filtered dictionary with a data object containing an array of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type' target='_blank'>Kelvin Asset Type</a> objects on the Kelvin Platform that meet the criteria of any parameters passed with the API request. If no query parameters are given with the API request, then the defaults will be used to return the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type' target='_blank'>Kelvin Asset Type</a> list. The defaults are the first 20 <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type' target='_blank'>Kelvin Asset Type</a> objects returned in alphabetical order by the unique identifier name. **Pagination Sortable Columns:** `asset_class.name`, `asset_class.title`, `asset_class.created`, `asset_class.updated`, `asset_class.owner`, `asset_class.device_type_name` **Pagination Sortable Columns:** `asset_type.name`, `asset_type.title`, `asset_type.created`, `asset_type.updated`, `asset_type.owner`, `asset_class.name`, `asset_class.title`, `asset_class.device_type_name` **Permission Required:** `kelvin.permission.asset_type.read`
|
|
574
|
+
* @param search Search and filter the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type' target='_blank'>Kelvin Asset Type</a> list. Both the Display Name and the Name will be included in the search field criteria. This is given as an array, for example `[pump,fan]`.</p> The search is case insensitive and will find partial matches as well. For example if a Kelvin Asset Type name is `centrifugal_pump`, then a match will be made if the search string is `pum` or `FUGaL`.
|
|
575
|
+
* @param assetClassName Filter on the parameter <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class' target='_blank'>Kelvin Asset Class</a> by its name. This is given as an array, for example `[pump,fan]`.</p> The search is done on the full name only according to unique identifier name rules (Must contain only lowercase alphanumeric characters. The `.`, `_` and `-` characters are also allowed to separate words instead of a space but not at the beginning or end). For example a search with `[pump,fan]` will return <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class' target='_blank'>Kelvin Asset Class</a> with the name `pump` but not with the names `pumps` or `centrifugal-fan`.
|
|
576
|
+
* @param metadata Array of Kelvin Asset Type Metadata names. Kelvin Asset Type Metadata payload(s) will be attached to any <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type' target='_blank'>Kelvin Asset Types</a> that are linked to any of the Kelvin Asset Type Metadata name(s) in this list.
|
|
577
|
+
* @param metadataFilter Array of Kelvin Asset Type Metadata filter options to perform on the Kelvin Asset Type Metadata payload.</p> Each filter takes the format `<metadata_name>.<payload_key>=<wanted_filtered_value>`. An example of two filters is `[metadata-test1.key1=String1,metadata-test2.key2=88]`.</p> Any JSON keys with string values are case sensitive.</p> Multiple JSON key filters in the array from the same Kelvin Asset Type Metadata object will be filtered as `OR`. For example; if Kelvin Asset Type Metadata name `metadata-test` has two key parameters `'key1': 'String1'` and `'key2': 25`, then a metadata_filter `[metadata-test.key1=String1,metadata-test.key2=88]` will return results as one of the two values match in the same Kelvin Asset Type Metadata object.</p> Multiple JSON key filters in the array from different Kelvin Asset Type Metadata objects will be filtered as `AND`. For example; if Kelvin Asset Type Metadata name `metadata-test1` has a key/value pair `'key1': 'String1'` and Kelvin Asset Type Metadata name `metadata-test2` has a key/value pair`'key2': 25`, then a metadata_filter `[metadata-test1.key1=String1,metadata-test2.key2=88]` will <strong>NOT</strong> return results as one of the two key/value pairs from different Kelvin Asset Type Metadata objects does not match.
|
|
578
|
+
* @param pageSize Number of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type' target='_blank'>Kelvin Asset Type</a> objects to be returned. Page size can be between 1 and 1000 objects.</p> The default is 20 Kelvin Asset Type objects.
|
|
579
|
+
* @param startingAfter An alphanumeric string to move to the next page of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type' target='_blank'>Kelvin Asset Types</a> in the list.</p> The alphanumeric string which are the bookmarks for the beginning and end of the current list is given in the previous JSON response value under the key pagination -> previous_page and pagination -> next_page respectively.</p> The pagination -> next_page alphanumeric string should be used here to show a list of the next page of results.
|
|
580
|
+
* @param endingBefore An alphanumeric string to move to the previous page of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type' target='_blank'>Kelvin Asset Types</a> in the list.</p> The alphanumeric string which are the bookmarks for the beginning and end of the current list is given in the previous JSON response value under the key pagination -> previous_page and pagination -> next_page respectively.</p> The pagination -> previous_page alphanumeric string should be used here to show a list of the previous page of results.
|
|
581
|
+
* @param sortBy Sort the results by one of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type' target='_blank'>Kelvin Asset Types</a> parameters. Only one parameter can be selected.</p> There are eight parameter options; `asset_type.name`, `asset_type.title`, `asset_type.created`, `asset_type.updated`, `asset_class.name`, `asset_class.title`, `asset_type.owner` and `asset_class.device_type_name`.</p> The default is `asset_type.name`
|
|
582
|
+
* @param sortAsc Sorting order for the results according to the `sort_by` parameter.</p> There are two options; `true` (ascending order) and `false` (descending order).</p> The default is `true` (ascending).
|
|
583
|
+
* @param owner Filter <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type' target='_blank'>Kelvin Asset Type</a> by owner.</p> There are two types of owners; `custom` (any user) or `kelvin` (core kelvin asset type).</p> The default will select all owner options.
|
|
584
|
+
* @param entityTypeName Filter and return the results of one or more of the entity type names. This is given as an array, for example `[group,asset]`. Prefix any entity type name with the character `!` for a NOT operation.</p> There are five entity type names available to choose from; `group`, `asset`, `component`, `part`, `sensor`.</p> The default will select all available entity type name options.</p>
|
|
542
585
|
* @param {IKvHttpRequestOptions} options Request optional parameters
|
|
543
586
|
*/
|
|
544
587
|
static listAssetType({ search, assetClassName, metadata, metadataFilter, pageSize, startingAfter, endingBefore, sortBy, sortAsc, owner, entityTypeName } = {}, options) {
|
|
@@ -586,14 +629,14 @@ export class AssetService extends BaseService {
|
|
|
586
629
|
}
|
|
587
630
|
/**
|
|
588
631
|
* List Asset Type Metadata
|
|
589
|
-
* List Asset Type Metadata **Pagination Sortable Columns:** `asset_type_metadata.name` **Permission Required:** `kelvin.permission.asset_type.read`
|
|
590
|
-
* @param assetTypeName Asset Type name
|
|
591
|
-
* @param search Search Asset Type Metadata
|
|
592
|
-
* @param pageSize Number of objects to be returned
|
|
593
|
-
* @param startingAfter
|
|
594
|
-
* @param endingBefore
|
|
595
|
-
* @param sortBy
|
|
596
|
-
* @param sortAsc
|
|
632
|
+
* List Asset Type Metadata Returns a filtered list of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets#asset-type-metadata' target='_blank'>Kelvin Asset Type Metadata</a> objects linked with a <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type\" target=\"_blank\">Kelvin Asset Type</a>. The path parameter is required but the query parameters are optional. If no query parameters are given with the API request, then the defaults will be used to return the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets#asset-type-metadata' target='_blank'>Kelvin Asset Type Metadata</a> list. The defaults are the first 20 <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets#asset-type-metadata' target='_blank'>Kelvin Asset Type Metadata</a> linked to the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type' target='_blank'>Kelvin Asset Type</a> returned in alphabetical order by the unique identifier name. **Pagination Sortable Columns:** `asset_type_metadata.name` **Permission Required:** `kelvin.permission.asset_type.read`
|
|
633
|
+
* @param assetTypeName <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type' target='_blank'>Kelvin Asset Type</a> name where the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets#asset-type-metadata' target='_blank'>Kelvin Asset Type Metadata</a> payloads are stored.</p> The search is done on the full name only according to unique identifier name rules (Must contain only lowercase alphanumeric characters. The `.`, `_` and `-` characters are also allowed to separate words instead of a space.). For example a search with the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type' target='_blank'>Kelvin Asset Type</a> name `big-pump` will return all <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets#asset-type-metadata' target='_blank'>Kelvin Asset Type Metadata</a> associated with the name `big-pump` but not with the names `pump` or `big-pump-machine`.
|
|
634
|
+
* @param search Search and filter the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets#asset-type-metadata' target='_blank'>Kelvin Asset Type Metadata</a> objects list. Only the Name will be included in the search field criteria. This is given as an array, for example `[pump,fan]`.</p> The search is case insensitive and will find partial matches as well. For example if a Kelvin Asset Type name is centrifugal_pump, then a match will be made if the search string is `pum` or `FUGaL`.
|
|
635
|
+
* @param pageSize Number of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets#asset-type-metadata' target='_blank'>Kelvin Asset Type Metadata</a> objects to be returned. Page size can be between 1 and 1000 objects. The default is 20 <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets#asset-type-metadata' target='_blank'>Kelvin Asset Type Metadata</a> objects.
|
|
636
|
+
* @param startingAfter An alphanumeric string to move to the next page of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets#asset-type-metadata' target='_blank'>Kelvin Asset Type Metadata</a> objects in the list.</p> The alphanumeric string which are the bookmarks for the beginning and end of the current list is given in the previous JSON response value under the key pagination -> previous_page and pagination -> next_page respectively.</p> The pagination -> next_page alphanumeric string should be used here to show a list of the next page of results.
|
|
637
|
+
* @param endingBefore An alphanumeric string to move to the previous page of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets#asset-type-metadata' target='_blank'>Kelvin Asset Type Metadata</a> objects in the list.</p> The alphanumeric string which are the bookmarks for the beginning and end of the current list is given in the previous JSON response value under the key pagination -> previous_page and pagination -> next_page respectively.</p> The pagination -> previous_page alphanumeric string should be used here to show a list of the previous page of results.
|
|
638
|
+
* @param sortBy Sort the results by one of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets#asset-type-metadata' target='_blank'>Kelvin Asset Type Metadata</a> parameters. Only one parameter can be selected.</p> There in only one parameter option; `asset_type_metadata.name`
|
|
639
|
+
* @param sortAsc Sorting order for the results according to the `sort_by` parameter.</p> There are two options; `true` (ascending order) and `false` (descending order). The default is `true` (ascending).
|
|
597
640
|
* @param {IKvHttpRequestOptions} options Request optional parameters
|
|
598
641
|
*/
|
|
599
642
|
static listAssetTypeMetadata({ assetTypeName, search, pageSize, startingAfter, endingBefore, sortBy, sortAsc }, options) {
|
|
@@ -624,12 +667,49 @@ export class AssetService extends BaseService {
|
|
|
624
667
|
requestConfig.options = options;
|
|
625
668
|
return this.request(`/assets/types/${encodeURIComponent(String(assetTypeName))}/metadata/list`, requestConfig, AssetTypeMetadataListPaginated);
|
|
626
669
|
}
|
|
670
|
+
/**
|
|
671
|
+
* List Failure Overview
|
|
672
|
+
* List Failure Overview Returns a dictionary with a data property containing an array of failure overview summaries for <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset' target='_blank'>Kelvin Asset</a> objects that have failures recorded on the Kelvin Platform based on the filter requirements in the body parameters. This will summarize all failures on <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> in the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-hierarchy' target='_blank'>hierarchy</a> of each <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset' target='_blank'>Kelvin Asset</a> and give the failure quotient per <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset' target='_blank'>Kelvin Asset</a>. **Pagination Sortable Columns:** `asset.name`, `asset.title`, `asset.failure_quotient`, `asset_type.title` **Permission Required:** `kelvin.permission.asset.read`
|
|
673
|
+
* @param asset Failure Overview schema
|
|
674
|
+
* @param pageSize Number of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Asset</a> failure overview objects to be returned. Page size can be between 1 and 1000 objects.</p> The default is 20 Kelvin Asset Statistic objects.
|
|
675
|
+
* @param startingAfter An alphanumeric string to move to the next page of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Asset</a> failure overviews in the list.</p> The alphanumeric string which are the bookmarks for the beginning and end of the current list is given in the previous JSON response value under the key pagination -> previous_page and pagination -> next_page respectively.</p> The pagination -> next_page alphanumeric string should be used here to show a list of the next page of results.
|
|
676
|
+
* @param endingBefore An alphanumeric string to move to the previous page of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Asset</a> failure overviews in the list.</p> The alphanumeric string which are the bookmarks for the beginning and end of the current list is given in the previous JSON response value under the key pagination -> previous_page and pagination -> next_page respectively.</p> The pagination -> previous_page alphanumeric string should be used here to show a list of the previous page of results.
|
|
677
|
+
* @param sortBy Sort the results by one of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Asset</a> failure overview parameters. Only one parameter can be selected.</p> There are three parameter options; `asset.name`, `asset.title`, `asset.failure_quotient` and `asset_type.title`.</p> The default is `asset.name`
|
|
678
|
+
* @param sortAsc Sorting order for the results according to the `sort_by` parameter.</p> There are two options; `true` (ascending order) and `false` (descending order).</p> The default is `true` (ascending).
|
|
679
|
+
* @param {IKvHttpRequestOptions} options Request optional parameters
|
|
680
|
+
*/
|
|
681
|
+
static listFailureOverview({ asset, pageSize, startingAfter, endingBefore, sortBy, sortAsc }, options) {
|
|
682
|
+
const requestConfig = {
|
|
683
|
+
method: 'post'
|
|
684
|
+
};
|
|
685
|
+
const queryParameters = {};
|
|
686
|
+
if (pageSize != null) {
|
|
687
|
+
queryParameters['page_size'] = pageSize;
|
|
688
|
+
}
|
|
689
|
+
if (startingAfter != null) {
|
|
690
|
+
queryParameters['starting_after'] = startingAfter;
|
|
691
|
+
}
|
|
692
|
+
if (endingBefore != null) {
|
|
693
|
+
queryParameters['ending_before'] = endingBefore;
|
|
694
|
+
}
|
|
695
|
+
if (sortBy != null) {
|
|
696
|
+
queryParameters['sort_by'] = sortBy;
|
|
697
|
+
}
|
|
698
|
+
if (sortAsc != null) {
|
|
699
|
+
queryParameters['sort_asc'] = sortAsc;
|
|
700
|
+
}
|
|
701
|
+
requestConfig.params = queryParameters;
|
|
702
|
+
requestConfig.data = asset;
|
|
703
|
+
requestConfig.mediaType = 'application/json';
|
|
704
|
+
requestConfig.options = options;
|
|
705
|
+
return this.request(`/assets/failure-overview/list`, requestConfig, FailureOverviewPaginated);
|
|
706
|
+
}
|
|
627
707
|
/**
|
|
628
708
|
* Update Asset
|
|
629
|
-
* Update Asset **Permission Required:** `kelvin.permission.asset.update`
|
|
709
|
+
* Update Asset Update an existing <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target=\"_blank\">Kelvin Assets</a> with any new values passed through the body parameters. With the same API request you can also include updates to any <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> that are in the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-hierarchy' target='_blank'>hierarchy</a> of this <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a>. It is only possible to edit starting from either a <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-groups' target='_blank'>Kelvin Asset Group</a> or a <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset\" target=\"_blank\">Kelvin Asset</a>. It is not possible to directly edit <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#component' target='_blank'>Kelvin Components</a>, <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#part' target='_blank'>Kelvin Parts</a> or <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#sensor' target='_blank'>Kelvin Sensors</a>. To edit a <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#component' target='_blank'>Kelvin Component</a>, <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#part' target='_blank'>Kelvin Part</a> or <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#sensor' target='_blank'>Kelvin Sensor</a>, the body parameters must start with either the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-groups' target='_blank'>Kelvin Asset Group</a> or a <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset\" target=\"_blank\">Kelvin Asset</a> higher up in the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-hierarchy' target='_blank'>hierarchy</a>. The only exception is if the <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset\" target=\"_blank\">Kelvin Asset</a> is below the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-groups' target='_blank'>Kelvin Asset Group</a>, the body parameters can start at the <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset\" target=\"_blank\">Kelvin Asset</a> level and ignore the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-groups' target='_blank'>Kelvin Asset Group</a>. The minimum required in the body parameters is the top level `title`. If this body parameter does not need to be changed, it should still have the original Display Name (title) given. Any other body parameters that are not required and not provided will remain unchanged. <span style=\"color: #ff0000;font-weight: bold;\">WARNING</span> : If the `hierarchy` parameter is used, all `components`, `parts` and `sensors` for that next level only must be included in the body parameters with a minimum parameters `name`, `title`, `asset_type_name` and `entity_type_name` given. If any body parameter does not need to be changed, it should still contain the original information. Any other body parameters that are not required and not provided will remain unchanged. <span style=\"color: #ff0000;font-weight: bold;\">Any `components`, `parts` or `sensors` at this level not included will be automatically and permanently deleted.</span>. If in any `components`, `parts` or `sensors` body parameters, the `hierarchy` parameter is not provided, then the `hierarchy` for that particular `components`, `parts` or `sensors` will remain unchanged and not be deleted. **Permission Required:** `kelvin.permission.asset.update`
|
|
630
710
|
* @param asset Asset update schema
|
|
631
|
-
* @param assetName Asset name
|
|
632
|
-
* @param dryRun
|
|
711
|
+
* @param assetName <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-groups' target='_blank'>Kelvin Asset Group</a> or a <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset' target='_blank'>Kelvin Asset</a> name at the top of the hierarchy. Even if the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset' target='_blank'>Kelvin Asset</a> is below the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-groups' target='_blank'>Kelvin Asset Group</a>, the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset' target='_blank'>Kelvin Asset</a> name be used here.</p> This is the unique identifier name and not the display name (title) of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Asset</a>.
|
|
712
|
+
* @param dryRun Perform a trial run to update the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> without saving the changes.</p> This is very useful when you want to test your new <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> structure without making any changes on the Kelvin Platform.
|
|
633
713
|
* @param {IKvHttpRequestOptions} options Request optional parameters
|
|
634
714
|
*/
|
|
635
715
|
static updateAsset({ asset, assetName, dryRun }, options) {
|
|
@@ -648,9 +728,9 @@ export class AssetService extends BaseService {
|
|
|
648
728
|
}
|
|
649
729
|
/**
|
|
650
730
|
* Update Asset Class
|
|
651
|
-
* Update Asset Class **Permission Required:** `kelvin.permission.asset_class.update`
|
|
731
|
+
* Update Asset Class Updates an existing <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class' target='_blank'>Kelvin Asset Class</a> with any new values passed through the body parameters. Only the Display Name (title) body parameter is required. If this body parameter does not need to be changed, it should still have the original Display Name (title) given. Any other body parameters that are not required and not provided will remain unchanged. Only the unique identifier name can not be changed. If you need to change this parameter, then you will need to make a new <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class' target='_blank'>Kelvin Asset Class</a> and relink all <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type' target='_blank'>Kelvin Asset Types</a> to the new <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class' target='_blank'>Kelvin Asset Class</a>. **Permission Required:** `kelvin.permission.asset_class.update`
|
|
652
732
|
* @param assetClass AssetClass update schema
|
|
653
|
-
* @param assetClassName Asset Class
|
|
733
|
+
* @param assetClassName <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class' target='_blank'>Kelvin Asset Class</a> name to retrieve.</p> This is the unique identifier name and not the display name of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class' target='_blank'>Kelvin Asset Class</a>.</p> This must contain only lowercase alphanumeric characters. The `.`, `_` and `-` characters are also allowed to separate words instead of a space BUT can not be at the beginning or end of the name.
|
|
654
734
|
* @param {IKvHttpRequestOptions} options Request optional parameters
|
|
655
735
|
*/
|
|
656
736
|
static updateAssetClass({ assetClass, assetClassName }, options) {
|
|
@@ -664,9 +744,9 @@ export class AssetService extends BaseService {
|
|
|
664
744
|
}
|
|
665
745
|
/**
|
|
666
746
|
* Update Asset Hierarchies
|
|
667
|
-
* Update Asset Hierarchies **Permission Required:** `kelvin.permission.asset.create`
|
|
747
|
+
* Update Asset Hierarchies Update one or many <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target=\"_blank\">Kelvin Assets</a> in one API request with any new values passed through the body parameters. Any <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target=\"_blank\">Kelvin Assets</a> not included in the body parameter will remain unchanged. The <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-hierarchy' target='_blank'>hierarchy</a> of every <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-groups' target='_blank'>Kelvin Asset Group</a> and <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset' target='_blank'>Kelvin Asset</a> must be maintained within this structure. This is similar as `/assets/{asset_name}/update` API request except that you can update multiple <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target=\"_blank\">Kelvin Assets</a> at the same time and one key difference regarding `hierarchy` that is explains later. Below is an explanation which should apply to all <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target=\"_blank\">Kelvin Assets</a> given in the body parameter. It is only possible to edit starting from either a <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-groups' target='_blank'>Kelvin Asset Group</a> or a <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset\" target=\"_blank\">Kelvin Asset</a>. It is not possible to directly edit <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#component' target='_blank'>Kelvin Components</a>, <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#part' target='_blank'>Kelvin Parts</a> or <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#sensor' target='_blank'>Kelvin Sensors</a>. To edit a <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#component' target='_blank'>Kelvin Component</a>, <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#part' target='_blank'>Kelvin Part</a> or <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#sensor' target='_blank'>Kelvin Sensor</a>, the body parameters must start with either the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-groups' target='_blank'>Kelvin Asset Group</a> or a <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset\" target=\"_blank\">Kelvin Asset</a> higher up in the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-hierarchy' target='_blank'>hierarchy</a>. Every <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-hierarchy' target='_blank'>hierarchy</a> must be declared from the highest level. The API request will accept any <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset' target='_blank'>Kelvin Asset</a> to update without requiring it to be inside the `hierarchy` parameter in <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-groups' target='_blank'>Kelvin Asset Group</a>, but if this <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset' target='_blank'>Kelvin Asset</a> originally is positioned under a <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-groups' target='_blank'>Kelvin Asset Group</a>, then this structure will be lost and the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset' target='_blank'>Kelvin Asset</a> will move to the top of a new <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-hierarchy' target='_blank'>hierarchy</a>. The minimum required in the body parameters is the `name`, `title`, `asset_type_name` and `entity_type_name`. If these body parameters do not need to be changed, it should still contain the original information. Any other body parameters that are not required and not provided will remain unchanged. The only exception to this minimum requirement is when the parameter `delete` is marked as `true`. In this case the only other parameter required is `name`. If deleting any <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target=\"_blank\">Kelvin Assets</a> with this method, all children <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target=\"_blank\">Kelvin Assets</a> in the `hierarchy` below will also be deleted. <span style=\"color: #ff0000;font-weight: bold;\">WARNING</span> : If the `hierarchy` parameter is used, all `components`, `parts` and `sensors` for only the next level down must be included in the body parameters with a minimum parameters `name`, `title`, `asset_type_name` and `entity_type_name` given. If any body parameter does not need to be changed, it should still contain the original information. Any other body parameters that are not required and not provided will remain unchanged. <span style=\"color: #ff0000;font-weight: bold;\">Any `components`, `parts` or `sensors` and its children items at this level not included will be automatically and permenently deleted.</span>. If in any `components`, `parts` or `sensors` body parameters, the `hierarchy` parameter is not provided, then the `hierarchy` for that particular `components`, `parts` or `sensors` will remain and not be deleted. **Permission Required:** `kelvin.permission.asset.create`
|
|
668
748
|
* @param hierarchy Asset Hierarchy update schema
|
|
669
|
-
* @param dryRun
|
|
749
|
+
* @param dryRun Perform a trial run to update the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> without saving the changes.</p> This is very useful when you want to test your new <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> structure without making any changes on the Kelvin Platform.
|
|
670
750
|
* @param {IKvHttpRequestOptions} options Request optional parameters
|
|
671
751
|
*/
|
|
672
752
|
static updateAssetHierarchies({ hierarchy, dryRun }, options) {
|
|
@@ -685,9 +765,9 @@ export class AssetService extends BaseService {
|
|
|
685
765
|
}
|
|
686
766
|
/**
|
|
687
767
|
* Update Asset Template
|
|
688
|
-
* Update Asset Template **Permission Required:** `kelvin.permission.asset.update`
|
|
768
|
+
* Update Asset Template Updates an existing Kelvin Template with any new values passed through the body parameters.</p> All body parameters are optional and if not provided will remain unchanged. Only the unique identifier name can not be changed. If you need to change this parameter, then you will need to make a new Kelvin Template with a new <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-hierarchy' target='_blank'>hierarchy</a> (Hint: To avoid having to type everything in again, you can get the current JSON structure of the Kelvin Template from /assets/templates/{asset_template_name}/get API and then use this as the foundation for a new Kelvin Template). **Permission Required:** `kelvin.permission.asset.update`
|
|
689
769
|
* @param assetTemplate Asset Template update schema
|
|
690
|
-
* @param assetTemplateName
|
|
770
|
+
* @param assetTemplateName <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#kelvin-templates' target='_blank'>Kelvin Template</a> name to retrieve.</p> This is the unique identifier name and not the display name (title) of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#kelvin-templates' target='_blank'>Kelvin Template</a>.
|
|
691
771
|
* @param {IKvHttpRequestOptions} options Request optional parameters
|
|
692
772
|
*/
|
|
693
773
|
static updateAssetTemplate({ assetTemplate, assetTemplateName }, options) {
|
|
@@ -701,9 +781,9 @@ export class AssetService extends BaseService {
|
|
|
701
781
|
}
|
|
702
782
|
/**
|
|
703
783
|
* Update Asset Type
|
|
704
|
-
* Update Asset Type **Permission Required:** `kelvin.permission.asset_type.update`
|
|
784
|
+
* Update Asset Type Updates an existing <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type' target='_blank'>Kelvin Asset Type</a> with any new values passed through the body parameters.</p> All body parameters are optional and if not provided will remain unchanged.</p> Only the unique identifier name can not be changed. If you need to change this parameter, then you will need to make a new <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type' target='_blank'>Kelvin Asset Type</a> and relink all <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> to the new <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type' target='_blank'>Kelvin Asset Type</a>. **Permission Required:** `kelvin.permission.asset_type.update`
|
|
705
785
|
* @param assettype AssetType update schema
|
|
706
|
-
* @param assetTypeName Asset Type name
|
|
786
|
+
* @param assetTypeName <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type' target='_blank'>Kelvin Asset Type</a> name to retrieve.</p> This is the unique identifier name and not the display name of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type' target='_blank'>Kelvin Asset Type</a>.</p> This must contain only lowercase alphanumeric characters. The `.`, `_` and `-` characters are also allowed to separate words instead of a space BUT can not be at the beginning or end of the name.
|
|
707
787
|
* @param {IKvHttpRequestOptions} options Request optional parameters
|
|
708
788
|
*/
|
|
709
789
|
static updateAssetType({ assettype, assetTypeName }, options) {
|
|
@@ -717,10 +797,10 @@ export class AssetService extends BaseService {
|
|
|
717
797
|
}
|
|
718
798
|
/**
|
|
719
799
|
* Update Asset Type Metadata
|
|
720
|
-
* Update Asset Type Metadata **Permission Required:** `kelvin.permission.asset_type.update`
|
|
800
|
+
* Update Asset Type Metadata Updates the payload of an existing <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets#asset-type-metadata' target='_blank'>Kelvin Asset Type Metadata</a> object associated with a <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type' target='_blank'>Kelvin Asset Type</a>. The payload will be completely replaced by the new payload. Any existing key/value pairs that you want to keep must be included in your new payload that is sent with the API request. This will only update the payload of the specific <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets#asset-type-metadata' target='_blank'>Kelvin Asset Type Metadata</a> object linked to the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type' target='_blank'>Kelvin Asset Type</a>. If there is a <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets#asset-type-metadata' target='_blank'>Kelvin Asset Type Metadata</a> object with the same name and payload BUT associated with a different <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type' target='_blank'>Kelvin Asset Type</a>, this will not be updated. **Permission Required:** `kelvin.permission.asset_type.update`
|
|
721
801
|
* @param assettypemetadata Asset Type Metadata update schema
|
|
722
|
-
* @param assetTypeName Asset Type name
|
|
723
|
-
* @param assetTypeMetadataName Asset Type Metadata name
|
|
802
|
+
* @param assetTypeName Unique identifier name of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type' target='_blank'>Kelvin Asset Type</a> to replace the specified metadata payload.</p> This must contain only lowercase alphanumeric characters. The `.`, `_` and `-` characters are also allowed to separate words instead of a space BUT can not be at the beginning or end of the name.
|
|
803
|
+
* @param assetTypeMetadataName <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets#asset-type-metadata' target='_blank'>Kelvin Asset Type Metadata</a> unique identifier name to retrieve.</p> This must contain only lowercase alphanumeric characters. The `.`, `_` and `-` characters are also allowed to separate words instead of a space BUT can not be at the beginning or end of the name.
|
|
724
804
|
* @param {IKvHttpRequestOptions} options Request optional parameters
|
|
725
805
|
*/
|
|
726
806
|
static updateAssetTypeMetadata({ assettypemetadata, assetTypeName, assetTypeMetadataName }, options) {
|
|
@@ -734,9 +814,9 @@ export class AssetService extends BaseService {
|
|
|
734
814
|
}
|
|
735
815
|
/**
|
|
736
816
|
* Upload Assets
|
|
737
|
-
* Upload Assets **Permission Required:** `kelvin.permission.asset.create`
|
|
738
|
-
* @param file CSV File
|
|
739
|
-
* @param dryRun
|
|
817
|
+
* Upload Assets Upload a csv (comma-separated values) file with up to 20,000 assets to add as <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> into the <a href='https://docs.kelvininc.com/latest/kelvin-overview/overview/#kelvin-platform' target='_blank'>Kelvin Platform</a>. Each row represents one <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a>. The <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-hierarchy' target='_blank'>hierarchy</a> can also be created in this file by declaring the parent for each <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset' target='_blank'>Kelvin Asset</a>. If this field is left blank, then it is assumed to have no parent and will appear at the top of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-hierarchy' target='_blank'>hierarchy</a>. The first row of the csv file needs to be the header of the columns. `DISPLAY NAME,NAME,ASSET TYPE,LATITUDE,LONGITUDE,DIRECT PARENT,ENTITY TYPE`. Details of the options for each column are explained in this <a href='https://docs.kelvininc.com/latest/documentation/kelvin-platform/kelvin-manager-ui/management/assets/assets/#importing-assets-in-bulk' target='_blank'>Kelvin Documentation</a> link. The file needs to be saved in UTF-8 format with a comma separating each field. Do not use other separation options available in Microsoft Excel or Google Sheets such as semi-colons or colons. Strings in the csv file can be with or without quotation marks. **Permission Required:** `kelvin.permission.asset.create`
|
|
818
|
+
* @param file Path and name of the CSV File to upload to the <a href='https://docs.kelvininc.com/latest/kelvin-overview/overview/#kelvin-platform' target='_blank'>Kelvin Platform</a>.</p> You can download a blank copy of the template from the <a href='https://docs.kelvininc.com/latest/documentation/kelvin-platform/kelvin-manager-ui/control-manager-ui-overview/' target='_blank'>Kelvin Manager UI</a>. Instructions can be found in the <a href='https://docs.kelvininc.com/latest/documentation/kelvin-platform/kelvin-manager-ui/management/metrics/metrics/#1-download-the-assets-csv-template' target='_blank'>Kelvin Documentation</a>.
|
|
819
|
+
* @param dryRun Perform a trial run to create the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> without saving the changes.</p> This is very useful when you want to test your new <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Asset</a> structure without making any changes on the <a href='https://docs.kelvininc.com/latest/kelvin-overview/overview/#kelvin-platform' target='_blank'>Kelvin Platform</a>.
|
|
740
820
|
* @param {IKvHttpRequestOptions} options Request optional parameters
|
|
741
821
|
*/
|
|
742
822
|
static uploadAssets({ file, dryRun }, options) {
|