__namedParameters: { metric: IMetricCreateData }

• metric: IMetricCreateData

  Metric create schema

Optional options: IKvHttpRequestOptions

__namedParameters: { metricName: string }

• metricName: string

  Unique identifier name for the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/&#39; target='blank'>Kelvin Metric</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: { metricName: string }

• metricName: string

  Unique identifier name for the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/&#39; target='blank'>Kelvin Metric</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: { dataTypeName: string[]; dataTypeVersion: string[]; endingBefore: string; names: string[]; pageSize: number; search: string[]; semanticTypeName: string[]; sortAsc: boolean; sortBy: string; startingAfter: string } = {}

• dataTypeName: string[]

  Array of data type names to filter the list. Each string will only return a Data Type Type object with exact matches on the `name` parameter.</p> There are 13 types of data type options; `raw.boolean`, `raw.dynacard`, `raw.float32`, `raw.float64`, `raw.int8`, `raw.int16`, `raw.int32`, `raw.int64`, `raw.uint8`, `raw.uint16`, `raw.uint32`, `raw.uint64` and `raw.text`.

• dataTypeVersion: string[]

  Array of data type versions to filter the list. Each string will only return a Data Type Type object with exact matches on the `name` parameter.</p> For example; `2.0.0` will return results, but `2.0` will not.

• endingBefore: string

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

• names: string[]

  Filter on the parameter <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/&#39; target='blank'>Kelvin Metric</a> by its name. This is given as an array, for example `[extruder,tank]`.</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 `[extruder,tank]` will return <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/&#39; target='_blank'>Kelvin Metric</a> with the name `extruder` but not with the names `demo-ch-extruder-gear-setpoint` or `demo-og-gas-tank-level`.

• pageSize: number

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

• search: string[]

  Search and filter the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/&#39; target='_blank'>Kelvin Metric</a> list. Both the Display Name and the Name will be included in the filter field criteria. This is given as an array, for example `[extruder,tank]`.</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-metrics/&#39; target='_blank'>Kelvin Metric</a> name or display name is `demo-og-centrifugal-pump-speed`, then a match will be made if the filter string is `demo` or `FUGaL`.

• semanticTypeName: string[]

  Array of names to filter the list. Each string will only return a Sematic Type object with exact matches on the `name` parameter.</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.

• 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-metrics/&#39; target='_blank'>Kelvin Metric</a> parameters. Only one parameter can be selected.</p> There are ten parameter options; `metric.name`, `metric.title`, `metric.data_type_name`, `metric.data_type_version`, `metric.display_unit`, `metric.semantic_type_name`, `metric.write`, `metric.created`, `metric.updated` and `semantic_type.title`.</p> The default is `metric.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-metrics/&#39; target='_blank'>Kelvin Metrics</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: { names: string[]; search: string[]; sortAsc: boolean; sortBy: string } = {}

• names: string[]

  Array of names to filter the list. Each string will only return a Sematic Type object with exact matches on the `name` parameter.</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.

• search: string[]

  Search and filter the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/&#39; target='_blank'>Kelvin Metric</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 `[accelerometer,event]`.</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-metrics/&#39; target='_blank'>Kelvin Metric</a> name or display name is `Accelerometer`, then a match will be made if the search string is `acc` or `rOmeT`.

• 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-metrics/&#39; target='_blank'>Kelvin Metric</a> parameters. Only one parameter can be selected.</p> There are four parameter options; `semantic_type.name`, `semantic_type.title`, `semantic_type.created`, `semantic_type.updated`.</p> The default is `semantic_type.name`

Optional options: IKvHttpRequestOptions

__namedParameters: { metric: IMetricUpdateData; metricName: string }

• metric: IMetricUpdateData

  Metric update schema

• metricName: string

  Unique identifier name for the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/&#39; target='blank'>Kelvin Metric</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; file: Blob }

• dryRun: boolean

  Perform a trial run to create the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/&#39; target='_blank'>Kelvin Metrics</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-metrics/&#39; target='_blank'>Kelvin Metrics</a> bulk upload 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-metrics-csv-template&#39; target='_blank'>Kelvin Documentation</a>.

Optional options: IKvHttpRequestOptions