Adapter - Built-in Commands

This page describes version 1.23.4 of the adapter.

Overview

The Built-in Commands adapter provides various basic commands that are built into the UIP platform. These commands can be used without defining an adapter, and the adapter type is updated automatically during UIP system version updates.



Commands

Set Mapping Data Value (setdata)

Set a key to a value within a mapping data collection.

Request Properties

Name	Display	Description	Is Required	Type
collection	Collection	The collection to set the value in.	True	string
key	Key	The key to set.	True	string
value	Value	The value to set.	False	string

Response Properties

Name	Description	Type
status	true if set, false if not set.	string

Delete Mapping Data Value (deletedata)

Delete a key/value pair from a mapping data collection.

Request Properties

Name	Display	Description	Is Required	Type
collection	Collection	The collection to delete from.	True	string
key	Key	The key to delete.	True	string

Response Properties

Name	Description	Type
status	true if success, false if not set. Will be true if key not found.	string

Get Mapping Data Value (getdata)

Get the value for a key in a mapping data collection.

Request Properties

Name	Display	Description	Is Required	Type
collection	Collection	The collection to get the value from.	True	string
key	Key	The key to get.	True	string

Response Properties

Name	Description	Type
status	true if the value was found, false if not.	string
value	The retrieved value. Empty if the value was not found.	string
timestamp	The timestamp when the value was set. Not set if the value was not found.	string

JSON Parse (jsonparse)

Flatten and parse a JSON value into multiple properties with an optional prefix.

Request Properties

Name	Display	Description	Is Required	Type
value	Value	The JSON string to parse.	True	string
prefix	Prefix	The prefix to add to the parsed property names.	False	string