RICADO Gen 4 API JS Client

RICADO Gen 4 API JS Client

Class

LabController

Controller Class for Labs

Constructor

new LabController()

Source

Methods

static

create(siteId, createData) → {Promise.<LabModel>}

Create a Lab [POST /lab/sites/{siteId}/labs]

Parameters

  • siteId number

    The Site ID

  • createData LabController.CreateData

    The Lab Create Data

Returns

  • Promise.<LabModel>

Source

static

delete(siteId, id) → {Promise.<boolean>}

Delete a Lab [DELETE /lab/sites/{siteId}/labs/{id}]

Parameters

  • siteId number

    The Site ID

  • id string

    The Lab ID

Returns

  • Promise.<boolean>

Source

static

getAll(siteId, queryParametersopt) → {Promise.<Array.<LabModel>>}

List all Labs [GET /lab/sites/{siteId}/labs]

Parameters

  • siteId number

    The Site ID

  • queryParameters LabController.GetAllQueryParameters <optional>

    The Optional Query Parameters

Returns

  • Promise.<Array.<LabModel>>

Source

static

getOne(siteId, id) → {Promise.<LabModel>}

Retrieve a Lab [GET /lab/sites/{siteId}/labs/{id}]

Parameters

  • siteId number

    The Site ID

  • id string

    The Lab ID

Returns

  • Promise.<LabModel>

Source

static

update(siteId, id, updateData) → {Promise.<LabModel>}

Update a Lab [PATCH /lab/sites/{siteId}/labs/{id}]

Parameters

  • siteId number

    The Site ID

  • id string

    The Lab ID

  • updateData LabController.UpdateData

    The Lab Update Data

Returns

  • Promise.<LabModel>

Source

Type Definitions

CreateData

The Create Data for a Lab

Type

  • Object

Properties

  • rtuId number <optional>
    <nullable>

    The RTU this Lab belongs to

  • name string

    The Lab Name

  • shortName string <optional>

    A Short Name for the Lab Name. Typically used in Reports and Tables showing multiple Labs

  • points Object

    The Points used by this Lab

  • racks Array.<LabController.RackReference> <optional>

    The Rack Objects that belong to this Lab

  • alarmGroups Array.<string> <optional>

    The Alarm Groups that are used by this Lab

  • inspectIntegration LabController.InspectIntegration <optional>
    <nullable>

    The Inspect Integration Configuration for this Lab

Source

GetAllQueryParameters

The Optional Query Parameters for the getAll Function

Type

  • Object

Properties

  • rtuId number <optional>
    <nullable>

    The RTU this Lab belongs to

  • name string <optional>

    The Lab Name

Source

InspectIntegration

A InspectIntegration Type

Type

  • Object

Properties

  • points Object

    The Points used for this Inspect Integration

  • enabled boolean

    Whether the Inspect Integration is Enabled on this Lab

  • labName string

    Name of the Lab referenced by Inspect

  • sqlServerHost string

    Host of the Inspect SQL Server

  • sqlServerUsername string

    Username for Authentication with the Inspect SQL Server

  • sqlServerPassword string

    Password for Authentication with the Inspect SQL Server

Source

UpdateData

The Update Data for a Lab

Type

  • Object

Properties

  • name string <optional>

    The Lab Name

  • shortName string <optional>

    A Short Name for the Lab Name. Typically used in Reports and Tables showing multiple Labs

  • points Object <optional>

    The Points used by this Lab

  • racks Array.<LabController.RackReference> <optional>

    The Rack Objects that belong to this Lab

  • alarmGroups Array.<string> <optional>

    The Alarm Groups that are used by this Lab

  • inspectIntegration LabController.InspectIntegration <optional>
    <nullable>

    The Inspect Integration Configuration for this Lab

Source