Kelvin SDK Client Library Reference

Hierarchy

Index

Methods

Methods

Static createAlarm

  • Create Alarm Create Alarm. The alarm is associated with an asset (Kelvin Asset, Kelvin Component, Kelvin Part or Kelvin Sensor). The asset(s) that trigger the alarm (source) does not need to be the same asset (target) that the alarm is associated with. The source asset can be more than one asset. Permission Required: `kelvin.permission.alarm.create`

    Parameters

    Returns Observable<Alarm>

Static createAlarmClass

Static createAlarmFilter

Static createAlarmType

Static createTag

Static deleteAlarm

  • Delete Alarm Delete Alarm Permission Required: `kelvin.permission.alarm.delete`

    Parameters

    • __namedParameters: { alarmId: string }
      • alarmId: string

        Alarm UUID

    • Optional options: IKvHttpRequestOptions

      Request optional parameters

    Returns Observable<IKvHttpResponse>

Static deleteAlarmClass

  • Delete Alarm Class Delete Alarm Class Permission Required: `kelvin.permission.alarm_class.delete`

    Parameters

    • __namedParameters: { alarmClassName: string }
      • alarmClassName: string

        Alarm Class Name

    • Optional options: IKvHttpRequestOptions

      Request optional parameters

    Returns Observable<IKvHttpResponse>

Static deleteAlarmFilter

  • Delete Alarm Filter Delete Alarm Filter Permission Required: `kelvin.permission.alarm_filter.delete`

    Parameters

    • __namedParameters: { alarmFilterId: string }
      • alarmFilterId: string

        Alarm Filter id

    • Optional options: IKvHttpRequestOptions

      Request optional parameters

    Returns Observable<IKvHttpResponse>

Static deleteAlarmType

  • Delete Alarm Type Delete Alarm Type Permission Required: `kelvin.permission.alarm_type.delete`

    Parameters

    • __namedParameters: { alarmTypeName: string }
      • alarmTypeName: string

        Alarm Type name

    • Optional options: IKvHttpRequestOptions

      Request optional parameters

    Returns Observable<IKvHttpResponse>

Static deleteTag

  • Delete Tag Delete Tag Permission Required: `kelvin.permission.alarm.delete`

    Parameters

    • __namedParameters: { tagName: string }
      • tagName: string

        Tag name

    • Optional options: IKvHttpRequestOptions

      Request optional parameters

    Returns Observable<IKvHttpResponse>

Static getAlarm

  • Get Alarm Get Alarm Permission Required: `kelvin.permission.alarm.read`

    Parameters

    • __namedParameters: { alarmId: string }
      • alarmId: string

        Alarm UUID

    • Optional options: IKvHttpRequestOptions

      Request optional parameters

    Returns Observable<Alarm>

Static getAlarmClass

  • Get Alarm Class Get Alarm Class Permission Required: `kelvin.permission.alarm_class.read`

    Parameters

    • __namedParameters: { alarmClassName: string }
      • alarmClassName: string

        Alarm Class Name

    • Optional options: IKvHttpRequestOptions

      Request optional parameters

    Returns Observable<AlarmClass>

Static getAlarmClustering

Static getAlarmFilter

  • Get Alarm Filter Get Alarm Filter Permission Required: `kelvin.permission.alarm_filter.read`

    Parameters

    • __namedParameters: { alarmFilterId: string; metadata: string[] }
      • alarmFilterId: string

        Alarm Filter ID

      • metadata: string[]

        Inject metadata into the response

    • Optional options: IKvHttpRequestOptions

      Request optional parameters

    Returns Observable<AlarmFilter>

Static getAlarmSeverities

  • Get Alarm Severities Get Alarm Severities Permission Required: `kelvin.permission.alarm_severity.read`

    Parameters

    Returns Observable<AlarmSeverityList>

Static getAlarmType

  • Get Alarm Type Get Alarm Type Permission Required: `kelvin.permission.alarm_type.read`

    Parameters

    • __namedParameters: { alarmTypeName: string }
      • alarmTypeName: string

        Alarm Type name

    • Optional options: IKvHttpRequestOptions

      Request optional parameters

    Returns Observable<AlarmType>

