RICADO Gen 4 API JS Client

RICADO Gen 4 API JS Client

Class

RackPositionController

Controller Class for Rack Positions

Constructor

new RackPositionController()

Source

Methods

static

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

Create a Rack Position [POST /lab/sites/{siteId}/rack-positions]

Parameters

  • siteId number

    The Site ID

  • createData RackPositionController.CreateData

    The Rack Position Create Data

Returns

  • Promise.<RackPositionModel>

Source

static

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

Delete a Rack Position [DELETE /lab/sites/{siteId}/rack-positions/{id}]

Parameters

  • siteId number

    The Site ID

  • id string

    The Rack Position ID

Returns

  • Promise.<boolean>

Source

static

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

List all Rack Positions [GET /lab/sites/{siteId}/rack-positions]

Parameters

  • siteId number

    The Site ID

  • queryParameters RackPositionController.GetAllQueryParameters <optional>

    The Optional Query Parameters

Returns

  • Promise.<Array.<RackPositionModel>>

Source

static

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

Retrieve a Rack Position [GET /lab/sites/{siteId}/rack-positions/{id}]

Parameters

  • siteId number

    The Site ID

  • id string

    The Rack Position ID

Returns

  • Promise.<RackPositionModel>

Source

static

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

Update a Rack Position [PATCH /lab/sites/{siteId}/rack-positions/{id}]

Parameters

  • siteId number

    The Site ID

  • id string

    The Rack Position ID

  • updateData RackPositionController.UpdateData

    The Rack Position Update Data

Returns

  • Promise.<RackPositionModel>

Source

Type Definitions

CreateData

The Create Data for a Rack Position

Type

  • Object

Properties

  • rtuId number <optional>
    <nullable>

    The RTU this Rack Position belongs to

  • name string

    The Name of this Rack Position

  • points Object

    The Points used by this Rack Position

  • labId string

    The Lab that owns this Rack Position

  • rackId string

    The Rack associated with this Rack Position

  • verticalLevelIndex number

    The Index of the Vertical Level in the Rack where this Position resides

  • horizontalPositionIndex number

    The Index of the Horizontal Position in the Rack where this Position resides

Source

GetAllQueryParameters

The Optional Query Parameters for the getAll Function

Type

  • Object

Properties

  • rtuId number <optional>
    <nullable>

    The RTU this Rack Position belongs to

  • name string <optional>

    The Name of this Rack Position

  • labId string <optional>

    The Lab that owns this Rack Position

  • rackId string <optional>

    The Rack associated with this Rack Position

  • verticalLevelIndex number <optional>

    The Index of the Vertical Level in the Rack where this Position resides

  • horizontalPositionIndex number <optional>

    The Index of the Horizontal Position in the Rack where this Position resides

Source

UpdateData

The Update Data for a Rack Position

Type

  • Object

Properties

  • name string <optional>

    The Name of this Rack Position

  • points Object <optional>

    The Points used by this Rack Position

  • labId string <optional>

    The Lab that owns this Rack Position

  • rackId string <optional>

    The Rack associated with this Rack Position

  • verticalLevelIndex number <optional>

    The Index of the Vertical Level in the Rack where this Position resides

  • horizontalPositionIndex number <optional>

    The Index of the Horizontal Position in the Rack where this Position resides

Source