Options
All
  • Public
  • Public/Protected
  • All
Menu

Class InventoryService

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

binary

binary: InventoryBinaryService

queriesUtil

queriesUtil: QueriesUtil

Methods

assetKPIsList

  • assetKPIsList(parentReference: IdReference, filter?: object): Object

  • Parameters

    • parentReference: IdReference
    • Default value filter: object = {}

    Returns Object

    Response wrapped in IResultList

childAdditionsAdd

  • Parameters

    Returns Object

    Response wrapped in IResult

childAdditionsCreate

  • Parameters

    Returns Object

    Response wrapped in IResult

childAdditionsList

  • childAdditionsList(parentReference: IdReference, filter?: object): Object

  • Parameters

    • parentReference: IdReference
    • Default value filter: object = {}

    Returns Object

    Response wrapped in IResultList

childAdditionsRemove

  • Parameters

    Returns Object

    Response wrapped in IResult

childAssetsAdd

  • Parameters

    Returns Object

    Response wrapped in IResult

childAssetsBulkAdd

  • Parameters

    Returns Object

    Response wrapped in array of IResult

childAssetsCreate

  • Parameters

    Returns Object

    Response wrapped in IResult

childAssetsList

  • childAssetsList(parentReference: IdReference, filter?: object): Object

  • Parameters

    • parentReference: IdReference
    • Default value filter: object = {}

    Returns Object

    Response wrapped in IResultList

childAssetsRemove

  • Parameters

    Returns Object

    Response wrapped in IResult

childDevicesAdd

  • Parameters

    Returns Object

    Response wrapped in IResult

childDevicesCreate

  • Parameters

    Returns Object

    Response wrapped in IResult

childDevicesList

  • childDevicesList(parentReference: IdReference, filter?: object): Object

  • Parameters

    • parentReference: IdReference
    • Default value filter: object = {}

    Returns Object

    Response wrapped in IResultList

childDevicesRemove

  • Parameters

    Returns Object

    Response wrapped in IResult

create

  • Parameters

    Returns Object

    Response wrapped in IResult

    Example

    
 const partialManagedObj: Partial<IManagedObject> = {
   customFragment: 'yourData'
 };

 (async () => {
   const {data, res} = await inventoryService.create(partialManagedObj);
 })();

delete

  • delete(managedObjectOrId: IdReference, params?: any): Object

  • Parameters

    • managedObjectOrId: IdReference
    • Default value params: any = {}

    Returns Object

    Response wrapped in IResult

detail

  • detail(managedObjectOrId: IdReference, filter?: object): Object

  • Parameters

    • managedObjectOrId: IdReference
    • Default value filter: object = {}

    Returns Object

    Response wrapped in IResult

    Example

    
   const managedObjId: number = 1;
   const filter = { withChildren: false };

   (async () => {
     const {data, res} = await inventoryService.detail(managedObjId, filter);
  })();

getMeasurementsAndSeries

  • getMeasurementsAndSeries(managedObjectOrId: IdReference): Promise<Array<object>>

  • Parameters

    Returns Promise<Array<object>>

    array of supported measurement series and fragments

getSupportedMeasurements

  • getSupportedMeasurements(managedObjectOrId: IdReference): Promise<string[]>

  • Parameters

    Returns Promise<string[]>

    array of supported measurement fragments

getSupportedSeries

  • getSupportedSeries(managedObjectOrId: IdReference): Promise<string[]>

  • Parameters

    Returns Promise<string[]>

    array of supported measurement series

list

  • list(filter?: object): Object

  • Parameters

    • Default value filter: object = {}

    Returns Object

    Response wrapped in IResultList

listQuery

  • listQuery(query: any, filter?: object): Object

  • Parameters

    • query: any
    • Default value filter: object = {}

    Returns Object

    Response wrapped in IResultList

listQueryDevices

  • listQueryDevices(query: any, filter?: object): Object

  • Parameters

    • query: any
    • Default value filter: object = {}

    Returns Object

    Response wrapped in IResultList

update

  • Parameters

    Returns Object

    Response wrapped in IResult

    Example

    
 const partialUpdateObject: Partial<IManagedObject> = {
   customFragment: 'Changed data',
   name: 'Name'
 };

 (async () => {
   const {data, res} = await inventoryService.update(partialUpdateObject);
 })();

Generated using TypeDoc