Hierarchy

Index

Constructors

constructor

Properties

assetClassEntityTypeName

assetClassEntityTypeName: string

Unique identifier name of the entity type linked to the <a href="https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class\" target="_blank">Kelvin Asset Class. This is the chosen name from a fixed list defined by Kelvin.

assetClassEntityTypeTitle

assetClassEntityTypeTitle: string

Display name of the entity type linked to the <a href="https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class\" target="_blank">Kelvin Asset Class. This is the chosen display name (title) from a fixed list defined by Kelvin.

assetClassName

assetClassName: string

Unique identifier name of the <a href="https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class\" target="_blank">Kelvin Asset Class that is linked to this new <a href="https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type\" target="_blank">Kelvin Asset Type.

assetClassTitle

assetClassTitle: string

Display name of the <a href="https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class\" target="_blank">Kelvin Asset Class that is linked to this new <a href="https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type\" target="_blank">Kelvin Asset Type.

created

created: Date

Time of creation of this <a href="https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type\" target="_blank">Kelvin Asset Type in ISO 8601 UTC date/time format. Example; "2022-07-08T08:41:01.657916Z".

metadata

metadata: any

Custom dictionary keys/values returned for use by clients.

This Kelvin Asset Type Metadata object is created using the API endpoint /assets/types/{asset_type_name}/metadata/ and is linked to the <a href="https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type\" target="_blank">Kelvin Asset Type. So anytime the <a href="https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type\" target="_blank">Kelvin Asset Type is referenced in responses the metadata will also be included.

name

name: string

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.

owner

owner: string

Who created the <a href="https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type\" target="_blank">Kelvin Asset Type. 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-type\" target="_blank">Kelvin Asset Type).

title

title: string

Display name (title) of the <a href="https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type\" target="_blank">Kelvin Asset Type.

updated

updated: Date

Time of modifying any variable of this <a href="https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type\" target="_blank">Kelvin Asset Type in ISO 8601 UTC date/time format. Example; "2022-07-08T08:41:01.657916Z".

Methods

clone

getClass

  • getClass(): Function

mapping

  • mapping(): {}

serializeArray

  • serializeArray(obj: any[]): Object

serializeObject

  • serializeObject(obj: any): any

serializeObjectInstance

  • serializeObjectInstance(obj: Object): Object

stringify

  • stringify(): string

toJSONObject

  • toJSONObject(): Object