Static getAssetAlarmStatistics

  • Get Asset Alarm Statistics Get Asset Alarm Statistics Permission Required: `kelvin.permission.alarm.read`

    Parameters

    • Default value __namedParameters: { assetIncludeChildren: boolean; assetNames: string[] } = {}
      • assetIncludeChildren: boolean

        Include children statistics. Default: false

      • assetNames: string[]

        Filter by asset_names

    • Optional options: IKvHttpRequestOptions

      Request optional parameters

    Returns Observable<AlarmAssetsStatistics>

Static getPaginator

Static getStatistics

Static getTag

  • Get Tag Get Tag Permission Required: `kelvin.permission.alarm.read`

    Parameters

    • __namedParameters: { tagName: string }
      • tagName: string

        Tag name

    • Optional options: IKvHttpRequestOptions

      Request optional parameters

    Returns Observable<AlarmTag>

Static listAlarmClass

  • listAlarmClass(__namedParameters?: { endingBefore: string; owner: string; pageSize: number; search: string[]; sortAsc: boolean; sortBy: string; startingAfter: string }, options?: IKvHttpRequestOptions): Observable<AlarmClassListPaginated>

  • List Alarm Class List Alarm Class Pagination Sortable Columns: `alarm_class.name`, `alarm_class.title`, `alarm_class.created`, `alarm_class.updated`, `alarm_class.owner` Permission Required: `kelvin.permission.alarm_class.read`

    Parameters

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

        Upper bound cursor for use in pagination

      • owner: string

        Filter Alarm Class by owner. Possible Values: kelvin/custom

      • pageSize: number

        Number of objects to be returned, between 1 and 1000. Default: 20

      • search: string[]

        Search Alarm Class by name or title

      • sortAsc: boolean

        Order of sorting is Ascending. Possible Values: true/false. Default: true

      • sortBy: string

        Parameter to sort by. Must be one of the sortable columns

      • startingAfter: string

        Lower bound cursor for use in pagination

    • Optional options: IKvHttpRequestOptions

      Request optional parameters

    Returns Observable<AlarmClassListPaginated>

Static listAlarmFilter

  • listAlarmFilter(__namedParameters?: { alarmClassName: string[]; endingBefore: string; pageSize: number; search: string[]; sortAsc: boolean; sortBy: string; startingAfter: string }, options?: IKvHttpRequestOptions): Observable<AlarmFilterListPaginated>

  • List Alarm Filter List Alarm Filter Pagination Sortable Columns: `alarm_filter.title`, `alarm_filter.username`, `alarm_filter.version`, `alarm_filter.created`, `alarm_filter.updated` Permission Required: `kelvin.permission.alarm_filter.read`

    Parameters

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

        Filter alarm filter by alarm class

      • endingBefore: string

        Upper bound cursor for use in pagination

      • pageSize: number

        Number of objects to be returned, between 1 and 1000. Default: 20

      • search: string[]

        Search alarm filter by title or version

      • sortAsc: boolean

        Order of sorting is Ascending. Possible Values: true/false. Default: true

      • sortBy: string

        Parameter to sort by. Must be one of the sortable columns

      • startingAfter: string

        Lower bound cursor for use in pagination

    • Optional options: IKvHttpRequestOptions

      Request optional parameters

    Returns Observable<AlarmFilterListPaginated>

