__namedParameters: { asset: IAssetCreateWithParentData; dryRun: boolean }

• asset: IAssetCreateWithParentData

  Asset create schema

• dryRun: boolean

  Perform a trial run to create the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/&#39; 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/&#39; target='_blank'>Kelvin Asset</a> structure without making any changes on the Kelvin Platform.

Optional options: IKvHttpRequestOptions

__namedParameters: { assetClass: IAssetClassCreateData }

• assetClass: IAssetClassCreateData

  Asset Class Create Parameters

Optional options: IKvHttpRequestOptions

__namedParameters: { assetTemplate: IAssetTemplateCreateData }

• assetTemplate: IAssetTemplateCreateData

  Asset Template create schema

Optional options: IKvHttpRequestOptions

__namedParameters: { assettype: IAssetTypeCreateData }

• assettype: IAssetTypeCreateData

  Asset Type create schema

Optional options: IKvHttpRequestOptions

__namedParameters: { assetTypeName: string; assettypemetadata: IAssetTypeMetadataCreateData }

• assetTypeName: string

  Unique identifier name of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type&#39; 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&#39; 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.

• assettypemetadata: IAssetTypeMetadataCreateData

  Asset Type Metadata create schema

Optional options: IKvHttpRequestOptions

__namedParameters: { assetName: string }

• assetName: string

  <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/&#39; 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/&#39; 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.

Optional options: IKvHttpRequestOptions

__namedParameters: { assetClassName: string }

• assetClassName: string

  <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class&#39; 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&#39; 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.

Optional options: IKvHttpRequestOptions

__namedParameters: { assetTemplateName: string }

• assetTemplateName: string

  <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#kelvin-templates&#39; 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&#39; target='_blank'>Kelvin Template</a>.

Optional options: IKvHttpRequestOptions

__namedParameters: { assetTypeName: string }

• assetTypeName: string

  <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type&#39; 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&#39; target='_blank'>Kelvin Asset Type</a>.

Optional options: IKvHttpRequestOptions

__namedParameters: { assetTypeMetadataName: string; assetTypeName: string }

• assetTypeMetadataName: string

  <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets#asset-type-metadata&#39; 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.

• assetTypeName: string

  <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type&#39; 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&#39; 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.

Optional options: IKvHttpRequestOptions

__namedParameters: { assetName: string; metadata: string[] }

• assetName: string

  <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/&#39; 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/&#39; 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.

• metadata: string[]

  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/&#39; 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/&#39; 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&#39; target='_blank'>Kelvin Asset Type</a>.

Optional options: IKvHttpRequestOptions

__namedParameters: { assetClassName: string }

• assetClassName: string

  <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class&#39; 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&#39; 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.

Optional options: IKvHttpRequestOptions

Optional options: IKvHttpRequestOptions

__namedParameters: { assetName: string; assetTypeDepth: string; entityTypeDepth: string }

• assetName: string

  Unique identifier name of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/&#39; target='blank'>Kelvin Asset</a> to retrieve the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-hierarchy&#39; 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.

• assetTypeDepth: string

  Sets the start asset type depth in which the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-hierarchy&#39; target='_blank'>hierarchy</a> is returned. Only valid when entity_type_depth = group

• entityTypeDepth: string

  Sets the start entity type depth in which the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-hierarchy&#39; target='_blank'>hierarchy</a> is returned.

Optional options: IKvHttpRequestOptions

__namedParameters: { assetNames: IAssetOEEGetData; timestamp: string }

• assetNames: IAssetOEEGetData

  Asset OEE get schema

• timestamp: string

  Timestamp to search for specific <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/&#39; target='_blank'>Kelvin Assets</a> related <a href='https://docs.kelvininc.com/latest/documentation/kelvin-maps/kelvin-maps-asset-details/#performance-details&#39; 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.

Optional options: IKvHttpRequestOptions

__namedParameters: { asset: IAssetStatisticsData; endingBefore: string; pageSize: number; sortAsc: boolean; sortBy: string; startingAfter: string }

• asset: IAssetStatisticsData

  Asset statistics schema

• endingBefore: string

  An alphanumeric string to move to the previous page of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/&#39; 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.

