RICADO Gen 4 API JS Client

RICADO Gen 4 API JS Client

Class

ProbeCalibrationController

Controller Class for Probe Calibrations

Constructor

new ProbeCalibrationController()

Source

Methods

static

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

Create a Probe Calibration [POST /lab/sites/{siteId}/probe-calibrations]

Parameters

  • siteId number

    The Site ID

  • createData ProbeCalibrationController.CreateData

    The Probe Calibration Create Data

Returns

  • Promise.<ProbeCalibrationModel>

Source

static

createComment(siteId, id, content) → {Promise.<ProbeCalibrationController.CommentItem>}

Create a Comment [POST /lab/sites/{siteId}/probe-calibrations/{id}/comments]

Create a Comment for a Probe Calibration

Parameters

  • siteId number

    The Site ID

  • id string

    The Probe Calibration ID

  • content string

    The Content of the New Comment

Returns

  • Promise.<ProbeCalibrationController.CommentItem>

Source

static

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

Delete a Probe Calibration [DELETE /lab/sites/{siteId}/probe-calibrations/{id}]

Parameters

  • siteId number

    The Site ID

  • id string

    The Probe Calibration ID

Returns

  • Promise.<boolean>

Source

static

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

Delete a Comment [DELETE /lab/sites/{siteId}/probe-calibrations/{id}/comments/{commentId}]

Delete a Comment for a Probe Calibration

Parameters

  • siteId number

    The Site ID

  • id string

    The Probe Calibration ID

  • commentId string

    The Comment ID

Returns

  • Promise.<boolean>

Source

static

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

List all Probe Calibrations [GET /lab/sites/{siteId}/probe-calibrations]

Parameters

  • siteId number

    The Site ID

  • queryParameters ProbeCalibrationController.GetAllQueryParameters <optional>

    The Optional Query Parameters

Returns

  • Promise.<Array.<ProbeCalibrationModel>>

Source

static

getComments(siteId, id) → {Promise.<Array.<ProbeCalibrationController.CommentItem>>}

Retrieve Comments [GET /lab/sites/{siteId}/probe-calibrations/{id}/comments]

Retrieves Comments for a Probe Calibration

Parameters

  • siteId number

    The Site ID

  • id string

    The Probe Calibration ID

Returns

  • Promise.<Array.<ProbeCalibrationController.CommentItem>>

Source

static

getLatestProbeCalibrations(siteId) → {Promise.<Array.<ProbeCalibrationModel>>}

Retrieve the Latest Probe Calibrations [GET /lab/sites/{siteId}/probe-calibrations/latest]

Retrieves the Latest Probe Calibrations for all Rack Positions

Parameters

  • siteId number

    The Site ID

Returns

  • Promise.<Array.<ProbeCalibrationModel>>

Source

static

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

Retrieve a Probe Calibration [GET /lab/sites/{siteId}/probe-calibrations/{id}]

Parameters

  • siteId number

    The Site ID

  • id string

    The Probe Calibration ID

Returns

  • Promise.<ProbeCalibrationModel>

Source

static

getOneComment(siteId, id, commentId) → {Promise.<ProbeCalibrationController.CommentItem>}

Retrieve a Comment [GET /lab/sites/{siteId}/probe-calibrations/{id}/comments/{commentId}]

Retrieves Comments for a Probe Calibration

Parameters

  • siteId number

    The Site ID

  • id string

    The Probe Calibration ID

  • commentId string

    The Comment ID

Returns

  • Promise.<ProbeCalibrationController.CommentItem>

Source

static

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

Update a Probe Calibration [PATCH /lab/sites/{siteId}/probe-calibrations/{id}]

Parameters

  • siteId number

    The Site ID

  • id string

    The Probe Calibration ID

  • updateData ProbeCalibrationController.UpdateData

    The Probe Calibration Update Data

Returns

  • Promise.<ProbeCalibrationModel>

Source

static

updateOneComment(siteId, id, commentId, content) → {Promise.<ProbeCalibrationController.CommentItem>}

Update a Comment [PATCH /lab/sites/{siteId}/probe-calibrations/{id}/comments/{commentId}]

Update a Comment for a Probe Calibration

Parameters

  • siteId number

    The Site ID

  • id string

    The Probe Calibration ID

  • commentId string

    The Comment ID

  • content string

    The Updated Content for the Comment

Returns

  • Promise.<ProbeCalibrationController.CommentItem>

Source

Type Definitions

CommentItem

A CommentItem Type

Type

  • Object

Properties

  • id string

    The Comment ID

  • userAccount ProbeCalibrationController.UserAccount
  • content string <nullable>

    The Content of the Comment

  • createdTimestamp Date <nullable>

    When the Comment was Created

  • updatedTimestamp Date <nullable>

    When the Comment was last Updated

Source

CreateData

The Create Data for a Probe Calibration

Type

  • Object

Properties

  • rackPositionId string

    The Rack Position ID this Probe Calibration is associated with

  • createdTimestamp Date <optional>

    When this Probe Calibration was Created

  • userId string

    ID of the User who Completed this Probe Calibration

  • userName string

    Name of the User who Completed this Probe Calibration

  • preCalibrationOffset number

    The Calibration Offset prior to this Probe Calibration being Created

  • postCalibrationOffset number

    The Calibration Offset after this Probe Calibration was Created

  • preCalibrationTemperature number

    The Temperature Probe reading prior to this Probe Calibration being Created

  • postCalibrationTemperature number

    The Temperature Probe reading after this Probe Calibration was Created

Source

GetAllQueryParameters

The Optional Query Parameters for the getAll Function

Type

  • Object

Properties

  • rackPositionId string <optional>

    The Rack Position ID this Probe Calibration is associated with

  • userId string <optional>

    ID of the User who Completed this Probe Calibration

  • userName string <optional>

    Name of the User who Completed this Probe Calibration

  • createdTimestampBegin Date <optional>

    Filter by the Timestamp when Probe Calibrations were Created. Results Greater than or Equal to Timestamp

  • createdTimestampEnd Date <optional>

    Filter by the Timestamp when Probe Calibrations were Created. Results Less than or Equal to Timestamp

  • updateTimestampBegin Date <optional>

    Filter by the Timestamp when Probe Calibrations were last Updated. Results Greater than or Equal to Timestamp

  • updateTimestampEnd Date <optional>

    Filter by the Timestamp when Probe Calibrations were last Updated. Results Less than or Equal to Timestamp

Source

UpdateData

The Update Data for a Probe Calibration

Type

  • Object

Properties

  • rackPositionId string <optional>

    The Rack Position ID this Probe Calibration is associated with

  • createdTimestamp Date <optional>

    When this Probe Calibration was Created

  • userId string <optional>

    ID of the User who Completed this Probe Calibration

  • userName string <optional>

    Name of the User who Completed this Probe Calibration

  • preCalibrationOffset number <optional>

    The Calibration Offset prior to this Probe Calibration being Created

  • postCalibrationOffset number <optional>

    The Calibration Offset after this Probe Calibration was Created

  • preCalibrationTemperature number <optional>

    The Temperature Probe reading prior to this Probe Calibration being Created

  • postCalibrationTemperature number <optional>

    The Temperature Probe reading after this Probe Calibration was Created

Source