RICADO Gen 4 API JS Client

RICADO Gen 4 API JS Client

Class

FruitProfileController

Controller Class for Fruit Profiles

Constructor

new FruitProfileController()

Source

Methods

static

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

Create a Fruit Profile [POST /lab/sites/{siteId}/fruit-profiles]

Parameters

  • siteId number

    The Site ID

  • createData FruitProfileController.CreateData

    The Fruit Profile Create Data

Returns

  • Promise.<FruitProfileModel>

Source

static

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

Delete a Fruit Profile [DELETE /lab/sites/{siteId}/fruit-profiles/{id}]

Parameters

  • siteId number

    The Site ID

  • id string

    The Fruit Profile ID

Returns

  • Promise.<boolean>

Source

static

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

List all Fruit Profiles [GET /lab/sites/{siteId}/fruit-profiles]

Parameters

  • siteId number

    The Site ID

  • queryParameters FruitProfileController.GetAllQueryParameters <optional>

    The Optional Query Parameters

Returns

  • Promise.<Array.<FruitProfileModel>>

Source

static

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

Retrieve a Fruit Profile [GET /lab/sites/{siteId}/fruit-profiles/{id}]

Parameters

  • siteId number

    The Site ID

  • id string

    The Fruit Profile ID

Returns

  • Promise.<FruitProfileModel>

Source

static

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

Update a Fruit Profile [PATCH /lab/sites/{siteId}/fruit-profiles/{id}]

Parameters

  • siteId number

    The Site ID

  • id string

    The Fruit Profile ID

  • updateData FruitProfileController.UpdateData

    The Fruit Profile Update Data

Returns

  • Promise.<FruitProfileModel>

Source

Type Definitions

CreateData

The Create Data for a Fruit Profile

Type

  • Object

Properties

  • name string

    The Fruit Profile Name

  • description string <optional>

    The Fruit Profile Description

  • image string <optional>

    The Fruit Profile Image Source

  • nominalWarmUpDuration number

    The Typical Warm Up Duration (in seconds) for a Sample to reach the Minimum Target Temperature

  • minimumWithinTargetDuration number

    The Minimum Duration (in seconds) that a Sample should be within the Min and Max Target Temperatures to be Compliant

  • minimumTotalDuration number

    The Minimum Duration (in seconds) that a Sample must be Dehydrated for to be Compliant

  • maximumTotalDuration number

    The Maximum Duration (in seconds) that a Sample can be Dehydrated for before it is Considered Non-Compliant

  • minimumTargetTemperature number

    The Minimum Target Temperature for a Sample to be Compliant

  • maximumTargetTemperature number

    The Maximum Target Temperature for a Sample to be Compliant

  • warmUpStartExpectedTemperature number

    The Warm-Up Temperature for starting the Warm Up alerts

  • warmUpStartExpectedRateOfChange number

    The Warm-Up Start Expected Rate of Change: the minimum Temperature rise in Degrees Celsius over the trailing 10 minute window expected once the Sample reaches the Start Expected Temperature. A Warm Up Warning is raised when the measured Rate of Change falls below the Expected Rate for the current stage

  • warmUpStageTwoExpectedTemperature number

    The Warm-Up Stage Two Expected Temperature

  • warmUpStageTwoExpectedRateOfChange number

    The Warm-Up Stage Two Expected Rate of Change: the minimum Temperature rise in Degrees Celsius over the trailing 10 minute window expected once the Sample reaches the Stage Two Expected Temperature

  • warmUpStageThreeExpectedTemperature number

    The Warm-Up Stage Three Expected Temperature

  • warmUpStageThreeExpectedRateOfChange number

    The Warm-Up Stage Three Expected Rate of Change: the minimum Temperature rise in Degrees Celsius over the trailing 10 minute window expected once the Sample reaches the Stage Three Expected Temperature

  • warmUpEndExpectedTemperature number

    The Warm-Up End Expected Temperature

  • warmUpEndExpectedRateOfChange number

    The Warm-Up End Expected Rate of Change: the minimum Temperature rise in Degrees Celsius over the trailing 10 minute window expected once the Sample reaches the End Expected Temperature

Source

UpdateData

The Update Data for a Fruit Profile

Type

  • Object

Properties

  • name string <optional>

    The Fruit Profile Name

  • description string <optional>

    The Fruit Profile Description

  • image string <optional>

    The Fruit Profile Image Source

  • nominalWarmUpDuration number <optional>

    The Typical Warm Up Duration (in seconds) for a Sample to reach the Minimum Target Temperature

  • minimumWithinTargetDuration number <optional>

    The Minimum Duration (in seconds) that a Sample should be within the Min and Max Target Temperatures to be Compliant

  • minimumTotalDuration number <optional>

    The Minimum Duration (in seconds) that a Sample must be Dehydrated for to be Compliant

  • maximumTotalDuration number <optional>

    The Maximum Duration (in seconds) that a Sample can be Dehydrated for before it is Considered Non-Compliant

  • minimumTargetTemperature number <optional>

    The Minimum Target Temperature for a Sample to be Compliant

  • maximumTargetTemperature number <optional>

    The Maximum Target Temperature for a Sample to be Compliant

  • warmUpStartExpectedTemperature number <optional>

    The Warm-Up Temperature for starting the Warm Up alerts

  • warmUpStartExpectedRateOfChange number <optional>

    The Warm-Up Start Expected Rate of Change: the minimum Temperature rise in Degrees Celsius over the trailing 10 minute window expected once the Sample reaches the Start Expected Temperature. A Warm Up Warning is raised when the measured Rate of Change falls below the Expected Rate for the current stage

  • warmUpStageTwoExpectedTemperature number <optional>

    The Warm-Up Stage Two Expected Temperature

  • warmUpStageTwoExpectedRateOfChange number <optional>

    The Warm-Up Stage Two Expected Rate of Change: the minimum Temperature rise in Degrees Celsius over the trailing 10 minute window expected once the Sample reaches the Stage Two Expected Temperature

  • warmUpStageThreeExpectedTemperature number <optional>

    The Warm-Up Stage Three Expected Temperature

  • warmUpStageThreeExpectedRateOfChange number <optional>

    The Warm-Up Stage Three Expected Rate of Change: the minimum Temperature rise in Degrees Celsius over the trailing 10 minute window expected once the Sample reaches the Stage Three Expected Temperature

  • warmUpEndExpectedTemperature number <optional>

    The Warm-Up End Expected Temperature

  • warmUpEndExpectedRateOfChange number <optional>

    The Warm-Up End Expected Rate of Change: the minimum Temperature rise in Degrees Celsius over the trailing 10 minute window expected once the Sample reaches the End Expected Temperature

Source