MapService | Kelvin SDK Client Library Reference

Hierarchy

BaseService
- MapService

Index

Methods

Static createMap

createMap(__namedParameters: { map: IMapCreateData }, options?: IKvHttpRequestOptions): Observable<MapModel>

Create Map Create Map Permission Required: `kelvin.permission.maps.create`

Parameters
- __namedParameters: { map: IMapCreateData }
  - map: IMapCreateData
    
    Map create schema
- Optional options: IKvHttpRequestOptions
  
  Request optional parameters
Returns Observable<MapModel>

Static createMapOEE

createMapOEE(__namedParameters: { mapName: string; mapOee: IMapOEECreateData }, options?: IKvHttpRequestOptions): Observable<MapOEE>

Create Map OEE Create Map OEE Permission Required: `kelvin.permission.maps.create`

Parameters
- __namedParameters: { mapName: string; mapOee: IMapOEECreateData }
  - mapName: string
    
    Map name
  - mapOee: IMapOEECreateData
    
    Map OEE create schema
- Optional options: IKvHttpRequestOptions
  
  Request optional parameters
Returns Observable<MapOEE>

Static createMapShift

createMapShift(__namedParameters: { mapName: string; mapShift: IMapShiftCreateData }, options?: IKvHttpRequestOptions): Observable<MapShift>

Create Map Shift Create Map Shift Permission Required: `kelvin.permission.maps.create`

Parameters
- __namedParameters: { mapName: string; mapShift: IMapShiftCreateData }
  - mapName: string
    
    Map name
  - mapShift: IMapShiftCreateData
    
    Map Shift create schema
- Optional options: IKvHttpRequestOptions
  
  Request optional parameters
Returns Observable<MapShift>

Static createSymbol

createSymbol(__namedParameters: { symbol: ISymbolCreateData }, options?: IKvHttpRequestOptions): Observable<Symbol>

Create Symbol Create Symbol Permission Required: `kelvin.permission.maps.create`

Parameters
- __namedParameters: { symbol: ISymbolCreateData }
  - symbol: ISymbolCreateData
    
    Symbol create schema
- Optional options: IKvHttpRequestOptions
  
  Request optional parameters
Returns Observable<Symbol>

Static deleteMap

deleteMap(__namedParameters: { mapName: string }, options?: IKvHttpRequestOptions): Observable<IKvHttpResponse>

Delete Map Delete Map Permission Required: `kelvin.permission.maps.delete`

Parameters
- __namedParameters: { mapName: string }
  - mapName: string
    
    Map name
- Optional options: IKvHttpRequestOptions
  
  Request optional parameters
Returns Observable<IKvHttpResponse>

Static deleteSymbol

deleteSymbol(__namedParameters: { symbolName: string }, options?: IKvHttpRequestOptions): Observable<IKvHttpResponse>

Delete Symbol Delete Symbol Permission Required: `kelvin.permission.maps.delete`

Parameters
- __namedParameters: { symbolName: string }
  - symbolName: string
    
    Symbol name
- Optional options: IKvHttpRequestOptions
  
  Request optional parameters
Returns Observable<IKvHttpResponse>

Static getMap

getMap(__namedParameters: { mapName: string; timestamp: string }, options?: IKvHttpRequestOptions): Observable<MapModel>

Get Map Get Map Permission Required: `kelvin.permission.maps.read`

Parameters
- __namedParameters: { mapName: string; timestamp: string }
  - mapName: string
    
    Map name
  - timestamp: string
    
    Timestamp to search for a specific version (supports RFC3339 and Unix timestamps with nanosecond precision)
- Optional options: IKvHttpRequestOptions
  
  Request optional parameters
Returns Observable<MapModel>

Static getMapOEE

getMapOEE(__namedParameters: { mapNames: IMapOEEGetData; timestamp: string }, options?: IKvHttpRequestOptions): Observable<MapOEE[]>

Get Map OEE Get Map OEE Permission Required: `kelvin.permission.maps.read`

