# Overview

A Ledger Entry can be of one of the following types:

  • Value type Entry,
  • Reference type Entry,
  • Include type Entry.

Please see the relevant section for attributes of:

# Ledger attributes

# Value 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 "visibility", "history", "timeseries", or "publish" property of an 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.
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 no "history" attribute is returned in the response, 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. If no "timeseries" attribute is returned in the response, the Entry value is not stored in a Timeseries table.
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 Key-value pairs that hold the details about the Notifications set up for the given Entry:
- key: Notification rule that defines the conditions to be met for a notification to be sent.
- value: List of name templates for the given Notification.
If no "publish" attribute is returned in the response, no notifications are set for the Entry.

*

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

IMPORTANT NOTE

Please note that once you create an Entry where the "value" is picked up through a "reference" from another Entry, you cannot update the Entry so that it does not contain a "reference". In such case, you would need to delete the Entry and create a new Entry without the "reference" field.

# Reference 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 "visibility", "history", "timeseries", or "publish" property of an 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 "created", "ok", "not_found", "loop_detected" or "too_many_hops" Status of the reference. It can have one of the following values:
- "created": The Entry was created.
- "ok": The Entry value is consistent with the value that the reference is pointing to.
- "not_found": The value could not be found.
- "loop_detected": The Entry is not accessible to the account because of a circular reference.
- "too_many_hops": There are too many transfers between references (the maximum number of hops allowed is 32).
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 no "history" attribute is returned in the response, 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. If no "timeseries" attribute is returned in the response, the Entry value is not stored in a Timeseries table.
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 Key-value pairs that hold the details about the Notifications set up for the given Entry:
- key: Notification rule that defines the conditions to be met for a notification to be sent.
- value: List of name templates for the given Notification.
If no "publish" attribute is returned in the response, no notifications are set for the Entry.

*

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

IMPORTANT NOTE

Please note that once you create an Entry where the "value" is picked up through a "reference" from another Entry, you cannot update the Entry so that it does not contain a "reference". In such case, you would need to delete the Entry and create a new Entry without the "reference" field.

# Include 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 "visibility" property of an 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.
include** string
It allows to create an Entry that fetches upon request the "value" field of an Entry in a different Ledger in the same account.
Parameter Type In Description
source
required* 		string, composed of {twin} (Twin UUID)/ name of the Entry in the Ledger* body Source path to the value that we want the Entry to include.

← Add Twin Ledger Entry →

Was this article helpful?