Kelvin SDK Client Library Reference

Hierarchy

Index

Methods

Methods

Static getEmissionsDashboard

  • Get Emissions Dashboard Get Emissions Dashboard endpoint that will provide the data to be presented in the maps/emissions dashboard Permission Required: `kelvin.permission.ui.read`

    Parameters

    • __namedParameters: { groupName: string }
      • groupName: string

        The assets group name filter

    • Optional options: IKvHttpRequestOptions

      Request optional parameters

    Returns Observable<EmissionsDashboard>

Static getPaginator

Static listProcesses

  • List Processes List Processes Pagination Sortable Columns: `map.name`, `map.title`, `start_date`, `mode`, `map.asset_name` Permission Required: `kelvin.permission.ui.read`

    Parameters

    • __namedParameters: { endingBefore: string; pageSize: number; processes: IProcessesListData; 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

      • processes: IProcessesListData

        Processes list schema

      • 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<FullMapListPaginated>

Static onError

Static request

Static requestUrl

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