Parameters
- __namedParameters: { mapNames: IMapOEEGetData; timestamp: string }
  - mapNames: IMapOEEGetData
    
    Map OEE get schema
  - timestamp: string
    
    Timestamp to search for specific OEE values for a given point in time (supports RFC3339 and Unix timestamps with nanosecond precision)
- Optional options: IKvHttpRequestOptions
  
  Request optional parameters
Returns Observable<MapOEE[]>

Static getMapShift

getMapShift(__namedParameters: { mapNames: IMapShiftGetData; timestamp: string }, options?: IKvHttpRequestOptions): Observable<MapShift[]>

Get Map Shift Get Map Shift Permission Required: `kelvin.permission.maps.read`

Parameters
- __namedParameters: { mapNames: IMapShiftGetData; timestamp: string }
  - mapNames: IMapShiftGetData
    
    Map Shift get schema
  - timestamp: string
    
    Timestamp to search for specific Shift values for a given point in time (supports RFC3339 and Unix timestamps with nanosecond precision)
- Optional options: IKvHttpRequestOptions
  
  Request optional parameters
Returns Observable<MapShift[]>

Static getPaginator

getPaginator<T>(request: Observable<IPaginatedRequest<T>>): KvPaginator<T>

Inherited from BaseService.getPaginator

Type parameters
- T: Model
Parameters
- request: Observable<IPaginatedRequest<T>>
Returns KvPaginator<T>

Static listMaps

listMaps(__namedParameters?: { assetName: string; endingBefore: string; entity: string; mode: string; pageSize: number; sortAsc: boolean; sortBy: string; startingAfter: string; timestamp: string }, options?: IKvHttpRequestOptions): Observable<MapListPaginated>

List Maps List Maps Pagination Sortable Columns: `map.name`, `map.title`, `start_date`, `mode`, `map.asset_name` Permission Required: `kelvin.permission.maps.read`

Parameters
- Default value __namedParameters: { assetName: string; endingBefore: string; entity: string; mode: string; pageSize: number; sortAsc: boolean; sortBy: string; startingAfter: string; timestamp: string } = {}
  - assetName: string
    
    Filter for maps that exist in the context of an asset name
  - endingBefore: string
    
    Upper bound cursor for use in pagination
  - entity: string
    
    Filter for maps that contain the entity
  - mode: string
    
    Filter maps by mode. Possible Values: production/simulation
  - 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
  - timestamp: string
    
    Timestamp to search for a specific version (supports RFC3339 and Unix timestamps with nanosecond precision)
- Optional options: IKvHttpRequestOptions
  
  Request optional parameters
Returns Observable<MapListPaginated>

Static listSymbols

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

List Symbols List Symbols Pagination Sortable Columns: `symbol.name`, `symbol.title`, `symbol.symbol_type` Permission Required: `kelvin.permission.maps.read`

