RICADO Gen 4 API JS Client

RICADO Gen 4 API JS Client

Class

PermanentObjectController

Controller Class for Permanent Objects

Constructor

new PermanentObjectController()

Source

Methods

static

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

Create a Permanent Object [POST /sites/{siteId}/permanent-objects]

Parameters

  • siteId number

    The Site ID

  • createData PermanentObjectController.CreateData

    The Permanent Object Create Data

Returns

  • Promise.<PermanentObjectModel>

Source

static

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

Delete a Permanent Object [DELETE /sites/{siteId}/permanent-objects/{id}]

Parameters

  • siteId number

    The Site ID

  • id string

    The Permanent Object ID

Returns

  • Promise.<boolean>

Source

static

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

List all Permanent Objects [GET /sites/{siteId}/permanent-objects]

Parameters

  • siteId number

    The Site ID

  • queryParameters PermanentObjectController.GetAllQueryParameters <optional>

    The Optional Query Parameters

Returns

  • Promise.<Array.<PermanentObjectModel>>

Source

static

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

Retrieve a Permanent Object [GET /sites/{siteId}/permanent-objects/{id}]

Parameters

  • siteId number

    The Site ID

  • id string

    The Permanent Object ID

Returns

  • Promise.<PermanentObjectModel>

Source

static

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

Update a Permanent Object [PATCH /sites/{siteId}/permanent-objects/{id}]

Parameters

  • siteId number

    The Site ID

  • id string

    The Permanent Object ID

  • updateData PermanentObjectController.UpdateData

    The Permanent Object Update Data

Returns

  • Promise.<PermanentObjectModel>

Source

Type Definitions

CreateData

The Create Data for a Permanent Object

Type

  • Object

Properties

  • rtuId number <optional>
    <nullable>

    The RTU this Permanent Object belongs to

  • keyIndex string <optional>

    The Permanent Object Key Index

  • type string

    The Permanent Object Type

  • definition Object <optional>

    The Permanent Object Definition

Source

GetAllQueryParameters

The Optional Query Parameters for the getAll Function

Type

  • Object

Properties

  • rtuId number <optional>
    <nullable>

    The RTU this Permanent Object belongs to

  • keyIndex string <optional>

    The Permanent Object Key Index

  • type string <optional>

    The Permanent Object Type

Source