Static listAlarmType

  • listAlarmType(__namedParameters?: { alarmClassName: string[]; endingBefore: string; owner: string; pageSize: number; search: string[]; sortAsc: boolean; sortBy: string; startingAfter: string }, options?: IKvHttpRequestOptions): Observable<AlarmTypeListPaginated>

  • List Alarm Type List Alarm Type Pagination Sortable Columns: `alarm_type.name`, `alarm_type.title`, `alarm_type.created`, `alarm_type.updated`, `alarm_class.name`, `alarm_class.title`, `alarm_type.owner` Permission Required: `kelvin.permission.alarm_type.read`

    Parameters

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

        Filter alarm type by alarm class

      • endingBefore: string

        Upper bound cursor for use in pagination

      • owner: string

        Filter Alarm Type by owner. Possible Values: kelvin/custom

      • pageSize: number

        Number of objects to be returned, between 1 and 1000. Default: 20

      • search: string[]

        Search alarm type by name or title

      • sortAsc: boolean

        Order of sorting is Ascending. Possible Values: true/false. Default: true

      • sortBy: string

        Parameter to sort by. Must be one of the sortable columns

      • startingAfter: string

        Lower bound cursor for use in pagination

    • Optional options: IKvHttpRequestOptions

      Request optional parameters

    Returns Observable<AlarmTypeListPaginated>

Static listAlarms

  • List Alarms List Alarms Pagination Sortable Columns: `alarm.id`, `alarm.title`, `alarm.alarm_type_name`, `alarm.asset_name`, `alarm.status`, `alarm.severity`, `alarm.created`, `alarm.updated`, `alarm.acknowledged_by`, `alarm.acknowledged_at`, `alarm.resolved_at`, `alarm.resolved_by`, `asset_type.name`, `asset_class.name`, `alarm_class.name`, `alarm_class.title`, `alarm_type.title`, `asset_class.title`, `asset_type.title`, `asset.title`, `alarm_severity.name`, `alarm_severity.title` Permission Required: `kelvin.permission.alarm.read`

    Parameters

    • __namedParameters: { alarm: IAlarmListData; endingBefore: string; pageSize: number; sortAsc: boolean; sortBy: string; startingAfter: string }
      • alarm: IAlarmListData

        Alarm list schema

      • endingBefore: string

        Upper bound cursor for use in pagination

      • pageSize: number

        Number of objects to be returned, between 1 and 1000. Default: 20

      • sortAsc: boolean

        Order of sorting is Ascending. Possible Values: true/false. Default: true

      • sortBy: string

        Parameter to sort by. Must be one of the sortable columns

      • startingAfter: string

        Lower bound cursor for use in pagination

    • Optional options: IKvHttpRequestOptions

      Request optional parameters

    Returns Observable<AlarmListPaginated>

Static listTags

  • listTags(__namedParameters?: { endingBefore: string; pageSize: number; search: string[]; sortAsc: boolean; sortBy: string; startingAfter: string }, options?: IKvHttpRequestOptions): Observable<AlarmTagListPaginated>

  • List Tags List Tags Pagination Sortable Columns: `tag.name`, `tag.title` Permission Required: `kelvin.permission.alarm.read`

    Parameters

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

        Upper bound cursor for use in pagination

      • pageSize: number

        Number of objects to be returned, between 1 and 1000. Default: 20

      • search: string[]

        Search tags by name or title

      • sortAsc: boolean

        Order of sorting is Ascending. Possible Values: true/false. Default: true

      • sortBy: string

        Parameter to sort by. Must be one of the sortable columns

      • startingAfter: string

        Lower bound cursor for use in pagination

    • Optional options: IKvHttpRequestOptions

      Request optional parameters

    Returns Observable<AlarmTagListPaginated>

Static onError

Static request

Static requestUrl

  • requestUrl<T>(request: IKvHttpRequest, modelClass?: IModel, autenticated?: boolean): Observable<T>

Static update

  • Update Update Alarm Permission Required: `kelvin.permission.alarm.update`

    Parameters

    Returns Observable<Alarm>

Static updateAlarmClass

  • Update Alarm Class Update Alarm Class Permission Required: `kelvin.permission.alarm_class.update`

    Parameters

    Returns Observable<AlarmClass>

Static updateAlarmFilter

  • Update Alarm Filter Update Alarm Filter Permission Required: `kelvin.permission.alarm_filter.update`

    Parameters

    Returns Observable<AlarmFilter>

Static updateAlarmSeverities

Static updateAlarmType

  • Update Alarm Type Update Alarm Type Permission Required: `kelvin.permission.alarm_type.update`

    Parameters

    Returns Observable<AlarmType>

Static updateStatus

Static updateTag