RICADO Gen 4 API JS Client

RICADO Gen 4 API JS Client

Class

PermanentObjectDataController

Controller Class for Permanent Object Data

Constructor

new PermanentObjectDataController()

Source

Methods

static

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

Create a Permanent Object Data [POST /sites/{siteId}/permanent-object-data]

Parameters

  • siteId number

    The Site ID

  • createData PermanentObjectDataController.CreateData

    The Permanent Object Data Create Data

Returns

  • Promise.<PermanentObjectDataModel>

Source

static

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

Create a Comment [POST /sites/{siteId}/permanent-object-data/{id}/comments]

Create a Comment for a Permanent Object Data

Parameters

  • siteId number

    The Site ID

  • id string

    The Permanent Object Data ID

  • content string

    The Content of the New Comment

Returns

  • Promise.<PermanentObjectDataController.CommentItem>

Source

static

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

Delete a Permanent Object Data [DELETE /sites/{siteId}/permanent-object-data/{id}]

Parameters

  • siteId number

    The Site ID

  • id string

    The Permanent Object Data ID

Returns

  • Promise.<boolean>

Source

static

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

Delete a Comment [DELETE /sites/{siteId}/permanent-object-data/{id}/comments/{commentId}]

Delete a Comment for a Permanent Object Data

Parameters

  • siteId number

    The Site ID

  • id string

    The Permanent Object Data ID

  • commentId string

    The Comment ID

Returns

  • Promise.<boolean>

Source

static

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

List all Permanent Object Data [GET /sites/{siteId}/permanent-object-data]

Parameters

  • siteId number

    The Site ID

  • queryParameters PermanentObjectDataController.GetAllQueryParameters <optional>

    The Optional Query Parameters

Returns

  • Promise.<Array.<PermanentObjectDataModel>>

Source

static

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

Retrieve Comments [GET /sites/{siteId}/permanent-object-data/{id}/comments]

Retrieves Comments for a Permanent Object Data

Parameters

  • siteId number

    The Site ID

  • id string

    The Permanent Object Data ID

Returns

  • Promise.<Array.<PermanentObjectDataController.CommentItem>>

Source

static

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

Retrieve a Permanent Object Data [GET /sites/{siteId}/permanent-object-data/{id}]

Parameters

  • siteId number

    The Site ID

  • id string

    The Permanent Object Data ID

Returns

  • Promise.<PermanentObjectDataModel>

Source

static

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

Retrieve a Comment [GET /sites/{siteId}/permanent-object-data/{id}/comments/{commentId}]

Retrieves Comments for a Permanent Object Data

Parameters

  • siteId number

    The Site ID

  • id string

    The Permanent Object Data ID

  • commentId string

    The Comment ID

Returns

  • Promise.<PermanentObjectDataController.CommentItem>

Source

static

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

Update a Permanent Object Data [PATCH /sites/{siteId}/permanent-object-data/{id}]

Parameters

  • siteId number

    The Site ID

  • id string

    The Permanent Object Data ID

  • updateData PermanentObjectDataController.UpdateData

    The Permanent Object Data Update Data

Returns

  • Promise.<PermanentObjectDataModel>

Source

static

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

Update a Comment [PATCH /sites/{siteId}/permanent-object-data/{id}/comments/{commentId}]

Update a Comment for a Permanent Object Data

Parameters

  • siteId number

    The Site ID

  • id string

    The Permanent Object Data ID

  • commentId string

    The Comment ID

  • content string

    The Updated Content for the Comment

Returns

  • Promise.<PermanentObjectDataController.CommentItem>

Source

Type Definitions

CommentItem

A CommentItem Type

Type

  • Object

Properties

  • id string

    The Comment ID

  • userAccount PermanentObjectDataController.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 Permanent Object Data

Type

  • Object

Properties

  • keyIndex string <optional>

    An Optional Key Index for this Data

  • permanentObjectId string

    The Permanent Object this Data is related to

  • type string

    The Permanent Object Data Type

  • timestamp Date <optional>

    The Timestamp when this Data was Created

  • data Object <optional>

    The Data Object specific to this Permanent Object Data Type

Source

GetAllQueryParameters

The Optional Query Parameters for the getAll Function

Type

  • Object

Properties

  • keyIndex string <optional>

    An Optional Key Index for this Data

  • permanentObjectId string <optional>

    The Permanent Object this Data is related to

  • type string <optional>

    The Permanent Object Data Type

  • timestampBegin Date <optional>

    Filter by the Timestamp when this Data was Created. Results Greater than or Equal to Timestamp

  • timestampEnd Date <optional>

    Filter by the Timestamp when this Data was Created. Results Less than or Equal to Timestamp

Source

UpdateData

The Update Data for a Permanent Object Data

Type

  • Object

Properties

  • permanentObjectId string <optional>

    The Permanent Object this Data is related to

  • type string <optional>

    The Permanent Object Data Type

  • timestamp Date <optional>

    The Timestamp when this Data was Created

  • data Object <optional>

    The Data Object specific to this Permanent Object Data Type

Source