curl --request POST \
--url 'http://localhost:7575/v2/updates' \
--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"
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', {
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',
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", 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"))
.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')
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
Read the ledger’s filtered update stream for the specified contents and filters. It returns the event types in accordance with the stream contents selected. Also the selection criteria for individual events depends on the transaction shape chosen. - ACS delta: a requesting party must be a stakeholder of an event for it to be included. - ledger effects: a requesting party must be a witness of an event for it to be included.
curl --request POST \
--url 'http://localhost:7575/v2/updates' \
--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"
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', {
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',
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", 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"))
.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')
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
}
Read the ledger’s filtered update stream for the specified contents and filters. It returns the event types in accordance with the stream contents selected. Also the selection criteria for individual events depends on the transaction shape chosen. - ACS delta: a requesting party must be a stakeholder of an event for it to be included. - ledger effects: a requesting party must be a witness of an event for it to be included.
curl --request POST \
--url 'http://localhost:7575/v2/updates' \
--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"
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', {
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',
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", 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"))
.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')
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
Authorization: Bearer <token>. Ledger API standard JWT tokenapiKeyAuth
Query parameters
integer (int64).maximum number of elements to return, this param is ignored if is bigger than server settinginteger (int64).timeout to complete and send result if no new elements are received (for open ended streams)Body
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. Requiredinteger (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. OptionalTransactionFilter.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
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.Filters.The union of a set of template filters, interface filters, or a wildcard.Show child attributes
Show child attributes
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
IdentifierFilter.RequiredShow child attributes
Show child attributes
Show child attributes
Show child attributes
InterfaceFilter.This filter matches contracts that implement a specific interface.Show child attributes
Show child attributes
InterfaceFilter1.This filter matches contracts that implement a specific interface.Show child attributes
Show child attributes
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. RequiredCreatedEvent. Use this to access contract data in a uniform manner in your API client. Optionalcreated_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. OptionalShow child attributes
Show child attributes
TemplateFilter.This filter matches contracts of a specific template.Show child attributes
Show child attributes
TemplateFilter1.This filter matches contracts of a specific template.Show child attributes
Show child attributes
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. Requiredcreated_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. OptionalShow child attributes
Show child attributes
WildcardFilter.This filter matches all templates.Show child attributes
Show child attributes
WildcardFilter1.This filter matches all templates.Show child attributes
Show child attributes
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. OptionalUpdateFormat.A format specifying what updates to include and how to render them.Show child attributes
Show child attributes
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
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
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 emptyFilters.The union of a set of template filters, interface filters, or a wildcard.Show child attributes
Show child attributes
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
IdentifierFilter.RequiredShow child attributes
Show child attributes
Show child attributes
Show child attributes
InterfaceFilter.This filter matches contracts that implement a specific interface.Show child attributes
Show child attributes
InterfaceFilter1.This filter matches contracts that implement a specific interface.Show child attributes
Show child attributes
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. RequiredCreatedEvent. Use this to access contract data in a uniform manner in your API client. Optionalcreated_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. OptionalShow child attributes
Show child attributes
TemplateFilter.This filter matches contracts of a specific template.Show child attributes
Show child attributes
TemplateFilter1.This filter matches contracts of a specific template.Show child attributes
Show child attributes
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. Requiredcreated_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. OptionalShow child attributes
Show child attributes
WildcardFilter.This filter matches all templates.Show child attributes
Show child attributes
WildcardFilter1.This filter matches all templates.Show child attributes
Show child attributes
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. OptionalTRANSACTION_SHAPE_UNSPECIFIED, TRANSACTION_SHAPE_ACS_DELTA, TRANSACTION_SHAPE_LEDGER_EFFECTS.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
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 emptyFilters.The union of a set of template filters, interface filters, or a wildcard.Show child attributes
Show child attributes
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
IdentifierFilter.RequiredShow child attributes
Show child attributes
Show child attributes
Show child attributes
InterfaceFilter.This filter matches contracts that implement a specific interface.Show child attributes
Show child attributes
InterfaceFilter1.This filter matches contracts that implement a specific interface.Show child attributes
Show child attributes
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. RequiredCreatedEvent. Use this to access contract data in a uniform manner in your API client. Optionalcreated_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. OptionalShow child attributes
Show child attributes
TemplateFilter.This filter matches contracts of a specific template.Show child attributes
Show child attributes
TemplateFilter1.This filter matches contracts of a specific template.Show child attributes
Show child attributes
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. Requiredcreated_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. OptionalShow child attributes
Show child attributes
WildcardFilter.This filter matches all templates.Show child attributes
Show child attributes
WildcardFilter1.This filter matches all templates.Show child attributes
Show child attributes
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. OptionalTopologyFormat.A format specifying which topology transactions to include and how to render them.Show child attributes
Show child attributes
ParticipantAuthorizationTopologyFormat.A format specifying which participant authorization topology transactions to include and how to render them.Show child attributes
Show child attributes
Responses
200
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
community/ledger-api/README.md. Must be a valid absolute offset (positive integer). RequiredShow child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
value.proto). Requiredvalue.proto). Optionalworkflow_id for the command was set. Must be a valid LedgerString (as described in value.proto). Optionalcommunity/ledger-api/README.md. Must be a valid absolute offset (positive integer). RequiredShow child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
value.proto). Requiredtemplate_id defines a contract key. Optionaltemplate_id defines a contract key. Optional: can be emptyInterfaceView 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
InterfaceFilter and it could be successfully computed. OptionalCreatedEvent 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-emptyShow child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
value.proto). Requiredvalue.proto). Requiredvalue.proto). OptionalShow child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
value.proto). Requiredcommunity/ledger-api/README.md. It is a valid absolute offset (positive integer). RequiredShow child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
value.proto). Requiredvalue.proto). Optionalvalue.proto). OptionalCreatedEvent or ArchivedEvent in case of ACS_DELTA transaction shape - CreatedEvent or ExercisedEvent in case of LEDGER_EFFECTS transaction shape Required: must be non-emptyShow child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
value.proto). RequiredArchivedEvent, these are the intersection of the stakeholders of the contract in question and the parties specified in the TransactionFilter. The stakeholders are the union of the signatories and the observers of the contract. Each one of its elements must be a valid PartyIdString (as described in value.proto). Required: must be non-emptyShow child attributes
Show child attributes
Show child attributes
Show child attributes
value.proto). Requiredtemplate_id defines a contract key. Optionaltemplate_id defines a contract key. Optional: can be emptyInterfaceView 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
InterfaceFilter and it could be successfully computed. OptionalCreatedEvent 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-emptyShow child attributes
Show child attributes
Show child attributes
Show child attributes
value.proto). Requiredvalue.proto). Requiredvalue.proto). Required: must be non-emptychoice ... controller syntax, and said controllers are not explicitly marked as observers. Each element must be a valid PartyIdString (as described in value.proto). Required: must be non-emptyExercisedEvent. This allows unambiguous identification of all the members of the subtree rooted at this node. A full subtree can be constructed when all descendant nodes are present in the stream. If nodes are heavily filtered, it is only possible to determine if a node is in a consequent subtree or not. Requiredcommunity/ledger-api/README.md. It is a valid absolute offset (positive integer). RequiredShow child attributes
Show child attributes
400
Invalid value, Invalid value for: body, Invalid value for: query parameter limit, Invalid value for: query parameter stream_idle_timeout_msdefault
History
3.5The POST /v2/updates operation was updated in this snapshot.
3.4