• pageSize: number

  Number of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/&#39; 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.

• sortAsc: boolean

  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).

• sortBy: string

  Sort the results by one of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/&#39; 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`

• startingAfter: string

  An alphanumeric string to move to the next page of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/&#39; 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.

Optional options: IKvHttpRequestOptions

Optional options: IKvHttpRequestOptions

Optional options: IKvHttpRequestOptions

__namedParameters: { assetTemplateName: string }

• assetTemplateName: string

  <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#kelvin-templates&#39; 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&#39; 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.

Optional options: IKvHttpRequestOptions

__namedParameters: { assetTypeName: string; metadata: string[] }

• assetTypeName: string

  <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type&#39; 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&#39; 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.

• metadata: string[]

  Array of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets#asset-type-metadata&#39; 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&#39; 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&#39; 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&#39; 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&#39; 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&#39; 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&#39; target='_blank'>Kelvin Asset Type</a>.

Optional options: IKvHttpRequestOptions

__namedParameters: { assetTypeMetadataName: string; assetTypeName: string }

• assetTypeMetadataName: string

  <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets#asset-type-metadata&#39; 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.

• assetTypeName: string

  <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type&#39; 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&#39; 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.

Optional options: IKvHttpRequestOptions

Default value __namedParameters: { assetTypeName: string[]; endingBefore: string; entityTypeName: string[]; map: string; names: string[]; pageSize: number; properties: string[]; propertiesFilter: string[]; search: string[]; sortAsc: boolean; sortBy: string; startingAfter: string; statusState: string[] } = {}

• assetTypeName: string[]

  Filter on the parameter <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type&#39; 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&#39; target='_blank'>Kelvin Asset Type</a> with the name `pump` but not with the names `pumps` or `centrifugal-fan`.

• endingBefore: string

  An alphanumeric string to move to the previous page of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/&#39; 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.

• entityTypeName: string[]

  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>

• map: string

  Filter for assets that belong to the map

• names: string[]

  Filter on the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/&#39; 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/&#39; target='_blank'>Kelvin Asset</a> with the name `pump` but not with the names `pumps` or `centrifugal-fan`.

• pageSize: number

  Number of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/&#39; 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&#39; target='_blank'>Kelvin Asset</a> objects.

• properties: string[]

  Only returns specified properties in each <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/&#39; 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/&#39; 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/&#39; 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/&#39; 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/&#39; target='_blank'>Kelvin Assets</a>on the <a href='https://docs.kelvininc.com/latest/kelvin-overview/overview/#kelvin-platform&#39; 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/&#39; target='_blank'>Kelvin Assets</a>.

• propertiesFilter: string[]

  Filter <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/&#39; 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.

• search: string[]

  Search and filter the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/&#39; 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&#39; 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`.

• sortAsc: boolean

  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).

• sortBy: string

  Sort the results by one of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/&#39; 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`

• startingAfter: string

  An alphanumeric string to move to the next page of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/&#39; 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.

• statusState: string[]

  Filter <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/&#39; 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`.

Optional options: IKvHttpRequestOptions

Default value __namedParameters: { endingBefore: string; entityTypeName: string[]; owner: string; pageSize: number; search: string[]; sortAsc: boolean; sortBy: string; startingAfter: string } = {}

• endingBefore: string

  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&#39; 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.

• entityTypeName: string[]

  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&#39; 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&#39; 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&#39; target='_blank'>Entity Type</a> name options.</p>

• owner: string

  Filter <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class&#39; 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&#39; target='_blank'>Kelvin Asset Class</a>).</p> The default will select all owner options.

• pageSize: number

  Number of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class&#39; 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&#39; target='_blank'>Kelvin Asset Class</a> objects.

• search: string[]

  Search and filter the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class&#39; 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&#39; target='_blank'>Kelvin Asset Class</a> name is `centrifugal_pump`, then a match will be made if the search string is `pum` or `FUGaL`.

• sortAsc: boolean

  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).

• sortBy: string

  Sort the results by one of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class&#39; 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`

• startingAfter: string

  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&#39; 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.

Optional options: IKvHttpRequestOptions