Parameters
- Default value __namedParameters: { endingBefore: string; pageSize: number; search: string[]; sortAsc: boolean; sortBy: string; startingAfter: string; symbolTypes: 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 symbols 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
  - symbolTypes: string[]
    
    Search symbols by symbol type
- Optional options: IKvHttpRequestOptions
  
  Request optional parameters
Returns Observable<SymbolsListPaginated>

Static listVersions

listVersions(__namedParameters: { endingBefore: string; mapName: string; pageSize: number; sortAsc: boolean; sortBy: string; startingAfter: string }, options?: IKvHttpRequestOptions): Observable<MapVersionListPaginated>

List Versions List Versions for a single map Pagination Sortable Columns: `start_date` Permission Required: `kelvin.permission.maps.read`

Parameters
- __namedParameters: { endingBefore: string; mapName: string; pageSize: number; sortAsc: boolean; sortBy: string; startingAfter: string }
  - endingBefore: string
    
    Upper bound cursor for use in pagination
  - mapName: string
    
    Map name
  - 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<MapVersionListPaginated>

Static onError

onError(): Observable<IKvHttpResponse>

Inherited from BaseService.onError

Returns Observable<IKvHttpResponse>

Static request

request<T>(endpoint: string, request: IKvHttpRequest, modelClass?: IModel): Observable<T>

Inherited from BaseService.request

Type parameters
- T
Parameters
- endpoint: string
- request: IKvHttpRequest
- Optional modelClass: IModel
Returns Observable<T>

Static requestUrl

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

Inherited from BaseService.requestUrl

Type parameters
- T
Parameters
- request: IKvHttpRequest
- Optional modelClass: IModel
- Default value autenticated: boolean = false
Returns Observable<T>

Static updateMap

updateMap(__namedParameters: { map: IMapUpdateData; mapName: string }, options?: IKvHttpRequestOptions): Observable<MapModel>

Update Map Update Map Permission Required: `kelvin.permission.maps.update`

Parameters
- __namedParameters: { map: IMapUpdateData; mapName: string }
  - map: IMapUpdateData
    
    Map update schema
  - mapName: string
    
    Map name
- Optional options: IKvHttpRequestOptions
  
  Request optional parameters
Returns Observable<MapModel>

Static updateSymbol

updateSymbol(__namedParameters: { symbol: ISymbolUpdateData; symbolName: string }, options?: IKvHttpRequestOptions): Observable<Symbol>

Update Symbol Update Symbol Permission Required: `kelvin.permission.maps.update`

Parameters
- __namedParameters: { symbol: ISymbolUpdateData; symbolName: string }
  - symbol: ISymbolUpdateData
    
    Symbol update schema
  - symbolName: string
    
    Symbol name
- Optional options: IKvHttpRequestOptions
  
  Request optional parameters
Returns Observable<Symbol>

Hierarchy

Index

Methods

Methods

Static createMap

Parameters

__namedParameters: { map: IMapCreateData }

map: IMapCreateData

Optional options: IKvHttpRequestOptions

Returns Observable<MapModel>

Static createMapOEE

Parameters

__namedParameters: { mapName: string; mapOee: IMapOEECreateData }

mapName: string

mapOee: IMapOEECreateData

Optional options: IKvHttpRequestOptions

Returns Observable<MapOEE>

Static createMapShift

Parameters

__namedParameters: { mapName: string; mapShift: IMapShiftCreateData }

mapName: string

mapShift: IMapShiftCreateData

Optional options: IKvHttpRequestOptions

Returns Observable<MapShift>

Static createSymbol

Parameters

__namedParameters: { symbol: ISymbolCreateData }

symbol: ISymbolCreateData

Optional options: IKvHttpRequestOptions

Returns Observable<Symbol>

Static deleteMap

Parameters

__namedParameters: { mapName: string }

mapName: string

Optional options: IKvHttpRequestOptions

Returns Observable<IKvHttpResponse>

Static deleteSymbol

Parameters

__namedParameters: { symbolName: string }

symbolName: string

Optional options: IKvHttpRequestOptions

Returns Observable<IKvHttpResponse>

Static getMap

Parameters

__namedParameters: { mapName: string; timestamp: string }

mapName: string

timestamp: string

Optional options: IKvHttpRequestOptions

Returns Observable<MapModel>

Static getMapOEE

Parameters

__namedParameters: { mapNames: IMapOEEGetData; timestamp: string }

mapNames: IMapOEEGetData

timestamp: string

Optional options: IKvHttpRequestOptions

Returns Observable<MapOEE[]>

Static getMapShift

Parameters

__namedParameters: { mapNames: IMapShiftGetData; timestamp: string }

mapNames: IMapShiftGetData

timestamp: string

Optional options: IKvHttpRequestOptions

Returns Observable<MapShift[]>

Static getPaginator

Type parameters

T: Model

Parameters

request: Observable<IPaginatedRequest<T>>

Returns KvPaginator<T>

Static listMaps

Parameters

Default value __namedParameters: { assetName: string; endingBefore: string; entity: string; mode: string; pageSize: number; sortAsc: boolean; sortBy: string; startingAfter: string; timestamp: string } = {}

assetName: string

endingBefore: string

entity: string

mode: string

pageSize: number

sortAsc: boolean

sortBy: string

startingAfter: string