RICADO Gen 4 API JS Client

RICADO Gen 4 API JS Client

Class

TemporaryObjectController

Controller Class for Temporary Objects

Constructor

new TemporaryObjectController()

Source

Methods

static

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

Create a Temporary Object [POST /sites/{siteId}/temporary-objects]

Parameters

  • siteId number

    The Site ID

  • createData TemporaryObjectController.CreateData

    The Temporary Object Create Data

Returns

  • Promise.<TemporaryObjectModel>

Source

static

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

Delete a Temporary Object [DELETE /sites/{siteId}/temporary-objects/{id}]

Parameters

  • siteId number

    The Site ID

  • id string

    The Temporary Object ID

Returns

  • Promise.<boolean>

Source

static

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

List all Temporary Objects [GET /sites/{siteId}/temporary-objects]

Parameters

  • siteId number

    The Site ID

  • queryParameters TemporaryObjectController.GetAllQueryParameters <optional>

    The Optional Query Parameters

Returns

  • Promise.<Array.<TemporaryObjectModel>>

Source

static

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

Retrieve a Temporary Object [GET /sites/{siteId}/temporary-objects/{id}]

Parameters

  • siteId number

    The Site ID

  • id string

    The Temporary Object ID

Returns

  • Promise.<TemporaryObjectModel>

Source

static

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

Update a Temporary Object [PATCH /sites/{siteId}/temporary-objects/{id}]

Parameters

  • siteId number

    The Site ID

  • id string

    The Temporary Object ID

  • updateData TemporaryObjectController.UpdateData

    The Temporary Object Update Data

Returns

  • Promise.<TemporaryObjectModel>

Source

Type Definitions

CreateData

The Create Data for a Temporary Object

Type

  • Object

Properties

  • keyIndex string <optional>

    The Temporary Object Key Index

  • type string

    The Temporary Object Type

  • definition Object <optional>

    The Temporary Object Definition

Source