__namedParameters: { assetDatastreams: IAssetDataStreamsListData; assetName: string; endingBefore: string; pageSize: number; sortAsc: boolean; sortBy: string; startingAfter: string }

• assetDatastreams: IAssetDataStreamsListData

  Asset Data Streams list schema

• assetName: string

  Unique identifier name of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/&#39; 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.

• endingBefore: string

  An alphanumeric string to move to the previous page of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/&#39; target='_blank'>Kelvin Asset</a> / <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics&#39; 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.

• pageSize: number

  Number of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/&#39; target='_blank'>Kelvin Asset</a> / <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics&#39; 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.

• sortAsc: boolean

  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).

• sortBy: string

  Sort the results by one of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/&#39; target='_blank'>Kelvin Asset</a> / <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics&#39; 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`

• startingAfter: string

  An alphanumeric string to move to the next page of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/&#39; target='_blank'>Kelvin Asset</a> / <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics&#39; 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.

Optional options: IKvHttpRequestOptions

Default value __namedParameters: { assetClassNames: string[]; assetTypeNames: string[]; endingBefore: string; entityTypeNames: string[]; owner: string; pageSize: number; search: string[]; sortAsc: boolean; sortBy: string; startingAfter: string } = {}

• assetClassNames: string[]

  Filter on the parameter <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class&#39; 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&#39; target='_blank'>Kelvin Asset Class</a> with the name `pump` but not with the names `pumps` or `centrifugal-fan`.

• assetTypeNames: string[]

  Filter on the parameter <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type&#39; 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&#39; target='_blank'>Kelvin Asset Class</a> with the name `pump` but not with the names `pumps` or `centrifugal-fan`.

• endingBefore: string

  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&#39; 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.

• entityTypeNames: string[]

  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>

• owner: string

  Filter <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#kelvin-templates&#39; target='_blank'>Kelvin Templates</a> by owner.</p> There are two types of owners; `custom` (any user) or `kelvin` (core kelvin).

• pageSize: number

  Number of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#kelvin-templates&#39; 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.

• search: string[]

  Search and filter the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#kelvin-templates&#39; 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`.

• sortAsc: boolean

  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).

• sortBy: string

  Sort the results by one of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#kelvin-templates&#39; 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`

• startingAfter: string

  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&#39; 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.

Optional options: IKvHttpRequestOptions

Default value __namedParameters: { assetClassName: string[]; endingBefore: string; entityTypeName: string[]; metadata: string[]; metadataFilter: string[]; owner: string; pageSize: number; search: string[]; sortAsc: boolean; sortBy: string; startingAfter: string } = {}

• assetClassName: string[]

  Filter on the parameter <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class&#39; 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&#39; target='_blank'>Kelvin Asset Class</a> with the name `pump` but not with the names `pumps` or `centrifugal-fan`.

• endingBefore: string

  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&#39; 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.

• entityTypeName: string[]

  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>

• metadata: string[]

  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&#39; target='_blank'>Kelvin Asset Types</a> that are linked to any of the Kelvin Asset Type Metadata name(s) in this list.

• metadataFilter: string[]

  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.

• owner: string

  Filter <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type&#39; 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.

• pageSize: number

  Number of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type&#39; 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.

• search: string[]

  Search and filter the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type&#39; 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`.

• sortAsc: boolean

  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).

• sortBy: string

  Sort the results by one of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type&#39; 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`

• startingAfter: string

  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&#39; 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.

Optional options: IKvHttpRequestOptions

__namedParameters: { assetTypeName: string; endingBefore: string; pageSize: number; search: string[]; sortAsc: boolean; sortBy: string; startingAfter: string }

• assetTypeName: string

  <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type&#39; 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&#39; 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&#39; 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&#39; target='_blank'>Kelvin Asset Type Metadata</a> associated with the name `big-pump` but not with the names `pump` or `big-pump-machine`.

• endingBefore: string

  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&#39; 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.

• pageSize: number

  Number of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets#asset-type-metadata&#39; 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&#39; target='_blank'>Kelvin Asset Type Metadata</a> objects.

• search: string[]

  Search and filter the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets#asset-type-metadata&#39; 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`.

