@kelvininc/js-client-sdk 7.8.0 → 7.8.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 +11 -0
- package/dist/cjs/models/generated/assetItem.d.ts +3 -0
- package/dist/cjs/models/generated/assetItem.js +2 -0
- package/dist/cjs/models/generated/assetItem.js.map +1 -1
- package/dist/cjs/services/generated/api/asset.service.d.ts +24 -22
- package/dist/cjs/services/generated/api/asset.service.js +30 -22
- package/dist/cjs/services/generated/api/asset.service.js.map +1 -1
- 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/asset.service.types.d.ts +2 -0
- package/dist/cjs/services/generated/types/asset.service.types.js.map +1 -1
- package/dist/esm/models/generated/assetItem.d.ts +3 -0
- package/dist/esm/models/generated/assetItem.js +2 -0
- package/dist/esm/models/generated/assetItem.js.map +1 -1
- package/dist/esm/services/generated/api/asset.service.d.ts +24 -22
- package/dist/esm/services/generated/api/asset.service.js +30 -22
- package/dist/esm/services/generated/api/asset.service.js.map +1 -1
- 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/asset.service.types.d.ts +2 -0
- package/dist/esm/services/generated/types/asset.service.types.js.map +1 -1
- package/package.json +2 -2
package/CHANGELOG.md
CHANGED
|
@@ -3,6 +3,17 @@
|
|
|
3
3
|
All notable changes to this project will be documented in this file.
|
|
4
4
|
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
|
5
5
|
|
|
6
|
+
## [7.8.1](https://bitbucket.org/kelvininc/kelvinjs/compare/v7.8.0...v7.8.1) (2022-07-25)
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
### Bug Fixes
|
|
10
|
+
|
|
11
|
+
* **kelvin-js-sdk:** include properties in asset service [KMANAGER-218] ([1f21b3f](https://bitbucket.org/kelvininc/kelvinjs/commits/1f21b3ff67fdcb39c77b0d7fb3f936c009d70535))
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
|
|
6
17
|
# [7.8.0](https://bitbucket.org/kelvininc/kelvinjs/compare/v7.7.0...v7.8.0) (2022-07-06)
|
|
7
18
|
|
|
8
19
|
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import { Model } from '../model';
|
|
2
|
+
import { AssetProperty, IAssetProperty } from './assetProperty';
|
|
2
3
|
import { AssetStatusItem, IAssetStatusItem } from './assetStatusItem';
|
|
3
4
|
/**
|
|
4
5
|
* @category Service Response Model
|
|
@@ -14,6 +15,7 @@ export interface IAssetItem {
|
|
|
14
15
|
entity_type_title?: string;
|
|
15
16
|
asset_type_title?: string;
|
|
16
17
|
asset_class_title?: string;
|
|
18
|
+
properties?: Array<AssetProperty | IAssetProperty>;
|
|
17
19
|
entity_type_name?: string;
|
|
18
20
|
}
|
|
19
21
|
/**
|
|
@@ -30,6 +32,7 @@ export declare class AssetItem extends Model {
|
|
|
30
32
|
entityTypeTitle: string;
|
|
31
33
|
assetTypeTitle: string;
|
|
32
34
|
assetClassTitle: string;
|
|
35
|
+
properties: Array<AssetProperty>;
|
|
33
36
|
entityTypeName: string;
|
|
34
37
|
constructor(model?: IAssetItem);
|
|
35
38
|
mapping(): {
|
|
@@ -2,6 +2,7 @@
|
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.AssetItem = void 0;
|
|
4
4
|
const model_1 = require("../model");
|
|
5
|
+
const assetProperty_1 = require("./assetProperty");
|
|
5
6
|
const assetStatusItem_1 = require("./assetStatusItem");
|
|
6
7
|
/**
|
|
7
8
|
* @category Service Response Model Object
|
|
@@ -22,6 +23,7 @@ class AssetItem extends model_1.Model {
|
|
|
22
23
|
entity_type_title: 'entityTypeTitle',
|
|
23
24
|
asset_type_title: 'assetTypeTitle',
|
|
24
25
|
asset_class_title: 'assetClassTitle',
|
|
26
|
+
properties: ['properties', assetProperty_1.AssetProperty],
|
|
25
27
|
entity_type_name: 'entityTypeName'
|
|
26
28
|
};
|
|
27
29
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"assetItem.js","sourceRoot":"","sources":["../../../../src/models/generated/assetItem.ts"],"names":[],"mappings":";;;AAAA,oCAAiC;AACjC,uDAAsE;
|
|
1
|
+
{"version":3,"file":"assetItem.js","sourceRoot":"","sources":["../../../../src/models/generated/assetItem.ts"],"names":[],"mappings":";;;AAAA,oCAAiC;AACjC,mDAAgE;AAChE,uDAAsE;AAoBtE;;GAEG;AACH,MAAa,SAAU,SAAQ,aAAK;IAcnC,YAAY,KAAkB;QAC7B,KAAK,CAAC,KAAK,CAAC,CAAC;IACd,CAAC;IAED,OAAO;QACN,OAAO;YACN,eAAe,EAAE,eAAe;YAChC,MAAM,EAAE,CAAC,QAAQ,EAAE,iCAAe,CAAC;YACnC,OAAO,EAAE,CAAC,SAAS,EAAE,IAAI,CAAC;YAC1B,IAAI,EAAE,MAAM;YACZ,OAAO,EAAE,CAAC,SAAS,EAAE,IAAI,CAAC;YAC1B,gBAAgB,EAAE,gBAAgB;YAClC,KAAK,EAAE,OAAO;YACd,iBAAiB,EAAE,iBAAiB;YACpC,gBAAgB,EAAE,gBAAgB;YAClC,iBAAiB,EAAE,iBAAiB;YACpC,UAAU,EAAE,CAAC,YAAY,EAAE,6BAAa,CAAC;YACzC,gBAAgB,EAAE,gBAAgB;SAClC,CAAC;IACH,CAAC;CACD;AAlCD,8BAkCC","sourcesContent":["import { Model } from '../model';\nimport { AssetProperty, IAssetProperty } from './assetProperty';\nimport { AssetStatusItem, IAssetStatusItem } from './assetStatusItem';\n\n/**\n * @category Service Response Model\n */\nexport interface IAssetItem {\n\tasset_type_name?: string;\n\tstatus?: AssetStatusItem | IAssetStatusItem;\n\tupdated?: Date | string;\n\tname?: string;\n\tcreated?: Date | string;\n\tasset_class_name?: string;\n\ttitle?: string;\n\tentity_type_title?: string;\n\tasset_type_title?: string;\n\tasset_class_title?: string;\n\tproperties?: Array<AssetProperty | IAssetProperty>;\n\tentity_type_name?: string;\n}\n\n/**\n * @category Service Response Model Object\n */\nexport class AssetItem extends Model {\n\tassetTypeName: string;\n\tstatus: AssetStatusItem;\n\tupdated: Date;\n\tname: string;\n\tcreated: Date;\n\tassetClassName: string;\n\ttitle: string;\n\tentityTypeTitle: string;\n\tassetTypeTitle: string;\n\tassetClassTitle: string;\n\tproperties: Array<AssetProperty>;\n\tentityTypeName: string;\n\n\tconstructor(model?: IAssetItem) {\n\t\tsuper(model);\n\t}\n\n\tmapping(): { [key: string]: Object } {\n\t\treturn {\n\t\t\tasset_type_name: 'assetTypeName',\n\t\t\tstatus: ['status', AssetStatusItem],\n\t\t\tupdated: ['updated', Date],\n\t\t\tname: 'name',\n\t\t\tcreated: ['created', Date],\n\t\t\tasset_class_name: 'assetClassName',\n\t\t\ttitle: 'title',\n\t\t\tentity_type_title: 'entityTypeTitle',\n\t\t\tasset_type_title: 'assetTypeTitle',\n\t\t\tasset_class_title: 'assetClassTitle',\n\t\t\tproperties: ['properties', AssetProperty],\n\t\t\tentity_type_name: 'entityTypeName'\n\t\t};\n\t}\n}\n"]}
|
|
@@ -17,8 +17,8 @@ export declare class AssetService extends BaseService {
|
|
|
17
17
|
static createAsset({ asset, dryRun }: ICreateAssetParams, options?: IKvHttpRequestOptions): Observable<Asset>;
|
|
18
18
|
/**
|
|
19
19
|
* Create Asset Class
|
|
20
|
-
* Create Asset Class **Permission Required:** `kelvin.permission.asset_class.create`
|
|
21
|
-
* @param assetClass
|
|
20
|
+
* 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 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_class.create`
|
|
21
|
+
* @param assetClass Asset Class Create Parameters
|
|
22
22
|
* @param {IKvHttpRequestOptions} options Request optional parameters
|
|
23
23
|
*/
|
|
24
24
|
static createAssetClass({ assetClass }: ICreateAssetClassParams, options?: IKvHttpRequestOptions): Observable<AssetClass>;
|
|
@@ -47,15 +47,15 @@ export declare class AssetService extends BaseService {
|
|
|
47
47
|
static createAssetTemplate({ assetTemplate }: ICreateAssetTemplateParams, options?: IKvHttpRequestOptions): Observable<AssetTemplate>;
|
|
48
48
|
/**
|
|
49
49
|
* Create Asset Type
|
|
50
|
-
* Create Asset Type **Permission Required:** `kelvin.permission.asset_type.create`
|
|
50
|
+
* 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-type\" target=\"_blank\">Kelvin Asset Type</a> is linked to a <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class\" target=\"_blank\">Kelvin Asset Class</a>. You can have many <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type\" target=\"_blank\">Kelvin Asset Types</a> linked to a single <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/\" 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`
|
|
51
51
|
* @param assettype AssetType create schema
|
|
52
52
|
* @param {IKvHttpRequestOptions} options Request optional parameters
|
|
53
53
|
*/
|
|
54
54
|
static createAssetType({ assettype }: ICreateAssetTypeParams, options?: IKvHttpRequestOptions): Observable<AssetType>;
|
|
55
55
|
/**
|
|
56
56
|
* Create Asset Type Metadata
|
|
57
|
-
* Create Asset Type Metadata **Permission Required:** `kelvin.permission.asset_type.create`
|
|
58
|
-
* @param assetTypeName Asset Type
|
|
57
|
+
* 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 to return this custom information for your own use. This metadata does not affect the operation of the Kelvin Platform. **Permission Required:** `kelvin.permission.asset_type.create`
|
|
58
|
+
* @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 metadata to.
|
|
59
59
|
* @param assettypemetadata Asset Type Metadata create schema
|
|
60
60
|
* @param {IKvHttpRequestOptions} options Request optional parameters
|
|
61
61
|
*/
|
|
@@ -69,8 +69,8 @@ export declare class AssetService extends BaseService {
|
|
|
69
69
|
static deleteAsset({ assetName }: IDeleteAssetParams, options?: IKvHttpRequestOptions): Observable<IKvHttpResponse>;
|
|
70
70
|
/**
|
|
71
71
|
* Delete Asset Class
|
|
72
|
-
* Delete Asset Class **Permission Required:** `kelvin.permission.asset_class.delete`
|
|
73
|
-
* @param assetClassName Asset Class
|
|
72
|
+
* 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`
|
|
73
|
+
* @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>.
|
|
74
74
|
* @param {IKvHttpRequestOptions} options Request optional parameters
|
|
75
75
|
*/
|
|
76
76
|
static deleteAssetClass({ assetClassName }: IDeleteAssetClassParams, options?: IKvHttpRequestOptions): Observable<IKvHttpResponse>;
|
|
@@ -106,8 +106,8 @@ export declare class AssetService extends BaseService {
|
|
|
106
106
|
static getAsset({ assetName, metadata }: IGetAssetParams, options?: IKvHttpRequestOptions): Observable<Asset>;
|
|
107
107
|
/**
|
|
108
108
|
* Get Asset Class
|
|
109
|
-
* Get Asset Class **Permission Required:** `kelvin.permission.asset_class.read`
|
|
110
|
-
* @param assetClassName Asset Class
|
|
109
|
+
* 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`
|
|
110
|
+
* @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>.
|
|
111
111
|
* @param {IKvHttpRequestOptions} options Request optional parameters
|
|
112
112
|
*/
|
|
113
113
|
static getAssetClass({ assetClassName }: IGetAssetClassParams, options?: IKvHttpRequestOptions): Observable<AssetClass>;
|
|
@@ -197,6 +197,8 @@ export declare class AssetService extends BaseService {
|
|
|
197
197
|
* @param assetTypeName Filter assets by asset type
|
|
198
198
|
* @param statusState Filter assets by status state [`online`, `offline`, `partially_online`, `unknown`]
|
|
199
199
|
* @param entityTypeName Filter assets by entity type. Prefix any `entity_type_name` with the character `!` for a NOT operation
|
|
200
|
+
* @param propertiesFilter Filter assets that have an property.name = property.value. Format `property_name=property_value`
|
|
201
|
+
* @param properties Only return specific properties (default: return all properties): Format `property_name`
|
|
200
202
|
* @param pageSize Number of objects to be returned, between 1 and 1000. Default: 20
|
|
201
203
|
* @param startingAfter Lower bound cursor for use in pagination
|
|
202
204
|
* @param endingBefore Upper bound cursor for use in pagination
|
|
@@ -204,18 +206,18 @@ export declare class AssetService extends BaseService {
|
|
|
204
206
|
* @param sortAsc Order of sorting is Ascending. Possible Values: true/false. Default: true
|
|
205
207
|
* @param {IKvHttpRequestOptions} options Request optional parameters
|
|
206
208
|
*/
|
|
207
|
-
static listAsset({ search, names, assetTypeName, statusState, entityTypeName, pageSize, startingAfter, endingBefore, sortBy, sortAsc }?: IListAssetParams, options?: IKvHttpRequestOptions): Observable<AssetListPaginated>;
|
|
209
|
+
static listAsset({ search, names, assetTypeName, statusState, entityTypeName, propertiesFilter, properties, pageSize, startingAfter, endingBefore, sortBy, sortAsc }?: IListAssetParams, options?: IKvHttpRequestOptions): Observable<AssetListPaginated>;
|
|
208
210
|
/**
|
|
209
211
|
* List Asset Class
|
|
210
|
-
* 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`
|
|
211
|
-
* @param search Search Asset Class
|
|
212
|
-
* @param pageSize Number of objects to be returned
|
|
213
|
-
* @param startingAfter
|
|
214
|
-
* @param endingBefore
|
|
215
|
-
* @param sortBy
|
|
216
|
-
* @param sortAsc
|
|
217
|
-
* @param owner Filter Asset Class by owner
|
|
218
|
-
* @param entityTypeName Filter
|
|
212
|
+
* List Asset Class Returns a filtered list of all <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class\" target=\"_blank\">Kelvin Asset Classes</a> on the Kelvin Platform. 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 Classes</a> 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`
|
|
213
|
+
* @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 Kelvin Asset Class name is centrifugal_pump, then a match will be made if the search string is `pum` or `FUGaL`.
|
|
214
|
+
* @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. The default is 20 Kelvin Asset Class objects.
|
|
215
|
+
* @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.
|
|
216
|
+
* @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.
|
|
217
|
+
* @param sortBy Sort the results by one of the Kelvin Asset Class 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`. The default is `asset_class.name`
|
|
218
|
+
* @param sortAsc Sorting order for the results.</p> There are two options; `true` (ascending order) and `false` (descending order). The default is true (ascending).
|
|
219
|
+
* @param owner Filter Kelvin Asset Class by owner.</p> There are two types of owners; `custom` (any user) or `kelvin` (core kelvin asset class).
|
|
220
|
+
* @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>
|
|
219
221
|
* @param {IKvHttpRequestOptions} options Request optional parameters
|
|
220
222
|
*/
|
|
221
223
|
static listAssetClass({ search, pageSize, startingAfter, endingBefore, sortBy, sortAsc, owner, entityTypeName }?: IListAssetClassParams, options?: IKvHttpRequestOptions): Observable<AssetClassListPaginated>;
|
|
@@ -250,7 +252,7 @@ export declare class AssetService extends BaseService {
|
|
|
250
252
|
static listAssetTemplate({ search, pageSize, startingAfter, endingBefore, sortBy, sortAsc, assetTypeNames, entityTypeNames, assetClassNames, owner }?: IListAssetTemplateParams, options?: IKvHttpRequestOptions): Observable<AssetTemplateListPaginated>;
|
|
251
253
|
/**
|
|
252
254
|
* List Asset Type
|
|
253
|
-
* 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`
|
|
255
|
+
* List Asset Type Returns a filtered list of all <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type\" target=\"_blank\">Kelvin Asset Types</a> on the Kelvin Platform. 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 Types</a> returned in alphabetical order by the unique identifier 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`
|
|
254
256
|
* @param search Search asset type by name or title
|
|
255
257
|
* @param assetClassName Filter asset type by asset class
|
|
256
258
|
* @param metadata Inject metadata into the response
|
|
@@ -302,9 +304,9 @@ export declare class AssetService extends BaseService {
|
|
|
302
304
|
static updateAsset({ asset, assetName, dryRun }: IUpdateAssetParams, options?: IKvHttpRequestOptions): Observable<Asset>;
|
|
303
305
|
/**
|
|
304
306
|
* Update Asset Class
|
|
305
|
-
* Update Asset Class **Permission Required:** `kelvin.permission.asset_class.update`
|
|
307
|
+
* 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.</p> 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.</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-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`
|
|
306
308
|
* @param assetClass AssetClass update schema
|
|
307
|
-
* @param assetClassName Asset Class
|
|
309
|
+
* @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>.
|
|
308
310
|
* @param {IKvHttpRequestOptions} options Request optional parameters
|
|
309
311
|
*/
|
|
310
312
|
static updateAssetClass({ assetClass, assetClassName }: IUpdateAssetClassParams, options?: IKvHttpRequestOptions): Observable<AssetClass>;
|
|
@@ -30,8 +30,8 @@ class AssetService extends base_service_1.BaseService {
|
|
|
30
30
|
}
|
|
31
31
|
/**
|
|
32
32
|
* Create Asset Class
|
|
33
|
-
* Create Asset Class **Permission Required:** `kelvin.permission.asset_class.create`
|
|
34
|
-
* @param assetClass
|
|
33
|
+
* 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 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_class.create`
|
|
34
|
+
* @param assetClass Asset Class Create Parameters
|
|
35
35
|
* @param {IKvHttpRequestOptions} options Request optional parameters
|
|
36
36
|
*/
|
|
37
37
|
static createAssetClass({ assetClass }, options) {
|
|
@@ -92,7 +92,7 @@ class AssetService extends base_service_1.BaseService {
|
|
|
92
92
|
}
|
|
93
93
|
/**
|
|
94
94
|
* Create Asset Type
|
|
95
|
-
* Create Asset Type **Permission Required:** `kelvin.permission.asset_type.create`
|
|
95
|
+
* 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-type\" target=\"_blank\">Kelvin Asset Type</a> is linked to a <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class\" target=\"_blank\">Kelvin Asset Class</a>. You can have many <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type\" target=\"_blank\">Kelvin Asset Types</a> linked to a single <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/\" 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`
|
|
96
96
|
* @param assettype AssetType create schema
|
|
97
97
|
* @param {IKvHttpRequestOptions} options Request optional parameters
|
|
98
98
|
*/
|
|
@@ -107,8 +107,8 @@ class AssetService extends base_service_1.BaseService {
|
|
|
107
107
|
}
|
|
108
108
|
/**
|
|
109
109
|
* Create Asset Type Metadata
|
|
110
|
-
* Create Asset Type Metadata **Permission Required:** `kelvin.permission.asset_type.create`
|
|
111
|
-
* @param assetTypeName Asset Type
|
|
110
|
+
* 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 to return this custom information for your own use. This metadata does not affect the operation of the Kelvin Platform. **Permission Required:** `kelvin.permission.asset_type.create`
|
|
111
|
+
* @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 metadata to.
|
|
112
112
|
* @param assettypemetadata Asset Type Metadata create schema
|
|
113
113
|
* @param {IKvHttpRequestOptions} options Request optional parameters
|
|
114
114
|
*/
|
|
@@ -137,8 +137,8 @@ class AssetService extends base_service_1.BaseService {
|
|
|
137
137
|
}
|
|
138
138
|
/**
|
|
139
139
|
* Delete Asset Class
|
|
140
|
-
* Delete Asset Class **Permission Required:** `kelvin.permission.asset_class.delete`
|
|
141
|
-
* @param assetClassName Asset Class
|
|
140
|
+
* 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`
|
|
141
|
+
* @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>.
|
|
142
142
|
* @param {IKvHttpRequestOptions} options Request optional parameters
|
|
143
143
|
*/
|
|
144
144
|
static deleteAssetClass({ assetClassName }, options) {
|
|
@@ -214,8 +214,8 @@ class AssetService extends base_service_1.BaseService {
|
|
|
214
214
|
}
|
|
215
215
|
/**
|
|
216
216
|
* Get Asset Class
|
|
217
|
-
* Get Asset Class **Permission Required:** `kelvin.permission.asset_class.read`
|
|
218
|
-
* @param assetClassName Asset Class
|
|
217
|
+
* 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`
|
|
218
|
+
* @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>.
|
|
219
219
|
* @param {IKvHttpRequestOptions} options Request optional parameters
|
|
220
220
|
*/
|
|
221
221
|
static getAssetClass({ assetClassName }, options) {
|
|
@@ -425,6 +425,8 @@ class AssetService extends base_service_1.BaseService {
|
|
|
425
425
|
* @param assetTypeName Filter assets by asset type
|
|
426
426
|
* @param statusState Filter assets by status state [`online`, `offline`, `partially_online`, `unknown`]
|
|
427
427
|
* @param entityTypeName Filter assets by entity type. Prefix any `entity_type_name` with the character `!` for a NOT operation
|
|
428
|
+
* @param propertiesFilter Filter assets that have an property.name = property.value. Format `property_name=property_value`
|
|
429
|
+
* @param properties Only return specific properties (default: return all properties): Format `property_name`
|
|
428
430
|
* @param pageSize Number of objects to be returned, between 1 and 1000. Default: 20
|
|
429
431
|
* @param startingAfter Lower bound cursor for use in pagination
|
|
430
432
|
* @param endingBefore Upper bound cursor for use in pagination
|
|
@@ -432,7 +434,7 @@ class AssetService extends base_service_1.BaseService {
|
|
|
432
434
|
* @param sortAsc Order of sorting is Ascending. Possible Values: true/false. Default: true
|
|
433
435
|
* @param {IKvHttpRequestOptions} options Request optional parameters
|
|
434
436
|
*/
|
|
435
|
-
static listAsset({ search, names, assetTypeName, statusState, entityTypeName, pageSize, startingAfter, endingBefore, sortBy, sortAsc } = {}, options) {
|
|
437
|
+
static listAsset({ search, names, assetTypeName, statusState, entityTypeName, propertiesFilter, properties, pageSize, startingAfter, endingBefore, sortBy, sortAsc } = {}, options) {
|
|
436
438
|
const requestConfig = {
|
|
437
439
|
method: 'get'
|
|
438
440
|
};
|
|
@@ -452,6 +454,12 @@ class AssetService extends base_service_1.BaseService {
|
|
|
452
454
|
if (entityTypeName != null) {
|
|
453
455
|
queryParameters['entity_type_name'] = entityTypeName;
|
|
454
456
|
}
|
|
457
|
+
if (propertiesFilter != null) {
|
|
458
|
+
queryParameters['properties_filter'] = propertiesFilter;
|
|
459
|
+
}
|
|
460
|
+
if (properties != null) {
|
|
461
|
+
queryParameters['properties'] = properties;
|
|
462
|
+
}
|
|
455
463
|
if (pageSize != null) {
|
|
456
464
|
queryParameters['page_size'] = pageSize;
|
|
457
465
|
}
|
|
@@ -474,15 +482,15 @@ class AssetService extends base_service_1.BaseService {
|
|
|
474
482
|
}
|
|
475
483
|
/**
|
|
476
484
|
* List Asset Class
|
|
477
|
-
* 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`
|
|
478
|
-
* @param search Search Asset Class
|
|
479
|
-
* @param pageSize Number of objects to be returned
|
|
480
|
-
* @param startingAfter
|
|
481
|
-
* @param endingBefore
|
|
482
|
-
* @param sortBy
|
|
483
|
-
* @param sortAsc
|
|
484
|
-
* @param owner Filter Asset Class by owner
|
|
485
|
-
* @param entityTypeName Filter
|
|
485
|
+
* List Asset Class Returns a filtered list of all <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class\" target=\"_blank\">Kelvin Asset Classes</a> on the Kelvin Platform. 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 Classes</a> 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`
|
|
486
|
+
* @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 Kelvin Asset Class name is centrifugal_pump, then a match will be made if the search string is `pum` or `FUGaL`.
|
|
487
|
+
* @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. The default is 20 Kelvin Asset Class objects.
|
|
488
|
+
* @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.
|
|
489
|
+
* @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.
|
|
490
|
+
* @param sortBy Sort the results by one of the Kelvin Asset Class 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`. The default is `asset_class.name`
|
|
491
|
+
* @param sortAsc Sorting order for the results.</p> There are two options; `true` (ascending order) and `false` (descending order). The default is true (ascending).
|
|
492
|
+
* @param owner Filter Kelvin Asset Class by owner.</p> There are two types of owners; `custom` (any user) or `kelvin` (core kelvin asset class).
|
|
493
|
+
* @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>
|
|
486
494
|
* @param {IKvHttpRequestOptions} options Request optional parameters
|
|
487
495
|
*/
|
|
488
496
|
static listAssetClass({ search, pageSize, startingAfter, endingBefore, sortBy, sortAsc, owner, entityTypeName } = {}, options) {
|
|
@@ -614,7 +622,7 @@ class AssetService extends base_service_1.BaseService {
|
|
|
614
622
|
}
|
|
615
623
|
/**
|
|
616
624
|
* List Asset Type
|
|
617
|
-
* 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`
|
|
625
|
+
* List Asset Type Returns a filtered list of all <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type\" target=\"_blank\">Kelvin Asset Types</a> on the Kelvin Platform. 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 Types</a> returned in alphabetical order by the unique identifier 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`
|
|
618
626
|
* @param search Search asset type by name or title
|
|
619
627
|
* @param assetClassName Filter asset type by asset class
|
|
620
628
|
* @param metadata Inject metadata into the response
|
|
@@ -773,9 +781,9 @@ class AssetService extends base_service_1.BaseService {
|
|
|
773
781
|
}
|
|
774
782
|
/**
|
|
775
783
|
* Update Asset Class
|
|
776
|
-
* Update Asset Class **Permission Required:** `kelvin.permission.asset_class.update`
|
|
784
|
+
* 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.</p> 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.</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-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`
|
|
777
785
|
* @param assetClass AssetClass update schema
|
|
778
|
-
* @param assetClassName Asset Class
|
|
786
|
+
* @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>.
|
|
779
787
|
* @param {IKvHttpRequestOptions} options Request optional parameters
|
|
780
788
|
*/
|
|
781
789
|
static updateAssetClass({ assetClass, assetClassName }, options) {
|