Put Sticker

This endpoint creates one or more Stickers and puts them on a given Twin.

STICKER RECIPIENTS LIST

Each Sticker has a "recipients" list. A user whose user, role or account UUID are included on the "recipients" list can view the Sticker in the response to the list_stickers endpoint and remove the Sticker from the Twin through the remove_sticker endpoint.

Method	Path	Operation*
POST	/twins/{twin}/stickers	put_sticker

*

In order for a user to perform the "put_sticker" operation, the "put_sticker" permission must be included in the list of allowed actions in the statement of the user's role.

Request

Parameter	Type	In	Description
{twin} required	string	path	Twin UUID of the Twin on which the Sticker is to be put.
stickers	dictionary	body	Key-value pairs: - key (Sticker color): alphanumeric string unique within an account. It must match the regular expression(opens new window) [0-9A-Za-z\-]{3,48}. - value: Valid JSON data type.

Sticker parameters

Parameter	Type	In	Description
note optional	string	body	Note for the recipients of the Sticker. The maximum length of a note is 512 characters.
recipients required	list of strings	body	List of user UUIDs, role UUIDs, and account UUIDs that should be able to access and remove the sticker. The maximum number of items on the list is 100.
validity_ts optional*	timestamp	body	Time at which the Sticker expires. Measured in seconds (to three decimal places) that have elapsed since the Unix epoch(opens new window). The maximum validity of a Sticker is one year after the creation of a Sticker (now() + 1 Year). If the "validity_ts" is not provided in the request, the "validity_ts" is set to its maximum value (now() + 1 Year).
publish optional**	dictionary, keys are "on_put", "on_remove" or "on_expire"	body	List of events that trigger a notification message for the Sticker with the subscription topics that the notifications are to be sent to. The key is the event. The value is the notification topics or a list of notifications topics. The event can be one of the following: - "on_put": A notification message is triggered when a Sticker of the given color is put on a given Twin. - "on_remove": A notification message is triggered when a Sticker of a given color is removed from the given Twin. - "on_expire": A notification message is triggered when the "validity_ts" of a Sticker is reached and the Sticker expires. A notification message is triggered up to 60 seconds from the time a Sticker has expired. The value is the name of the subscription topic. The "topic" value must match the regular expression(opens new window).^[0-9A-Za-z-_]{0,127}(?😡[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12})?$.

*

If "validity_ts" with the value null is provided in the request body, a Sticker will not be created and the request will return an error.
If the request body does not contain "validity_ts", the value of "validity_ts" will be set to its maximum and default value which corresponds one year from now (now() + 1 year).

**

The "publish" parameter is optional. If the "publish" parameter is not provided in the request, a notification will not be set for the Sticker of the given color.

Response

Attribute	Type	Description
note	string	Note for the recipients of the Sticker. The maximum length of a note is 512 characters.
recipients	list of strings	List of user UUIDs, role UUIDs, and account UUIDs that should be able to access and remove the sticker. The maximum number of items on the list is 100.
validity_ts	timestamp	Time at which the Sticker expires. Measured in seconds (to three decimal places) that have elapsed since the Unix epoch(opens new window).
created_ts	timestamp	Time at which the Sticker was created. Measured in seconds (to three decimal places) that have elapsed since the Unix epoch(opens new window).
publish	dictionary, keys are "on_put", "on_remove" or "on_expire"	List of events that trigger a notification message for the Sticker with the subscription topics that the notifications are to be sent to. The key is the event. The value is the notification topics or a list of notifications topics. The event can be one of the following: - "on_put": A notification message is triggered when a Sticker of the given color is put on a given Twin. - "on_remove": A notification message is triggered when a Sticker of a given color is removed from the given Twin. - "on_expire": A notification message is triggered when the "validity_ts" of a Sticker is reached and the Sticker expires. A notification message is triggered up to 60 seconds from the time a Sticker has expired. The value is the name of the subscription topic. It must match the regular expression(opens new window) ^[0-9A-Za-z\-]{3,48}$.

Status codes

Requests to this endpoint result in generic status codes. For a comprehensive list of status codes, please consult the Status codes section.