• sortAsc: boolean

  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).

• sortBy: string

  Sort the results by one of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets#asset-type-metadata&#39; 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`

• startingAfter: string

  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&#39; 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.

Optional options: IKvHttpRequestOptions

__namedParameters: { asset: IFailureOverviewData; direction: "asc" | "desc"; next: string; page: number; pageSize: number; paginationType: "limits" | "cursor" | "stream"; previous: string; sortBy: string[] }

• asset: IFailureOverviewData

  Failure Overview schema

• direction: "asc" | "desc"

  Direction in which to sort the data

• next: string

  Retrieve next page. Only valid for type=cursor pagination

• page: number

  Desired page. Only valid for type=limits pagination

• pageSize: number

  Desired page size

• paginationType: "limits" | "cursor" | "stream"

  Desired pagination type

• previous: string

  Retrieve previous page. Only valid for type=cursor pagination

• sortBy: string[]

  Columns by which to sort the data

Optional options: IKvHttpRequestOptions

__namedParameters: { asset: IAssetUpdateData; assetName: string; dryRun: boolean }

• asset: IAssetUpdateData

  Asset update schema

• assetName: string

  <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-groups&#39; target='_blank'>Kelvin Asset Group</a> or a <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset&#39; 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&#39; target='_blank'>Kelvin Asset</a> is below the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-groups&#39; target='_blank'>Kelvin Asset Group</a>, the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset&#39; 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/&#39; target='_blank'>Kelvin Asset</a>.

• dryRun: boolean

  Perform a trial run to update the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/&#39; 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/&#39; target='_blank'>Kelvin Assets</a> structure without making any changes on the Kelvin Platform.

Optional options: IKvHttpRequestOptions

__namedParameters: { assetClass: IAssetClassUpdateData; assetClassName: string }

• assetClass: IAssetClassUpdateData

  AssetClass update schema

• assetClassName: string

  <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class&#39; 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&#39; 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.

Optional options: IKvHttpRequestOptions

__namedParameters: { dryRun: boolean; hierarchy: IHierarchyUpdateData }

• dryRun: boolean

  Perform a trial run to update the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/&#39; 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/&#39; target='_blank'>Kelvin Assets</a> structure without making any changes on the Kelvin Platform.

• hierarchy: IHierarchyUpdateData

  Asset Hierarchy update schema

Optional options: IKvHttpRequestOptions

__namedParameters: { assetTemplate: IAssetTemplateUpdateData; assetTemplateName: string }

• assetTemplate: IAssetTemplateUpdateData

  Asset Template update schema

• assetTemplateName: string

  <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#kelvin-templates&#39; 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&#39; target='_blank'>Kelvin Template</a>.

Optional options: IKvHttpRequestOptions

__namedParameters: { assetTypeName: string; assettype: IAssetTypeUpdateData }

• assetTypeName: string

  <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type&#39; 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&#39; 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.

• assettype: IAssetTypeUpdateData

  AssetType update schema

Optional options: IKvHttpRequestOptions

__namedParameters: { assetTypeMetadataName: string; assetTypeName: string; assettypemetadata: IAssetTypeMetadataUpdateData }

• assetTypeMetadataName: string

  <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets#asset-type-metadata&#39; 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.

• assetTypeName: string

  Unique identifier name of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type&#39; 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.

• assettypemetadata: IAssetTypeMetadataUpdateData

  Asset Type Metadata update schema

Optional options: IKvHttpRequestOptions

__namedParameters: { dryRun: boolean; file: Blob }

• dryRun: boolean

  Perform a trial run to create the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/&#39; 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/&#39; target='_blank'>Kelvin Asset</a> structure without making any changes on the <a href='https://docs.kelvininc.com/latest/kelvin-overview/overview/#kelvin-platform&#39; target='_blank'>Kelvin Platform</a>.

• file: Blob

  Path and name of the CSV File to upload to the <a href='https://docs.kelvininc.com/latest/kelvin-overview/overview/#kelvin-platform&#39; 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/&#39; 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&#39; target='_blank'>Kelvin Documentation</a>.

Optional options: IKvHttpRequestOptions