RICADO Gen 4 API JS Client

RICADO Gen 4 API JS Client

Class

RackController

Controller Class for Racks

Constructor

new RackController()

Source

Methods

static

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

Create a Rack [POST /lab/sites/{siteId}/racks]

Parameters

  • siteId number

    The Site ID

  • createData RackController.CreateData

    The Rack Create Data

Returns

  • Promise.<RackModel>

Source

static

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

Delete a Rack [DELETE /lab/sites/{siteId}/racks/{id}]

Parameters

  • siteId number

    The Site ID

  • id string

    The Rack ID

Returns

  • Promise.<boolean>

Source

static

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

List all Racks [GET /lab/sites/{siteId}/racks]

Parameters

  • siteId number

    The Site ID

  • queryParameters RackController.GetAllQueryParameters <optional>

    The Optional Query Parameters

Returns

  • Promise.<Array.<RackModel>>

Source

static

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

Retrieve a Rack [GET /lab/sites/{siteId}/racks/{id}]

Parameters

  • siteId number

    The Site ID

  • id string

    The Rack ID

Returns

  • Promise.<RackModel>

Source

static

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

Update a Rack [PATCH /lab/sites/{siteId}/racks/{id}]

Parameters

  • siteId number

    The Site ID

  • id string

    The Rack ID

  • updateData RackController.UpdateData

    The Rack Update Data

Returns

  • Promise.<RackModel>

Source

Type Definitions

CreateData

The Create Data for a Rack

Type

  • Object

Properties

  • rtuId number <optional>
    <nullable>

    The RTU this Rack belongs to

  • name string

    The Name of this Rack

  • points Object

    The Points used by this Rack

  • labId string

    The Lab that owns this Rack

  • verticalLevels Array.<RackController.VerticalLevel> <optional>

    The Vertical Levels Defined for this Rack

  • invertVerticalLevels boolean <optional>

    Whether the Vertical Levels for this Rack should be Inverted. By Default, Vertical Levels go from the Lowest Level upwards

  • horizontalPositions Array.<RackController.HorizontalPosition> <optional>

    The Horizontal Positions defined for this Rack

  • invertHorizontalPositions boolean <optional>

    Whether the Horizontal Positions for this Rack should be Inverted. By Default, Horizontal Positions go from Left to Right

Source

GetAllQueryParameters

The Optional Query Parameters for the getAll Function

Type

  • Object

Properties

  • rtuId number <optional>
    <nullable>

    The RTU this Rack belongs to

  • name string <optional>

    The Name of this Rack

  • labId string <optional>

    The Lab that owns this Rack

Source

UpdateData

The Update Data for a Rack

Type

  • Object

Properties

  • name string <optional>

    The Name of this Rack

  • points Object <optional>

    The Points used by this Rack

  • labId string <optional>

    The Lab that owns this Rack

  • verticalLevels Array.<RackController.VerticalLevel> <optional>

    The Vertical Levels Defined for this Rack

  • invertVerticalLevels boolean <optional>

    Whether the Vertical Levels for this Rack should be Inverted. By Default, Vertical Levels go from the Lowest Level upwards

  • horizontalPositions Array.<RackController.HorizontalPosition> <optional>

    The Horizontal Positions defined for this Rack

  • invertHorizontalPositions boolean <optional>

    Whether the Horizontal Positions for this Rack should be Inverted. By Default, Horizontal Positions go from Left to Right

Source