RICADO Gen 4 API JS Client

RICADO Gen 4 API JS Client

Class

DehydratorController

Controller Class for Dehydrators

Constructor

new DehydratorController()

Source

Methods

static

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

Create a Dehydrator [POST /lab/sites/{siteId}/dehydrators]

Parameters

  • siteId number

    The Site ID

  • createData DehydratorController.CreateData

    The Dehydrator Create Data

Returns

  • Promise.<DehydratorModel>

Source

static

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

Delete a Dehydrator [DELETE /lab/sites/{siteId}/dehydrators/{id}]

Parameters

  • siteId number

    The Site ID

  • id string

    The Dehydrator ID

Returns

  • Promise.<boolean>

Source

static

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

List all Dehydrators [GET /lab/sites/{siteId}/dehydrators]

Parameters

  • siteId number

    The Site ID

  • queryParameters DehydratorController.GetAllQueryParameters <optional>

    The Optional Query Parameters

Returns

  • Promise.<Array.<DehydratorModel>>

Source

static

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

Retrieve a Dehydrator [GET /lab/sites/{siteId}/dehydrators/{id}]

Parameters

  • siteId number

    The Site ID

  • id string

    The Dehydrator ID

Returns

  • Promise.<DehydratorModel>

Source

static

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

Update a Dehydrator [PATCH /lab/sites/{siteId}/dehydrators/{id}]

Parameters

  • siteId number

    The Site ID

  • id string

    The Dehydrator ID

  • updateData DehydratorController.UpdateData

    The Dehydrator Update Data

Returns

  • Promise.<DehydratorModel>

Source

Type Definitions

CreateData

The Create Data for a Dehydrator

Type

  • Object

Properties

  • rtuId number <optional>
    <nullable>

    The RTU this Dehydrator belongs to

  • name string

    The Name of this Dehydrator

  • points Object

    The Points used by this Dehydrator

  • labId string

    The Lab that owns this Dehydrator

Source

GetAllQueryParameters

The Optional Query Parameters for the getAll Function

Type

  • Object

Properties

  • rtuId number <optional>
    <nullable>

    The RTU this Dehydrator belongs to

  • name string <optional>

    The Name of this Dehydrator

  • labId string <optional>

    The Lab that owns this Dehydrator

Source

UpdateData

The Update Data for a Dehydrator

Type

  • Object

Properties

  • name string <optional>

    The Name of this Dehydrator

  • points Object <optional>

    The Points used by this Dehydrator

  • labId string <optional>

    The Lab that owns this Dehydrator

Source