RICADO Gen 4 API JS Client

RICADO Gen 4 API JS Client

Class

SampleController

Controller Class for Samples

Constructor

new SampleController()

Source

Methods

static

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

Create a Sample [POST /lab/sites/{siteId}/samples]

Parameters

  • siteId number

    The Site ID

  • createData SampleController.CreateData

    The Sample Create Data

Returns

  • Promise.<SampleModel>

Source

static

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

Create a Comment [POST /lab/sites/{siteId}/samples/{id}/comments]

Create a Comment for a Sample

Parameters

  • siteId number

    The Site ID

  • id string

    The Sample ID

  • content string

    The Content of the New Comment

Returns

  • Promise.<SampleController.CommentItem>

Source

static

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

Delete a Sample [DELETE /lab/sites/{siteId}/samples/{id}]

Parameters

  • siteId number

    The Site ID

  • id string

    The Sample ID

Returns

  • Promise.<boolean>

Source

static

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

Delete a Comment [DELETE /lab/sites/{siteId}/samples/{id}/comments/{commentId}]

Delete a Comment for a Sample

Parameters

  • siteId number

    The Site ID

  • id string

    The Sample ID

  • commentId string

    The Comment ID

Returns

  • Promise.<boolean>

Source

static

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

List all Samples [GET /lab/sites/{siteId}/samples]

Parameters

  • siteId number

    The Site ID

  • queryParameters SampleController.GetAllQueryParameters <optional>

    The Optional Query Parameters

Returns

  • Promise.<Array.<SampleModel>>

Source

static

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

Retrieve Comments [GET /lab/sites/{siteId}/samples/{id}/comments]

Retrieves Comments for a Sample

Parameters

  • siteId number

    The Site ID

  • id string

    The Sample ID

Returns

  • Promise.<Array.<SampleController.CommentItem>>

Source

static

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

Retrieve a Sample [GET /lab/sites/{siteId}/samples/{id}]

Parameters

  • siteId number

    The Site ID

  • id string

    The Sample ID

Returns

  • Promise.<SampleModel>

Source

static

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

Retrieve a Comment [GET /lab/sites/{siteId}/samples/{id}/comments/{commentId}]

Retrieves Comments for a Sample

Parameters

  • siteId number

    The Site ID

  • id string

    The Sample ID

  • commentId string

    The Comment ID

Returns

  • Promise.<SampleController.CommentItem>

Source

static

getSampleResult(siteId, id) → {Promise.<SampleResultModel>}

Retrieve a Sample Result [GET /lab/sites/{siteId}/samples/{id}/result]

Retrieves a Sample Result for a Sample

Parameters

  • siteId number

    The Site ID

  • id string

    The Sample ID

Returns

  • Promise.<SampleResultModel>

Source

static

getTemperatureData(siteId, id) → {Promise.<Array.<SampleController.TemperatureDataItem>>}

Retrieve Temperature Data [GET /lab/sites/{siteId}/samples/{id}/temperature-data]

Retrieves Temperature Data for a Sample

Parameters

  • siteId number

    The Site ID

  • id string

    The Sample ID

Returns

  • Promise.<Array.<SampleController.TemperatureDataItem>>

Source

static

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

Update a Sample [PATCH /lab/sites/{siteId}/samples/{id}]

Parameters

  • siteId number

    The Site ID

  • id string

    The Sample ID

  • updateData SampleController.UpdateData

    The Sample Update Data

Returns

  • Promise.<SampleModel>

Source

static

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

Update a Comment [PATCH /lab/sites/{siteId}/samples/{id}/comments/{commentId}]

Update a Comment for a Sample

Parameters

  • siteId number

    The Site ID

  • id string

    The Sample ID

  • commentId string

    The Comment ID

  • content string

    The Updated Content for the Comment

Returns

  • Promise.<SampleController.CommentItem>

Source

Type Definitions

CommentItem

A CommentItem Type

Type

  • Object

Properties

  • id string

    The Comment ID

  • userAccount SampleController.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 Sample

Type

  • Object

Properties

  • labId string

    The Lab ID this Sample is associated with

  • sampleNumber string <optional>

    The Numeric Sample Number

  • createdTimestamp Date <optional>

    When this Sample was Created

  • createdSource string

    The Source that Created this Sample

  • createdUserName string <optional>
    <nullable>

    Name of the User who Created this Sample

  • scheduledTimestamp Date <optional>
    <nullable>

    Optional Scheduled Timestamp when this Sample should Begin

  • loadedTimestamp Date <optional>
    <nullable>

    When this Sample was Loaded into the Dehydrator

  • startTimestamp Date <optional>
    <nullable>

    When this Sample was Started

  • finishTimestamp Date <optional>
    <nullable>

    When this Sample was Finished

  • unloadedTimestamp Date <optional>
    <nullable>

    When this Sample was Unloaded from the Dehydrator

  • publishTimestamp Date <optional>
    <nullable>

    When this Sample was Published

  • publishSource string <optional>
    <nullable>

    The Source that Published this Sample

  • publishUserName string <optional>
    <nullable>

    Name of the User who Published this Sample

  • fruitProfileId string

    The Fruit Profile for this Sample

  • rackPositionId string

    The Rack Position used for this Sample

  • dehydratorId string

    The Dehydrator used for this Sample

  • resultId string <optional>
    <nullable>

    The Sample Result ID asociated with this Sample

