Key-Value Store API

This API provides access to read and write any text (json) data to the internal store. Plugins can use the internal store or jsonStore module to alo read and write data to the store.

GET /storeItems/keys

Gets a list of all keys in the store.

JSON Response

PropertyTypeDescription
keys

Array<string>

List of available keys.

GET /storeItems/:key

Gets a store item.

JSON Response

PropertyTypeDescription
storeItem

StoreItem

The module.

StoreItem

PropertyTypeDescription
key

string

The unique store item key.

value

string

The content of the store for that key.

GET /storeItems/:key/value

Gets the value of a store item.

Response

The body contains the item value and the content type is text/html; charset=utf-8.

BAD_REQUEST (400) Response

PropertyTypeDescription
message

string

Store item with given key does not exist.

POST /storeItems

Adds a new value to the store using given key.

JSON Request

PropertyTypeDescription
storeItem

StoreItem

The store item.

BAD_REQUEST (400) Response

PropertyTypeDescription
message

string

Invalid store item key or store item with given key already exists.

PUT /storeItems/:key

Updates an existing item in the store.

JSON Request

PropertyTypeDescription
storeItem

StoreItem

The store item.

BAD_REQUEST (400) Response

PropertyTypeDescription
message

string

Invalid store item key or store item with given key already exists.

PUT /storeItems/:key/value

Updates the value of an existing store item.

Request

The body contains the item value and the content type shall be text/html; charset=utf-8.

BAD_REQUEST (400) Response

PropertyTypeDescription
message

string

Store item with given key does not exist.

DELETE /storeItems/:moduleName

Deletes an existing store item.

BAD_REQUEST (400) Response

PropertyTypeDescription
message

string

No store item to delete for given key found.