Update a Ledger Entry value

This endpoint updates the value of one or more Entries of a Ledger. You can update the value of an Entry in your personal Ledger.

Method	Path	Operation*
PATCH	/twins/{twin}/ledgers/personal/value	update_twin_ledger_entry_value
PATCH	/twins/{twin}/ledgers/{ledger}/value	update_twin_ledger_entry_value

*

In order for a user to perform the "update_twin_ledger_entry_value" operation, the "update_twin_ledger_entry_value" 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.
ledger required*	string	path	Ledger UUID.
value required	valid JSON data type	body	User-defined value of the Entry. This field cannot be changed by the user if the "ref" (reference) field is part of the value.

*

The "ledger" parameter is required in the path of the request for requests based on the account UUID if the Twin rule allows you to perform operations on the given Twin.

Response

Attribute	Type	Description
entry_created_ts	timestamp	Last time when an Entry in the Ledger was created. Measured in seconds (to three decimal places) that have elapsed since the Unix epoch (opens new window).
entry_updated_ts	timestamp	Last time when an Entry in the Ledger was updated. Measured in seconds (to three decimal places) that have elapsed since the Unix epoch (opens new window).
value_changed_ts	timestamp	Last time when a value of an Entry in the Ledger was changed. Measured in seconds (to three decimal places) that have elapsed since the Unix epoch (opens new window).
entries	dictionary	Key-value pairs: - Key: alphanumeric string unique within the Ledger. It must match the regular expression (opens new window) ^(_*[a-z0-9]+)([_-][0-9a-z]+)$. - Value: Valid JSON data type.

Entry attributes

Attribute	Type	Description
entry_created_ts	timestamp	Time at which the Entry was created. Measured in seconds (to three decimal places) that have elapsed since the Unix epoch (opens new window).
entry_updated_ts	timestamp	Time at which the Entry was last updated. Measured in seconds (to three decimal places) that have elapsed since the Unix epoch (opens new window).
value_changed_ts	timestamp	Time at which the value of an Entry was last changed. Measured in seconds (to three decimal places) that have elapsed since the Unix epoch (opens new window).
value	string	User-defined value of the Entry. This field cannot be changed by the user if the "ref" (reference) field exists.
visibility	string	Visibility of the Entry. If the "visibility" of an Entry is null, the Entry is private. Private Entries are only visible to users of the account that owns the Ledger. If all Entries of the Ledger are private, the Ledger is private. If the "visibility" of an Entry is not null, the Entry is public. Public Entries are visible to users of the account that owns the Ledger and also visible to users of other accounts if the visibility rule evaluates to True. If any of the Entries of the Ledger is public, the Ledger is public.
ref*	dictionary	Reference. It allows to create an Entry based on the "value" field of an Entry in a different Ledger, especially a Ledger of a different account. The value that the reference is pointing to must be visible to the account creating the reference. Attribute Type Description source string, composed of {twin} (Twin UUID), {ledger} (Ledger UUID)/ Name of the Entry in the Ledger* Source path to the value that we want the Entry to reference. status enum, value is "not_found" or "ok" Status of the reference. It can have one of the following values: - "not_found": The value could not be found. "not_found" is the default value until the value in the Entry that the reference is pointing to is first updated. It can also mean that the value is set to null as the Entry that the reference is pointing to does not exist or is not accessible to the account, because there is a circular reference or because there are too many transfers between references (the maximum number of hops allowed is 32). - "ok": The Entry value is consistent with the value that the reference is pointing to.
include**	string	Entry is an external const-like value fetched upon request.
history	string	Time for which the history of changes of the Entry's value is to be stored. Please note that the limit of stored History records is 1000 per Entry. If there are more than 1000 Entry value changes within the specified time period, only 1000 most recent History records will be stored. The "history" value must match the regular expression (opens new window).^([1-9][0-9]{0,2}[DWMY])|(INF)$. If there is no "history" attribute, the History service is not enabled If "history" is set to null, the History service is not enabled If "history" is set to "INF", the most recent 1000 historical Entry values are stored for the Entry. If "history" is set to a time period (e.g., days, weeks, months), the historical Entry values are stored for the given time period subject to the maximum number of history records limit (1000 per Entry).
timeseries***	dictionary	Timeseries attribute. It holds the name of the Timeseries table, the "measurement" attribute, and (optionally) the "dimensions" attribute. Attribute Type Description measurement string Name of the measurement column in the given Timeseries table under which the Entry value is to be stored. dimensions dictionary Key-value pair: - Key: name of the dimension under which the Entry value is to be stored. - Value: Template for the value of the dimension.
publish	dictionary	Holds the details about the Notifications set up for the given Entry. Attribute Type Description rule string Notification rule that defines the conditions to be met for a notification to be sent. topic list List of notification topic templates.

*

The "ref" attribute is only returned for Reference type Entries.

**

The "include" attribute is only returned for Include type Entries.

***

The Timeseries service needs to be enabled for your account. Please contact hello@trustedtwin.com for more details.

Status codes

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