Source

GetAllQueryParameters

The Optional Query Parameters for the getAll Function

Type

  • Object

Properties

  • labId string <optional>

    The Lab ID this Sample is associated with

  • sampleNumber string <optional>

    The Numeric Sample Number

  • createdSource string <optional>

    The Source that Created this Sample

  • createdUserName string <optional>
    <nullable>

    Name of the User who Created this Sample

  • publishSource string <optional>
    <nullable>

    The Source that Published this Sample

  • publishUserName string <optional>
    <nullable>

    Name of the User who Published this Sample

  • fruitProfileId string <optional>

    The Fruit Profile for this Sample

  • rackPositionId string <optional>

    The Rack Position used for this Sample

  • dehydratorId string <optional>

    The Dehydrator used for this Sample

  • resultId string <optional>
    <nullable>

    The Sample Result ID asociated with this Sample

  • createdTimestampBegin Date <optional>

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

  • createdTimestampEnd Date <optional>

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

  • scheduledTimestampBegin Date <optional>

    Filter by the Timestamp when Samples were Scheduled to Begin. Results Greater than or Equal to Timestamp

  • scheduledTimestampEnd Date <optional>

    Filter by the Timestamp when Samples were Scheduled to Begin. Results Less than or Equal to Timestamp

  • loadedTimestampBegin Date <optional>

    Filter by the Timestamp when Samples were Loaded. Results Greater than or Equal to Timestamp

  • loadedTimestampEnd Date <optional>

    Filter by the Timestamp when Samples were Loaded. Results Less than or Equal to Timestamp

  • startTimestampBegin Date <optional>

    Filter by the Timestamp when Samples were Started. Results Greater than or Equal to Timestamp

  • startTimestampEnd Date <optional>

    Filter by the Timestamp when Samples were Started. Results Less than or Equal to Timestamp

  • finishTimestampBegin Date <optional>

    Filter by the Timestamp when Samples were Finished. Results Greater than or Equal to Timestamp

  • finishTimestampEnd Date <optional>

    Filter by the Timestamp when Samples were Finished. Results Less than or Equal to Timestamp

  • unloadedTimestampBegin Date <optional>

    Filter by the Timestamp when Samples were Unloaded. Results Greater than or Equal to Timestamp

  • unloadedTimestampEnd Date <optional>

    Filter by the Timestamp when Samples were Unloaded. Results Less than or Equal to Timestamp

  • publishTimestampBegin Date <optional>

    Filter by the Timestamp when Samples were Published. Results Greater than or Equal to Timestamp

  • publishTimestampEnd Date <optional>

    Filter by the Timestamp when Samples were Published. Results Less than or Equal to Timestamp

  • updateTimestampBegin Date <optional>

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

  • updateTimestampEnd Date <optional>

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

  • publishedState boolean <optional>

    Filter by Published State of a Sample. true = Published, false = Not Published

Source

UpdateData

The Update Data for a Sample

Type

  • Object

Properties

  • labId string <optional>

    The Lab ID this Sample is associated with

  • createdTimestamp Date <optional>

    When this Sample was Created

  • createdSource string <optional>

    The Source that Created this Sample

  • createdUserName string <optional>
    <nullable>

    Name of the User who Created this Sample

  • scheduledTimestamp Date <optional>
    <nullable>

    Optional Scheduled Timestamp when this Sample should Begin

  • loadedTimestamp Date <optional>
    <nullable>

    When this Sample was Loaded into the Dehydrator

  • startTimestamp Date <optional>
    <nullable>

    When this Sample was Started

  • finishTimestamp Date <optional>
    <nullable>

    When this Sample was Finished

  • unloadedTimestamp Date <optional>
    <nullable>

    When this Sample was Unloaded from the Dehydrator

  • publishTimestamp Date <optional>
    <nullable>

    When this Sample was Published

  • publishSource string <optional>
    <nullable>

    The Source that Published this Sample

  • publishUserName string <optional>
    <nullable>

    Name of the User who Published this Sample

  • fruitProfileId string <optional>

    The Fruit Profile for this Sample

  • rackPositionId string <optional>

    The Rack Position used for this Sample

  • dehydratorId string <optional>

    The Dehydrator used for this Sample

  • resultId string <optional>
    <nullable>

    The Sample Result ID asociated with this Sample

Source