curl --request POST \
--url 'http://localhost:7575/v2/updates/trees' \
--header 'Authorization: Bearer $TOKEN' \
--header 'Content-Type: application/json' \
--data '{
"beginExclusive": 123,
"endInclusive": 123,
"filter": {
"filtersByParty": {},
"filtersForAnyParty": {
"cumulative": [
{
"identifierFilter": {
"Empty": "<object>"
}
}
]
}
},
"verbose": false,
"updateFormat": {
"includeTransactions": {
"eventFormat": {
"filtersByParty": {},
"filtersForAnyParty": {
"cumulative": [
"<object>"
]
},
"verbose": false
},
"transactionShape": "TRANSACTION_SHAPE_UNSPECIFIED"
},
"includeReassignments": {
"filtersByParty": {},
"filtersForAnyParty": {
"cumulative": [
{
"identifierFilter": "<object>"
}
]
},
"verbose": false
},
"includeTopologyEvents": {
"includeParticipantAuthorizationEvents": {
"parties": [
"<string>"
]
}
}
},
"descendingOrder": false
}'
import json
import requests
url = "http://localhost:7575/v2/updates/trees"
headers = {'Authorization': 'Bearer <token>', 'Content-Type': 'application/json'}
payload = json.loads(r'''{
"beginExclusive": 123,
"endInclusive": 123,
"filter": {
"filtersByParty": {},
"filtersForAnyParty": {
"cumulative": [
{
"identifierFilter": {
"Empty": "<object>"
}
}
]
}
},
"verbose": false,
"updateFormat": {
"includeTransactions": {
"eventFormat": {
"filtersByParty": {},
"filtersForAnyParty": {
"cumulative": [
"<object>"
]
},
"verbose": false
},
"transactionShape": "TRANSACTION_SHAPE_UNSPECIFIED"
},
"includeReassignments": {
"filtersByParty": {},
"filtersForAnyParty": {
"cumulative": [
{
"identifierFilter": "<object>"
}
]
},
"verbose": false
},
"includeTopologyEvents": {
"includeParticipantAuthorizationEvents": {
"parties": [
"<string>"
]
}
}
},
"descendingOrder": false
}''')
response = requests.request(
"POST", url, headers=headers, json=payload
)
print(response.text)
const response = await fetch('http://localhost:7575/v2/updates/trees', {
method: 'POST',
headers: {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
},
body: JSON.stringify({
"beginExclusive": 123,
"endInclusive": 123,
"filter": {
"filtersByParty": {},
"filtersForAnyParty": {
"cumulative": [
{
"identifierFilter": {
"Empty": "<object>"
}
}
]
}
},
"verbose": false,
"updateFormat": {
"includeTransactions": {
"eventFormat": {
"filtersByParty": {},
"filtersForAnyParty": {
"cumulative": [
"<object>"
]
},
"verbose": false
},
"transactionShape": "TRANSACTION_SHAPE_UNSPECIFIED"
},
"includeReassignments": {
"filtersByParty": {},
"filtersForAnyParty": {
"cumulative": [
{
"identifierFilter": "<object>"
}
]
},
"verbose": false
},
"includeTopologyEvents": {
"includeParticipantAuthorizationEvents": {
"parties": [
"<string>"
]
}
}
},
"descendingOrder": false
}),
});
console.log(await response.text());
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => 'http://localhost:7575/v2/updates/trees',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_POSTFIELDS => <<<'JSON'
{
"beginExclusive": 123,
"endInclusive": 123,
"filter": {
"filtersByParty": {},
"filtersForAnyParty": {
"cumulative": [
{
"identifierFilter": {
"Empty": "<object>"
}
}
]
}
},
"verbose": false,
"updateFormat": {
"includeTransactions": {
"eventFormat": {
"filtersByParty": {},
"filtersForAnyParty": {
"cumulative": [
"<object>"
]
},
"verbose": false
},
"transactionShape": "TRANSACTION_SHAPE_UNSPECIFIED"
},
"includeReassignments": {
"filtersByParty": {},
"filtersForAnyParty": {
"cumulative": [
{
"identifierFilter": "<object>"
}
]
},
"verbose": false
},
"includeTopologyEvents": {
"includeParticipantAuthorizationEvents": {
"parties": [
"<string>"
]
}
}
},
"descendingOrder": false
}
JSON,
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
echo $response;
package main
import (
"bytes"
"fmt"
"io"
"net/http"
)
func main() {
req, _ := http.NewRequest("POST", "http://localhost:7575/v2/updates/trees", bytes.NewBufferString(`{
"beginExclusive": 123,
"endInclusive": 123,
"filter": {
"filtersByParty": {},
"filtersForAnyParty": {
"cumulative": [
{
"identifierFilter": {
"Empty": "<object>"
}
}
]
}
},
"verbose": false,
"updateFormat": {
"includeTransactions": {
"eventFormat": {
"filtersByParty": {},
"filtersForAnyParty": {
"cumulative": [
"<object>"
]
},
"verbose": false
},
"transactionShape": "TRANSACTION_SHAPE_UNSPECIFIED"
},
"includeReassignments": {
"filtersByParty": {},
"filtersForAnyParty": {
"cumulative": [
{
"identifierFilter": "<object>"
}
]
},
"verbose": false
},
"includeTopologyEvents": {
"includeParticipantAuthorizationEvents": {
"parties": [
"<string>"
]
}
}
},
"descendingOrder": false
}`))
req.Header.Set("Authorization", "Bearer <token>")
req.Header.Set("Content-Type", "application/json")
response, _ := http.DefaultClient.Do(req)
defer response.Body.Close()
body, _ := io.ReadAll(response.Body)
fmt.Println(string(body))
}
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
var request = HttpRequest.newBuilder()
.uri(URI.create("http://localhost:7575/v2/updates/trees"))
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("""
{
"beginExclusive": 123,
"endInclusive": 123,
"filter": {
"filtersByParty": {},
"filtersForAnyParty": {
"cumulative": [
{
"identifierFilter": {
"Empty": "<object>"
}
}
]
}
},
"verbose": false,
"updateFormat": {
"includeTransactions": {
"eventFormat": {
"filtersByParty": {},
"filtersForAnyParty": {
"cumulative": [
"<object>"
]
},
"verbose": false
},
"transactionShape": "TRANSACTION_SHAPE_UNSPECIFIED"
},
"includeReassignments": {
"filtersByParty": {},
"filtersForAnyParty": {
"cumulative": [
{
"identifierFilter": "<object>"
}
]
},
"verbose": false
},
"includeTopologyEvents": {
"includeParticipantAuthorizationEvents": {
"parties": [
"<string>"
]
}
}
},
"descendingOrder": false
}
"""))
.build();
var response = HttpClient.newHttpClient().send(
request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
require 'net/http'
require 'uri'
uri = URI('http://localhost:7575/v2/updates/trees')
request = Net::HTTP::Post.new(uri)
request['Authorization'] = 'Bearer <token>'
request['Content-Type'] = 'application/json'
request.body = <<~JSON
{
"beginExclusive": 123,
"endInclusive": 123,
"filter": {
"filtersByParty": {},
"filtersForAnyParty": {
"cumulative": [
{
"identifierFilter": {
"Empty": "<object>"
}
}
]
}
},
"verbose": false,
"updateFormat": {
"includeTransactions": {
"eventFormat": {
"filtersByParty": {},
"filtersForAnyParty": {
"cumulative": [
"<object>"
]
},
"verbose": false
},
"transactionShape": "TRANSACTION_SHAPE_UNSPECIFIED"
},
"includeReassignments": {
"filtersByParty": {},
"filtersForAnyParty": {
"cumulative": [
{
"identifierFilter": "<object>"
}
]
},
"verbose": false
},
"includeTopologyEvents": {
"includeParticipantAuthorizationEvents": {
"parties": [
"<string>"
]
}
}
},
"descendingOrder": false
}
JSON
response = Net::HTTP.start(uri.hostname, uri.port) do |http|
http.request(request)
end
puts response.body
[
{
"update": {
"OffsetCheckpoint": {
"value": {
"offset": 123,
"synchronizerTimes": [
"<object>"
]
}
}
}
}
]
<string>
{
"code": "<string>",
"cause": "<string>",
"correlationId": "<string>",
"traceId": "<string>",
"context": {},
"resources": [
[
"<string>"
]
],
"errorCategory": 123,
"grpcCodeValue": 123,
"retryInfo": "<string>",
"definiteAnswer": false
}
POST /v2/updates/trees
Query update transactions tree list (blocking call). Provided for backwards compatibility, it will be removed in the Canton version 3.5.0, use v2/updates instead. Notice: This endpoint should be used for small results set. When number of results exceeded node configuration limit (http-list-max-elements-limit) there will be an error (413 Content Too Large) returned. Increasing this limit may lead to performance issues and high memory consumption.
POST
/
v2
/
updates
/
trees
curl --request POST \
--url 'http://localhost:7575/v2/updates/trees' \
--header 'Authorization: Bearer $TOKEN' \
--header 'Content-Type: application/json' \
--data '{
"beginExclusive": 123,
"endInclusive": 123,
"filter": {
"filtersByParty": {},
"filtersForAnyParty": {
"cumulative": [
{
"identifierFilter": {
"Empty": "<object>"
}
}
]
}
},
"verbose": false,
"updateFormat": {
"includeTransactions": {
"eventFormat": {
"filtersByParty": {},
"filtersForAnyParty": {
"cumulative": [
"<object>"
]
},
"verbose": false
},
"transactionShape": "TRANSACTION_SHAPE_UNSPECIFIED"
},
"includeReassignments": {
"filtersByParty": {},
"filtersForAnyParty": {
"cumulative": [
{
"identifierFilter": "<object>"
}
]
},
"verbose": false
},
"includeTopologyEvents": {
"includeParticipantAuthorizationEvents": {
"parties": [
"<string>"
]
}
}
},
"descendingOrder": false
}'
import json
import requests
url = "http://localhost:7575/v2/updates/trees"
headers = {'Authorization': 'Bearer <token>', 'Content-Type': 'application/json'}
payload = json.loads(r'''{
"beginExclusive": 123,
"endInclusive": 123,
"filter": {
"filtersByParty": {},
"filtersForAnyParty": {
"cumulative": [
{
"identifierFilter": {
"Empty": "<object>"
}
}
]
}
},
"verbose": false,
"updateFormat": {
"includeTransactions": {
"eventFormat": {
"filtersByParty": {},
"filtersForAnyParty": {
"cumulative": [
"<object>"
]
},
"verbose": false
},
"transactionShape": "TRANSACTION_SHAPE_UNSPECIFIED"
},
"includeReassignments": {
"filtersByParty": {},
"filtersForAnyParty": {
"cumulative": [
{
"identifierFilter": "<object>"
}
]
},
"verbose": false
},
"includeTopologyEvents": {
"includeParticipantAuthorizationEvents": {
"parties": [
"<string>"
]
}
}
},
"descendingOrder": false
}''')
response = requests.request(
"POST", url, headers=headers, json=payload
)
print(response.text)
const response = await fetch('http://localhost:7575/v2/updates/trees', {
method: 'POST',
headers: {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
},
body: JSON.stringify({
"beginExclusive": 123,
"endInclusive": 123,
"filter": {
"filtersByParty": {},
"filtersForAnyParty": {
"cumulative": [
{
"identifierFilter": {
"Empty": "<object>"
}
}
]
}
},
"verbose": false,
"updateFormat": {
"includeTransactions": {
"eventFormat": {
"filtersByParty": {},
"filtersForAnyParty": {
"cumulative": [
"<object>"
]
},
"verbose": false
},
"transactionShape": "TRANSACTION_SHAPE_UNSPECIFIED"
},
"includeReassignments": {
"filtersByParty": {},
"filtersForAnyParty": {
"cumulative": [
{
"identifierFilter": "<object>"
}
]
},
"verbose": false
},
"includeTopologyEvents": {
"includeParticipantAuthorizationEvents": {
"parties": [
"<string>"
]
}
}
},
"descendingOrder": false
}),
});
console.log(await response.text());
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => 'http://localhost:7575/v2/updates/trees',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_POSTFIELDS => <<<'JSON'
{
"beginExclusive": 123,
"endInclusive": 123,
"filter": {
"filtersByParty": {},
"filtersForAnyParty": {
"cumulative": [
{
"identifierFilter": {
"Empty": "<object>"
}
}
]
}
},
"verbose": false,
"updateFormat": {
"includeTransactions": {
"eventFormat": {
"filtersByParty": {},
"filtersForAnyParty": {
"cumulative": [
"<object>"
]
},
"verbose": false
},
"transactionShape": "TRANSACTION_SHAPE_UNSPECIFIED"
},
"includeReassignments": {
"filtersByParty": {},
"filtersForAnyParty": {
"cumulative": [
{
"identifierFilter": "<object>"
}
]
},
"verbose": false
},
"includeTopologyEvents": {
"includeParticipantAuthorizationEvents": {
"parties": [
"<string>"
]
}
}
},
"descendingOrder": false
}
JSON,
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
echo $response;
package main
import (
"bytes"
"fmt"
"io"
"net/http"
)
func main() {
req, _ := http.NewRequest("POST", "http://localhost:7575/v2/updates/trees", bytes.NewBufferString(`{
"beginExclusive": 123,
"endInclusive": 123,
"filter": {
"filtersByParty": {},
"filtersForAnyParty": {
"cumulative": [
{
"identifierFilter": {
"Empty": "<object>"
}
}
]
}
},
"verbose": false,
"updateFormat": {
"includeTransactions": {
"eventFormat": {
"filtersByParty": {},
"filtersForAnyParty": {
"cumulative": [
"<object>"
]
},
"verbose": false
},
"transactionShape": "TRANSACTION_SHAPE_UNSPECIFIED"
},
"includeReassignments": {
"filtersByParty": {},
"filtersForAnyParty": {
"cumulative": [
{
"identifierFilter": "<object>"
}
]
},
"verbose": false
},
"includeTopologyEvents": {
"includeParticipantAuthorizationEvents": {
"parties": [
"<string>"
]
}
}
},
"descendingOrder": false
}`))
req.Header.Set("Authorization", "Bearer <token>")
req.Header.Set("Content-Type", "application/json")
response, _ := http.DefaultClient.Do(req)
defer response.Body.Close()
body, _ := io.ReadAll(response.Body)
fmt.Println(string(body))
}
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
var request = HttpRequest.newBuilder()
.uri(URI.create("http://localhost:7575/v2/updates/trees"))
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("""
{
"beginExclusive": 123,
"endInclusive": 123,
"filter": {
"filtersByParty": {},
"filtersForAnyParty": {
"cumulative": [
{
"identifierFilter": {
"Empty": "<object>"
}
}
]
}
},
"verbose": false,
"updateFormat": {
"includeTransactions": {
"eventFormat": {
"filtersByParty": {},
"filtersForAnyParty": {
"cumulative": [
"<object>"
]
},
"verbose": false
},
"transactionShape": "TRANSACTION_SHAPE_UNSPECIFIED"
},
"includeReassignments": {
"filtersByParty": {},
"filtersForAnyParty": {
"cumulative": [
{
"identifierFilter": "<object>"
}
]
},
"verbose": false
},
"includeTopologyEvents": {
"includeParticipantAuthorizationEvents": {
"parties": [
"<string>"
]
}
}
},
"descendingOrder": false
}
"""))
.build();
var response = HttpClient.newHttpClient().send(
request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
require 'net/http'
require 'uri'
uri = URI('http://localhost:7575/v2/updates/trees')
request = Net::HTTP::Post.new(uri)
request['Authorization'] = 'Bearer <token>'
request['Content-Type'] = 'application/json'
request.body = <<~JSON
{
"beginExclusive": 123,
"endInclusive": 123,
"filter": {
"filtersByParty": {},
"filtersForAnyParty": {
"cumulative": [
{
"identifierFilter": {
"Empty": "<object>"
}
}
]
}
},
"verbose": false,
"updateFormat": {
"includeTransactions": {
"eventFormat": {
"filtersByParty": {},
"filtersForAnyParty": {
"cumulative": [
"<object>"
]
},
"verbose": false
},
"transactionShape": "TRANSACTION_SHAPE_UNSPECIFIED"
},
"includeReassignments": {
"filtersByParty": {},
"filtersForAnyParty": {
"cumulative": [
{
"identifierFilter": "<object>"
}
]
},
"verbose": false
},
"includeTopologyEvents": {
"includeParticipantAuthorizationEvents": {
"parties": [
"<string>"
]
}
}
},
"descendingOrder": false
}
JSON
response = Net::HTTP.start(uri.hostname, uri.port) do |http|
http.request(request)
end
puts response.body
[
{
"update": {
"OffsetCheckpoint": {
"value": {
"offset": 123,
"synchronizerTimes": [
"<object>"
]
}
}
}
}
]
<string>
{
"code": "<string>",
"cause": "<string>",
"correlationId": "<string>",
"traceId": "<string>",
"context": {},
"resources": [
[
"<string>"
]
],
"errorCategory": 123,
"grpcCodeValue": 123,
"retryInfo": "<string>",
"definiteAnswer": false
}
Query update transactions tree list (blocking call). Provided for backwards compatibility, it will be removed in the Canton version 3.5.0, use v2/updates instead. Notice: This endpoint should be used for small results set. When number of results exceeded node configuration limit (http-list-max-elements-limit) there will be an error (413 Content Too Large) returned. Increasing this limit may lead to performance issues and high memory consumption.
curl --request POST \
--url 'http://localhost:7575/v2/updates/trees' \
--header 'Authorization: Bearer $TOKEN' \
--header 'Content-Type: application/json' \
--data '{
"beginExclusive": 123,
"endInclusive": 123,
"filter": {
"filtersByParty": {},
"filtersForAnyParty": {
"cumulative": [
{
"identifierFilter": {
"Empty": "<object>"
}
}
]
}
},
"verbose": false,
"updateFormat": {
"includeTransactions": {
"eventFormat": {
"filtersByParty": {},
"filtersForAnyParty": {
"cumulative": [
"<object>"
]
},
"verbose": false
},
"transactionShape": "TRANSACTION_SHAPE_UNSPECIFIED"
},
"includeReassignments": {
"filtersByParty": {},
"filtersForAnyParty": {
"cumulative": [
{
"identifierFilter": "<object>"
}
]
},
"verbose": false
},
"includeTopologyEvents": {
"includeParticipantAuthorizationEvents": {
"parties": [
"<string>"
]
}
}
},
"descendingOrder": false
}'
import json
import requests
url = "http://localhost:7575/v2/updates/trees"
headers = {'Authorization': 'Bearer <token>', 'Content-Type': 'application/json'}
payload = json.loads(r'''{
"beginExclusive": 123,
"endInclusive": 123,
"filter": {
"filtersByParty": {},
"filtersForAnyParty": {
"cumulative": [
{
"identifierFilter": {
"Empty": "<object>"
}
}
]
}
},
"verbose": false,
"updateFormat": {
"includeTransactions": {
"eventFormat": {
"filtersByParty": {},
"filtersForAnyParty": {
"cumulative": [
"<object>"
]
},
"verbose": false
},
"transactionShape": "TRANSACTION_SHAPE_UNSPECIFIED"
},
"includeReassignments": {
"filtersByParty": {},
"filtersForAnyParty": {
"cumulative": [
{
"identifierFilter": "<object>"
}
]
},
"verbose": false
},
"includeTopologyEvents": {
"includeParticipantAuthorizationEvents": {
"parties": [
"<string>"
]
}
}
},
"descendingOrder": false
}''')
response = requests.request(
"POST", url, headers=headers, json=payload
)
print(response.text)
const response = await fetch('http://localhost:7575/v2/updates/trees', {
method: 'POST',
headers: {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
},
body: JSON.stringify({
"beginExclusive": 123,
"endInclusive": 123,
"filter": {
"filtersByParty": {},
"filtersForAnyParty": {
"cumulative": [
{
"identifierFilter": {
"Empty": "<object>"
}
}
]
}
},
"verbose": false,
"updateFormat": {
"includeTransactions": {
"eventFormat": {
"filtersByParty": {},
"filtersForAnyParty": {
"cumulative": [
"<object>"
]
},
"verbose": false
},
"transactionShape": "TRANSACTION_SHAPE_UNSPECIFIED"
},
"includeReassignments": {
"filtersByParty": {},
"filtersForAnyParty": {
"cumulative": [
{
"identifierFilter": "<object>"
}
]
},
"verbose": false
},
"includeTopologyEvents": {
"includeParticipantAuthorizationEvents": {
"parties": [
"<string>"
]
}
}
},
"descendingOrder": false
}),
});
console.log(await response.text());
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => 'http://localhost:7575/v2/updates/trees',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_POSTFIELDS => <<<'JSON'
{
"beginExclusive": 123,
"endInclusive": 123,
"filter": {
"filtersByParty": {},
"filtersForAnyParty": {
"cumulative": [
{
"identifierFilter": {
"Empty": "<object>"
}
}
]
}
},
"verbose": false,
"updateFormat": {
"includeTransactions": {
"eventFormat": {
"filtersByParty": {},
"filtersForAnyParty": {
"cumulative": [
"<object>"
]
},
"verbose": false
},
"transactionShape": "TRANSACTION_SHAPE_UNSPECIFIED"
},
"includeReassignments": {
"filtersByParty": {},
"filtersForAnyParty": {
"cumulative": [
{
"identifierFilter": "<object>"
}
]
},
"verbose": false
},
"includeTopologyEvents": {
"includeParticipantAuthorizationEvents": {
"parties": [
"<string>"
]
}
}
},
"descendingOrder": false
}
JSON,
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
echo $response;
package main
import (
"bytes"
"fmt"
"io"
"net/http"
)
func main() {
req, _ := http.NewRequest("POST", "http://localhost:7575/v2/updates/trees", bytes.NewBufferString(`{
"beginExclusive": 123,
"endInclusive": 123,
"filter": {
"filtersByParty": {},
"filtersForAnyParty": {
"cumulative": [
{
"identifierFilter": {
"Empty": "<object>"
}
}
]
}
},
"verbose": false,
"updateFormat": {
"includeTransactions": {
"eventFormat": {
"filtersByParty": {},
"filtersForAnyParty": {
"cumulative": [
"<object>"
]
},
"verbose": false
},
"transactionShape": "TRANSACTION_SHAPE_UNSPECIFIED"
},
"includeReassignments": {
"filtersByParty": {},
"filtersForAnyParty": {
"cumulative": [
{
"identifierFilter": "<object>"
}
]
},
"verbose": false
},
"includeTopologyEvents": {
"includeParticipantAuthorizationEvents": {
"parties": [
"<string>"
]
}
}
},
"descendingOrder": false
}`))
req.Header.Set("Authorization", "Bearer <token>")
req.Header.Set("Content-Type", "application/json")
response, _ := http.DefaultClient.Do(req)
defer response.Body.Close()
body, _ := io.ReadAll(response.Body)
fmt.Println(string(body))
}
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
var request = HttpRequest.newBuilder()
.uri(URI.create("http://localhost:7575/v2/updates/trees"))
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("""
{
"beginExclusive": 123,
"endInclusive": 123,
"filter": {
"filtersByParty": {},
"filtersForAnyParty": {
"cumulative": [
{
"identifierFilter": {
"Empty": "<object>"
}
}
]
}
},
"verbose": false,
"updateFormat": {
"includeTransactions": {
"eventFormat": {
"filtersByParty": {},
"filtersForAnyParty": {
"cumulative": [
"<object>"
]
},
"verbose": false
},
"transactionShape": "TRANSACTION_SHAPE_UNSPECIFIED"
},
"includeReassignments": {
"filtersByParty": {},
"filtersForAnyParty": {
"cumulative": [
{
"identifierFilter": "<object>"
}
]
},
"verbose": false
},
"includeTopologyEvents": {
"includeParticipantAuthorizationEvents": {
"parties": [
"<string>"
]
}
}
},
"descendingOrder": false
}
"""))
.build();
var response = HttpClient.newHttpClient().send(
request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
require 'net/http'
require 'uri'
uri = URI('http://localhost:7575/v2/updates/trees')
request = Net::HTTP::Post.new(uri)
request['Authorization'] = 'Bearer <token>'
request['Content-Type'] = 'application/json'
request.body = <<~JSON
{
"beginExclusive": 123,
"endInclusive": 123,
"filter": {
"filtersByParty": {},
"filtersForAnyParty": {
"cumulative": [
{
"identifierFilter": {
"Empty": "<object>"
}
}
]
}
},
"verbose": false,
"updateFormat": {
"includeTransactions": {
"eventFormat": {
"filtersByParty": {},
"filtersForAnyParty": {
"cumulative": [
"<object>"
]
},
"verbose": false
},
"transactionShape": "TRANSACTION_SHAPE_UNSPECIFIED"
},
"includeReassignments": {
"filtersByParty": {},
"filtersForAnyParty": {
"cumulative": [
{
"identifierFilter": "<object>"
}
]
},
"verbose": false
},
"includeTopologyEvents": {
"includeParticipantAuthorizationEvents": {
"parties": [
"<string>"
]
}
}
},
"descendingOrder": false
}
JSON
response = Net::HTTP.start(uri.hostname, uri.port) do |http|
http.request(request)
end
puts response.body
[
{
"update": {
"OffsetCheckpoint": {
"value": {
"offset": 123,
"synchronizerTimes": [
"<object>"
]
}
}
}
}
]
<string>
{
"code": "<string>",
"cause": "<string>",
"correlationId": "<string>",
"traceId": "<string>",
"context": {},
"resources": [
[
"<string>"
]
],
"errorCategory": 123,
"grpcCodeValue": 123,
"retryInfo": "<string>",
"definiteAnswer": false
}
Authorizations
httpAuth
string
required
HTTP bearer authentication. Send the token as
Authorization: Bearer <token>. Ledger API standard JWT tokenapiKeyAuth
string
required
API key authentication in the header. Ledger API standard JWT token (websocket)
Query parameters
number
OpenAPI type:
integer (int64).maximum number of elements to return, this param is ignored if is bigger than server settingnumber
OpenAPI type:
integer (int64).timeout to complete and send result if no new elements are received (for open ended streams)Body
application/json
number
required
OpenAPI type:
integer (int64).Exclusive lower bound offset of the requested ledger section (non-negative integer). The response will only contain transactions whose offset is strictly greater than this. If set to zero, the lower bound is set to the beginning of the ledger. If the participant has been pruned, this parameter must be greater or equal than the pruning offset. Requirednumber
OpenAPI type:
integer (int64).Inclusive higher bound offset of the requested ledger section. If specified the response will only contain transactions whose offset is less than or equal to this. If not specified, - the descending_order must not be selected, - the stream will not terminate. Optionalobject
OpenAPI type:
TransactionFilter.Provided for backwards compatibility, it will be removed in the Canton version 3.5.0. Used both for filtering create and archive events as well as for filtering transaction trees.Show child attributes
Show child attributes
object
OpenAPI type:
Map_Filters.Each key must be a valid PartyIdString (as described in value.proto). The interpretation of the filter depends on the transaction-shape being filtered: 1. For transaction trees (used in GetUpdateTreesResponse for backwards compatibility) all party keys used as wildcard filters, and all subtrees whose root has one of the listed parties as an informee are returned. If there are CumulativeFilters, those will control returned CreatedEvent fields where applicable, but will not be used for template/interface filtering. 2. For ledger-effects create and exercise events are returned, for which the witnesses include at least one of the listed parties and match the per-party filter. 3. For transaction and active-contract-set streams create and archive events are returned for all contracts whose stakeholders include at least one of the listed parties and match the per-party filter.object
OpenAPI type:
Filters.The union of a set of template filters, interface filters, or a wildcard.Show child attributes
Show child attributes
object[]
OpenAPI type:
CumulativeFilter[].Every filter in the cumulative list expands the scope of the resulting stream. Each interface, template or wildcard filter means additional events that will match the query. The impact of include_interface_view and include_created_event_blob fields in the filters will also be accumulated. A template or an interface SHOULD NOT appear twice in the accumulative field. A wildcard filter SHOULD NOT be defined more than once in the accumulative field. If no CumulativeFilter defined, the default of a single WildcardFilter with include_created_event_blob unset is used. Optional: can be emptyShow child attributes
Show child attributes
object
OpenAPI type:
IdentifierFilter.RequiredShow child attributes
Show child attributes
object
Show child attributes
Show child attributes
object
required
OpenAPI type:
InterfaceFilter.This filter matches contracts that implement a specific interface.Show child attributes
Show child attributes
object
required
OpenAPI type:
InterfaceFilter1.This filter matches contracts that implement a specific interface.Show child attributes
Show child attributes
string
required
The interface that a matching contract must implement. The
interface_id needs to be valid: corresponding interface should be defined in one of the available packages at the time of the query. Both package-name and package-id reference formats for the identifier are supported. Note: The package-id reference identifier format is deprecated. We plan to end support for this format in version 3.4. Requiredboolean
Whether to include the interface view on the contract in the returned
CreatedEvent. Use this to access contract data in a uniform manner in your API client. Optionalboolean
Whether to include a
created_event_blob in the returned CreatedEvent. Use this to access the contract create event payload in your API client for submitting it as a disclosed contract with future commands. Optionalobject
Show child attributes
Show child attributes
object
required
OpenAPI type:
TemplateFilter.This filter matches contracts of a specific template.Show child attributes
Show child attributes
object
required
OpenAPI type:
TemplateFilter1.This filter matches contracts of a specific template.Show child attributes
Show child attributes
string
required
A template for which the payload should be included in the response. The
template_id needs to be valid: corresponding template should be defined in one of the available packages at the time of the query. Both package-name and package-id reference formats for the identifier are supported. Note: The package-id reference identifier format is deprecated. We plan to end support for this format in version 3.4. Requiredboolean
Whether to include a
created_event_blob in the returned CreatedEvent. Use this to access the contract event payload in your API client for submitting it as a disclosed contract with future commands. Optionalobject
Show child attributes
Show child attributes
object
required
OpenAPI type:
WildcardFilter.This filter matches all templates.Show child attributes
Show child attributes
object
required
OpenAPI type:
WildcardFilter1.This filter matches all templates.Show child attributes
Show child attributes
boolean
Whether to include a
created_event_blob in the returned CreatedEvent. Use this to access the contract create event payload in your API client for submitting it as a disclosed contract with future commands. Optionalboolean
Provided for backwards compatibility, it will be removed in the Canton version 3.5.0. If enabled, values served over the API will contain more information than strictly necessary to interpret the data. In particular, setting the verbose flag to true triggers the ledger to include labels, record and variant type ids for record fields. Optional for backwards compatibility, if defined update_format must be unset
object
OpenAPI type:
UpdateFormat.A format specifying what updates to include and how to render them.Show child attributes
Show child attributes
object
OpenAPI type:
TransactionFormat.A format that specifies what events to include in Daml transactions and what data to compute and include for them.Show child attributes
Show child attributes
object
required
OpenAPI type:
EventFormat.A format for events which defines both which events should be included and what data should be computed and included for them. Note that some of the filtering behavior depends on the TransactionShape, which is expected to be specified alongside usages of EventFormat.Show child attributes
Show child attributes
object
OpenAPI type:
Map_Filters.Each key must be a valid PartyIdString (as described in value.proto). The interpretation of the filter depends on the transaction-shape being filtered: 1. For ledger-effects create and exercise events are returned, for which the witnesses include at least one of the listed parties and match the per-party filter. 2. For transaction and active-contract-set streams create and archive events are returned for all contracts whose stakeholders include at least one of the listed parties and match the per-party filter. Optional: can be emptyobject
OpenAPI type:
Filters.The union of a set of template filters, interface filters, or a wildcard.Show child attributes
Show child attributes
object[]
OpenAPI type:
CumulativeFilter[].Every filter in the cumulative list expands the scope of the resulting stream. Each interface, template or wildcard filter means additional events that will match the query. The impact of include_interface_view and include_created_event_blob fields in the filters will also be accumulated. A template or an interface SHOULD NOT appear twice in the accumulative field. A wildcard filter SHOULD NOT be defined more than once in the accumulative field. If no CumulativeFilter defined, the default of a single WildcardFilter with include_created_event_blob unset is used. Optional: can be emptyShow child attributes
Show child attributes
object
OpenAPI type:
IdentifierFilter.RequiredShow child attributes
Show child attributes
object
Show child attributes
Show child attributes
object
required
OpenAPI type:
InterfaceFilter.This filter matches contracts that implement a specific interface.Show child attributes
Show child attributes
object
required
OpenAPI type:
InterfaceFilter1.This filter matches contracts that implement a specific interface.Show child attributes
Show child attributes
string
required
The interface that a matching contract must implement. The
interface_id needs to be valid: corresponding interface should be defined in one of the available packages at the time of the query. Both package-name and package-id reference formats for the identifier are supported. Note: The package-id reference identifier format is deprecated. We plan to end support for this format in version 3.4. Requiredboolean
Whether to include the interface view on the contract in the returned
CreatedEvent. Use this to access contract data in a uniform manner in your API client. Optionalboolean
Whether to include a
created_event_blob in the returned CreatedEvent. Use this to access the contract create event payload in your API client for submitting it as a disclosed contract with future commands. Optionalobject
Show child attributes
Show child attributes
object
required
OpenAPI type:
TemplateFilter.This filter matches contracts of a specific template.Show child attributes
Show child attributes
object
required
OpenAPI type:
TemplateFilter1.This filter matches contracts of a specific template.Show child attributes
Show child attributes
string
required
A template for which the payload should be included in the response. The
template_id needs to be valid: corresponding template should be defined in one of the available packages at the time of the query. Both package-name and package-id reference formats for the identifier are supported. Note: The package-id reference identifier format is deprecated. We plan to end support for this format in version 3.4. Requiredboolean
Whether to include a
created_event_blob in the returned CreatedEvent. Use this to access the contract event payload in your API client for submitting it as a disclosed contract with future commands. Optionalobject
Show child attributes
Show child attributes
object
required
OpenAPI type:
WildcardFilter.This filter matches all templates.Show child attributes
Show child attributes
object
required
OpenAPI type:
WildcardFilter1.This filter matches all templates.Show child attributes
Show child attributes
boolean
Whether to include a
created_event_blob in the returned CreatedEvent. Use this to access the contract create event payload in your API client for submitting it as a disclosed contract with future commands. Optionalboolean
If enabled, values served over the API will contain more information than strictly necessary to interpret the data. In particular, setting the verbose flag to true triggers the ledger to include labels for record fields. Optional
string
required
What transaction shape to use for interpreting the filters of the event format. RequiredAllowed values:
TRANSACTION_SHAPE_UNSPECIFIED, TRANSACTION_SHAPE_ACS_DELTA, TRANSACTION_SHAPE_LEDGER_EFFECTS.object
OpenAPI type:
EventFormat.A format for events which defines both which events should be included and what data should be computed and included for them. Note that some of the filtering behavior depends on the TransactionShape, which is expected to be specified alongside usages of EventFormat.Show child attributes
Show child attributes
object
OpenAPI type:
Map_Filters.Each key must be a valid PartyIdString (as described in value.proto). The interpretation of the filter depends on the transaction-shape being filtered: 1. For ledger-effects create and exercise events are returned, for which the witnesses include at least one of the listed parties and match the per-party filter. 2. For transaction and active-contract-set streams create and archive events are returned for all contracts whose stakeholders include at least one of the listed parties and match the per-party filter. Optional: can be emptyobject
OpenAPI type:
Filters.The union of a set of template filters, interface filters, or a wildcard.Show child attributes
Show child attributes
object[]
OpenAPI type:
CumulativeFilter[].Every filter in the cumulative list expands the scope of the resulting stream. Each interface, template or wildcard filter means additional events that will match the query. The impact of include_interface_view and include_created_event_blob fields in the filters will also be accumulated. A template or an interface SHOULD NOT appear twice in the accumulative field. A wildcard filter SHOULD NOT be defined more than once in the accumulative field. If no CumulativeFilter defined, the default of a single WildcardFilter with include_created_event_blob unset is used. Optional: can be emptyShow child attributes
Show child attributes
object
OpenAPI type:
IdentifierFilter.RequiredShow child attributes
Show child attributes
object
Show child attributes
Show child attributes
object
required
OpenAPI type:
InterfaceFilter.This filter matches contracts that implement a specific interface.Show child attributes
Show child attributes
object
required
OpenAPI type:
InterfaceFilter1.This filter matches contracts that implement a specific interface.Show child attributes
Show child attributes
string
required
The interface that a matching contract must implement. The
interface_id needs to be valid: corresponding interface should be defined in one of the available packages at the time of the query. Both package-name and package-id reference formats for the identifier are supported. Note: The package-id reference identifier format is deprecated. We plan to end support for this format in version 3.4. Requiredboolean
Whether to include the interface view on the contract in the returned
CreatedEvent. Use this to access contract data in a uniform manner in your API client. Optionalboolean
Whether to include a
created_event_blob in the returned CreatedEvent. Use this to access the contract create event payload in your API client for submitting it as a disclosed contract with future commands. Optionalobject
Show child attributes
Show child attributes
object
required
OpenAPI type:
TemplateFilter.This filter matches contracts of a specific template.Show child attributes
Show child attributes
object
required
OpenAPI type:
TemplateFilter1.This filter matches contracts of a specific template.Show child attributes
Show child attributes
string
required
A template for which the payload should be included in the response. The
template_id needs to be valid: corresponding template should be defined in one of the available packages at the time of the query. Both package-name and package-id reference formats for the identifier are supported. Note: The package-id reference identifier format is deprecated. We plan to end support for this format in version 3.4. Requiredboolean
Whether to include a
created_event_blob in the returned CreatedEvent. Use this to access the contract event payload in your API client for submitting it as a disclosed contract with future commands. Optionalobject
Show child attributes
Show child attributes
object
required
OpenAPI type:
WildcardFilter.This filter matches all templates.Show child attributes
Show child attributes
object
required
OpenAPI type:
WildcardFilter1.This filter matches all templates.Show child attributes
Show child attributes
boolean
Whether to include a
created_event_blob in the returned CreatedEvent. Use this to access the contract create event payload in your API client for submitting it as a disclosed contract with future commands. Optionalboolean
If enabled, values served over the API will contain more information than strictly necessary to interpret the data. In particular, setting the verbose flag to true triggers the ledger to include labels for record fields. Optional
object
OpenAPI type:
TopologyFormat.A format specifying which topology transactions to include and how to render them.Show child attributes
Show child attributes
object
OpenAPI type:
ParticipantAuthorizationTopologyFormat.A format specifying which participant authorization topology transactions to include and how to render them.Show child attributes
Show child attributes
string[]
List of parties for which the topology transactions should be sent. Empty means: for all parties. Optional: can be empty
boolean
If set, the stream will populate the elements in descending order. Optional
Responses
200
application/json
JsGetUpdateTreesResponse[]
required
Show child attributes
Show child attributes
Update1
Show child attributes
Show child attributes
object
Show child attributes
Show child attributes
OffsetCheckpoint3
required
OffsetCheckpoints may be used to: - detect time out of commands. - provide an offset which can be used to restart consumption.
Show child attributes
Show child attributes
OffsetCheckpoint1
required
OffsetCheckpoints may be used to: - detect time out of commands. - provide an offset which can be used to restart consumption.
Show child attributes
Show child attributes
integer (int64)
required
The participant’s offset, the details of the offset field are described in
community/ledger-api/README.md. Must be a valid absolute offset (positive integer). RequiredSynchronizerTime[]
The times associated with each synchronizer at this offset. Optional: can be empty
object
Show child attributes
Show child attributes
Reassignment1
required
Complete view of an on-ledger reassignment.
Show child attributes
Show child attributes
JsReassignment
required
Complete view of an on-ledger reassignment.
Show child attributes
Show child attributes
string
required
Assigned by the server. Useful for correlating logs. Must be a valid LedgerString (as described in
value.proto). Requiredstring
The ID of the command which resulted in this reassignment. Missing for everyone except the submitting party on the submitting participant. Must be a valid LedgerString (as described in
value.proto). Optionalstring
The workflow ID used in reassignment command submission. Only set if the
workflow_id for the command was set. Must be a valid LedgerString (as described in value.proto). Optionalinteger (int64)
required
The participant’s offset. The details of this field are described in
community/ledger-api/README.md. Must be a valid absolute offset (positive integer). RequiredJsReassignmentEvent[]
required
The collection of reassignment events. Required: must be non-empty
Show child attributes
Show child attributes
object
Show child attributes
Show child attributes
JsAssignmentEvent
required
Show child attributes
Show child attributes
string
required
string
required
string
required
string
required
integer (int64)
required
CreatedEvent
required
Records that a contract has been created, and choices may now be exercised on it.
Show child attributes
Show child attributes
integer (int64)
required
The offset of origin, which has contextual meaning, please see description at messages that include a CreatedEvent. Offsets are managed by the participant nodes. Transactions can thus NOT be assumed to have the same offsets on different participant nodes. It is a valid absolute offset (positive integer) Required
integer (int32)
required
The position of this event in the originating transaction or reassignment. The origin has contextual meaning, please see description at messages that include a CreatedEvent. Node IDs are not necessarily equal across participants, as these may see different projections/parts of transactions. Must be valid node ID (non-negative integer) Required
string
required
The ID of the created contract. Must be a valid LedgerString (as described in
value.proto). Requiredstring
required
The template of the created contract. The identifier uses the package-id reference format. Required
object
The key of the created contract. This will be set if and only if
template_id defines a contract key. Optionalstring
The hash of contract_key. This will be set if and only if
template_id defines a contract key. Optional: can be emptyobject
required
The arguments that have been used to create the contract. Required
string
Opaque representation of contract create event payload intended for forwarding to an API server as a contract disclosed as part of a command submission. Optional: can be empty
JsInterfaceView[]
Interface views specified in the transaction filter. Includes an
InterfaceView for each interface for which there is a InterfaceFilter with - its party in the witness_parties of this event, - and which is implemented by the template of this event, - and which has include_interface_view set. Optional: can be emptyShow child attributes
Show child attributes
string
required
The interface implemented by the matched event. The identifier uses the package-id reference format. Required
JsStatus
required
object
The value of the interface’s view method on this event. Set if it was requested in the
InterfaceFilter and it could be successfully computed. Optionalstring
The package defining the interface implementation used to compute the view. Can be different from the package that was used to create the contract itself, as the contract arguments can be upgraded or downgraded using smart-contract upgrading as part of computing the interface view. Populated if the view computation is successful, otherwise empty. Optional
string[]
required
The parties that are notified of this event. When a
CreatedEvent is returned as part of a transaction tree or ledger-effects transaction, this will include all the parties specified in the TransactionFilter that are witnesses of the event (the stakeholders of the contract and all informees of all the ancestors of this create action that this participant knows about). If served as part of a ACS delta transaction those will be limited to all parties specified in the TransactionFilter that are stakeholders of the contract (i.e. either signatories or observers). If the CreatedEvent is returned as part of an AssignedEvent, ActiveContract or IncompleteUnassigned (so the event is related to an assignment or unassignment): this will include all parties of the TransactionFilter that are stakeholders of the contract. The behavior of reading create events visible to parties not hosted on the participant node serving the Ledger API is undefined. Concretely, there is neither a guarantee that the participant node will serve all their create events on the ACS stream, nor is there a guarantee that matching archive events are delivered for such create events. For most clients this is not a problem, as they only read events for parties that are hosted on the participant node. If you need to read events for parties that may not be hosted at all times on the participant node, subscribe to the TopologyEvents for that party by setting a corresponding UpdateFormat. Using these events, query the ACS as-of an offset where the party is hosted on the participant node, and ignore create events at offsets where the party is not hosted on the participant node. Required: must be non-emptystring[]
required
The signatories for this contract as specified by the template. Required: must be non-empty
string[]
The observers for this contract as specified explicitly by the template or implicitly as choice controllers. This field never contains parties that are signatories. Optional: can be empty
string
required
Ledger effective time of the transaction that created the contract. Required
string
required
The package name of the created contract. Required
string
required
A package-id present in the participant package store that typechecks the contract’s argument. This may differ from the package-id of the template used to create the contract. For contracts created before Canton 3.4, this field matches the contract’s creation package-id. NOTE: Experimental, server internal concept, not for client consumption. Subject to change without notice. Required
boolean
required
Whether this event would be part of respective ACS_DELTA shaped stream, and should therefore considered when tracking contract activeness on the client-side. Required
object
Show child attributes
Show child attributes
JsUnassignedEvent
required
Records that a contract has been unassigned, and it becomes unusable on the source synchronizer
Show child attributes
Show child attributes
UnassignedEvent
required
Records that a contract has been unassigned, and it becomes unusable on the source synchronizer
Show child attributes
Show child attributes
string
required
The ID of the unassignment. This needs to be used as an input for a assign ReassignmentCommand. Must be a valid LedgerString (as described in
value.proto). Requiredstring
required
The ID of the reassigned contract. Must be a valid LedgerString (as described in
value.proto). Requiredstring
required
The template of the reassigned contract. The identifier uses the package-id reference format. Required
string
required
The ID of the source synchronizer Must be a valid synchronizer id Required
string
required
The ID of the target synchronizer Must be a valid synchronizer id Required
string
Party on whose behalf the unassign command was executed. Empty if the unassignment happened offline via the repair service. Must be a valid PartyIdString (as described in
value.proto). Optionalinteger (int64)
required
Each corresponding assigned and unassigned event has the same reassignment_counter. This strictly increases with each unassign command for the same contract. Creation of the contract corresponds to reassignment_counter equals zero. Required
string
Assignment exclusivity Before this time (measured on the target synchronizer), only the submitter of the unassignment can initiate the assignment Defined for reassigning participants. Optional
string[]
required
The parties that are notified of this event. Required: must be non-empty
string
required
The package name of the contract. Required
integer (int64)
required
The offset of origin. Offsets are managed by the participant nodes. Reassignments can thus NOT be assumed to have the same offsets on different participant nodes. Must be a valid absolute offset (positive integer) Required
integer (int32)
required
The position of this event in the originating reassignment. Node IDs are not necessarily equal across participants, as these may see different projections/parts of reassignments. Must be valid node ID (non-negative integer) Required
TraceContext
Ledger API trace context The trace context transported in this message corresponds to the trace context supplied by the client application in a HTTP2 header of the original command submission. We typically use a header to transfer this type of information. Here we use message body, because it is used in gRPC streams which do not support per message headers. This field will be populated with the trace context contained in the original submission. If that was not provided, a unique ledger-api-server generated trace context will be used instead. Optional
Show child attributes
Show child attributes
string
https://www.w3.org/TR/trace-context/ Optional
string
Optional
string
required
The time at which the reassignment was recorded. The record time refers to the source/target synchronizer for an unassign/assign event respectively. Required
string
required
A valid synchronizer id. Identifies the synchronizer that synchronized this Reassignment. Required
integer (int64)
The traffic cost that this participant node paid for the corresponding (un)assignment request. Not set for transactions that were - initiated by another participant - initiated offline via the repair service - processed before the participant started serving traffic cost on the Ledger API - returned as part of a query filtering for a non submitting party Optional
object
Show child attributes
Show child attributes
TransactionTree
required
Provided for backwards compatibility, it will be removed in the Canton version 3.5.0. Complete view of an on-ledger transaction.
Show child attributes
Show child attributes
JsTransactionTree
required
Provided for backwards compatibility, it will be removed in the Canton version 3.5.0. Complete view of an on-ledger transaction.
Show child attributes
Show child attributes
string
required
Assigned by the server. Useful for correlating logs. Must be a valid LedgerString (as described in
value.proto). Requiredstring
The ID of the command which resulted in this transaction. Missing for everyone except the submitting party. Must be a valid LedgerString (as described in
value.proto). Optionalstring
The workflow ID used in command submission. Only set if the
workflow_id for the command was set. Must be a valid LedgerString (as described in value.proto). Optionalstring
required
Ledger effective time. Required
integer (int64)
required
The absolute offset. The details of this field are described in
community/ledger-api/README.md. Required, it is a valid absolute offset (positive integer).Map_Int_TreeEvent
required
Changes to the ledger that were caused by this transaction. Nodes of the transaction tree. Each key must be a valid node ID (non-negative integer). Required
string
required
A valid synchronizer id. Identifies the synchronizer that synchronized the transaction. Required
TraceContext
Optional; ledger API trace context The trace context transported in this message corresponds to the trace context supplied by the client application in a HTTP2 header of the original command submission. We typically use a header to transfer this type of information. Here we use message body, because it is used in gRPC streams which do not support per message headers. This field will be populated with the trace context contained in the original submission. If that was not provided, a unique ledger-api-server generated trace context will be used instead.
Show child attributes
Show child attributes
string
https://www.w3.org/TR/trace-context/ Optional
string
Optional
string
required
The time at which the transaction was recorded. The record time refers to the synchronizer which synchronized the transaction. Required
400
Invalid value, Invalid value for: body, Invalid value for: query parameter limit, Invalid value for: query parameter stream_idle_timeout_mstext/plain
string
required
default
application/json
string
required
string
required
string
string
Map_String
required
Tuple2_String_String[]
integer (int32)
required
integer (int32)
string
boolean
History
Removal scheduled
3.5.0Updated
3.5The POST /v2/updates/trees operation changed in this snapshot.
Deprecated
3.4