# Get Twin Ledger Entry value
This endpoint allows you to retrieve Ledger Entry values. You can retrieve values from Entries:
Method | Path | Operation* |
---|---|---|
GET | /twins/{twin}/ledgers/{ledger}/value | get_twin_ledger_entry_value |
*
In order for a user to perform the "get_twin_ledger_entry_value" operation, the "get_twin_ledger_entry_value" permission must be included in the list of allowed actions in the statement of the user's role.
**
The "ledger"
parameter in the path of the request should point to the Ledger resource for requests based on the account UUID. Request based on the account UUID can be performed if the Twin rule allows you to perform operations on the given Twin. For requests on personal Ledger, you can use personal
instead of the Ledger UUID in the path of the request (/twins/{twin}/ledgers/personal
). For requests on Ledgers where you are the owner of the Twin, you can use owner
instead of the Ledger UUID in the path of the request (/twins/{twin}/ledgers/owner
).
# Request
Parameter | Type | In | Description |
---|---|---|---|
twin required | string | path | Twin UUID. |
ledger required* | string | path | Ledger UUID. |
entries optional** | string | query string | Key of the Ledger Entry to be returned. |
*
The "ledger"
parameter in the path of the request should point to the Ledger resource for requests based on the account UUID. Request based on the account UUID can be performed if the Twin rule allows you to perform operations on the given Twin. For requests on personal Ledger, you can use personal
instead of the Ledger UUID in the path of the request (/twins/{twin}/ledgers/personal
). For requests on Ledgers where you are the owner of the Twin, you can use owner
instead of the Ledger UUID in the path of the request (/twins/{twin}/ledgers/owner
).
**
The entries
parameter is optional. If it is not included in the request, all Entries visible to the caller are returned.
# Response
# 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 | Value of the Entry. |
# Status codes
Requests to this endpoint result in generic status codes. For a comprehensive list of status codes, please consult the Status codes section.
Was this article helpful?