curl --request POST \
--url 'https://scan.sv-1.global.canton.network.sync.global/api/scan/v1/updates' \
--header 'Content-Type: application/json' \
--data '{
"after": {
"after_migration_id": 123,
"after_record_time": "<string>"
},
"page_size": 123,
"daml_value_encoding": "compact_json"
}'
import json
import requests
url = "https://scan.sv-1.global.canton.network.sync.global/api/scan/v1/updates"
headers = {'Content-Type': 'application/json'}
payload = json.loads(r'''{
"after": {
"after_migration_id": 123,
"after_record_time": "<string>"
},
"page_size": 123,
"daml_value_encoding": "compact_json"
}''')
response = requests.request(
"POST", url, headers=headers, json=payload
)
print(response.text)
const response = await fetch('https://scan.sv-1.global.canton.network.sync.global/api/scan/v1/updates', {
method: 'POST',
headers: {
"Content-Type": "application/json"
},
body: JSON.stringify({
"after": {
"after_migration_id": 123,
"after_record_time": "<string>"
},
"page_size": 123,
"daml_value_encoding": "compact_json"
}),
});
console.log(await response.text());
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => 'https://scan.sv-1.global.canton.network.sync.global/api/scan/v1/updates',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_POSTFIELDS => <<<'JSON'
{
"after": {
"after_migration_id": 123,
"after_record_time": "<string>"
},
"page_size": 123,
"daml_value_encoding": "compact_json"
}
JSON,
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
echo $response;
package main
import (
"bytes"
"fmt"
"io"
"net/http"
)
func main() {
req, _ := http.NewRequest("POST", "https://scan.sv-1.global.canton.network.sync.global/api/scan/v1/updates", bytes.NewBufferString(`{
"after": {
"after_migration_id": 123,
"after_record_time": "<string>"
},
"page_size": 123,
"daml_value_encoding": "compact_json"
}`))
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("https://scan.sv-1.global.canton.network.sync.global/api/scan/v1/updates"))
.header("Content-Type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("""
{
"after": {
"after_migration_id": 123,
"after_record_time": "<string>"
},
"page_size": 123,
"daml_value_encoding": "compact_json"
}
"""))
.build();
var response = HttpClient.newHttpClient().send(
request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
require 'net/http'
require 'uri'
uri = URI('https://scan.sv-1.global.canton.network.sync.global/api/scan/v1/updates')
request = Net::HTTP::Post.new(uri)
request['Content-Type'] = 'application/json'
request.body = <<~JSON
{
"after": {
"after_migration_id": 123,
"after_record_time": "<string>"
},
"page_size": 123,
"daml_value_encoding": "compact_json"
}
JSON
response = Net::HTTP.start(uri.hostname, uri.port) do |http|
http.request(request)
end
puts response.body
{
"transactions": [
{
"update_id": "<string>",
"migration_id": 123,
"workflow_id": "<string>",
"record_time": "<string>",
"synchronizer_id": "<string>",
"effective_at": "<string>",
"offset": "<string>",
"root_event_ids": [
"<string>"
],
"events_by_id": {},
"external_transaction_hash": "<string>"
}
]
}
{
"error": "<string>"
}
{
"error": "<string>"
}
POST /v1/updates
Returns the update history in ascending order, paged, from ledger begin or optionally starting after a record time. Unlike /v0/updates, this endpoint returns responses that are consistent across different scan instances. Event ids returned by this endpoint are not comparable to event ids returned by /v0/updates. Updates are ordered lexicographically by (migration id, record time). For a given migration id, each update has a unique record time.
POST
/
api
/
scan
/
v1
/
updates
curl --request POST \
--url 'https://scan.sv-1.global.canton.network.sync.global/api/scan/v1/updates' \
--header 'Content-Type: application/json' \
--data '{
"after": {
"after_migration_id": 123,
"after_record_time": "<string>"
},
"page_size": 123,
"daml_value_encoding": "compact_json"
}'
import json
import requests
url = "https://scan.sv-1.global.canton.network.sync.global/api/scan/v1/updates"
headers = {'Content-Type': 'application/json'}
payload = json.loads(r'''{
"after": {
"after_migration_id": 123,
"after_record_time": "<string>"
},
"page_size": 123,
"daml_value_encoding": "compact_json"
}''')
response = requests.request(
"POST", url, headers=headers, json=payload
)
print(response.text)
const response = await fetch('https://scan.sv-1.global.canton.network.sync.global/api/scan/v1/updates', {
method: 'POST',
headers: {
"Content-Type": "application/json"
},
body: JSON.stringify({
"after": {
"after_migration_id": 123,
"after_record_time": "<string>"
},
"page_size": 123,
"daml_value_encoding": "compact_json"
}),
});
console.log(await response.text());
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => 'https://scan.sv-1.global.canton.network.sync.global/api/scan/v1/updates',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_POSTFIELDS => <<<'JSON'
{
"after": {
"after_migration_id": 123,
"after_record_time": "<string>"
},
"page_size": 123,
"daml_value_encoding": "compact_json"
}
JSON,
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
echo $response;
package main
import (
"bytes"
"fmt"
"io"
"net/http"
)
func main() {
req, _ := http.NewRequest("POST", "https://scan.sv-1.global.canton.network.sync.global/api/scan/v1/updates", bytes.NewBufferString(`{
"after": {
"after_migration_id": 123,
"after_record_time": "<string>"
},
"page_size": 123,
"daml_value_encoding": "compact_json"
}`))
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("https://scan.sv-1.global.canton.network.sync.global/api/scan/v1/updates"))
.header("Content-Type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("""
{
"after": {
"after_migration_id": 123,
"after_record_time": "<string>"
},
"page_size": 123,
"daml_value_encoding": "compact_json"
}
"""))
.build();
var response = HttpClient.newHttpClient().send(
request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
require 'net/http'
require 'uri'
uri = URI('https://scan.sv-1.global.canton.network.sync.global/api/scan/v1/updates')
request = Net::HTTP::Post.new(uri)
request['Content-Type'] = 'application/json'
request.body = <<~JSON
{
"after": {
"after_migration_id": 123,
"after_record_time": "<string>"
},
"page_size": 123,
"daml_value_encoding": "compact_json"
}
JSON
response = Net::HTTP.start(uri.hostname, uri.port) do |http|
http.request(request)
end
puts response.body
{
"transactions": [
{
"update_id": "<string>",
"migration_id": 123,
"workflow_id": "<string>",
"record_time": "<string>",
"synchronizer_id": "<string>",
"effective_at": "<string>",
"offset": "<string>",
"root_event_ids": [
"<string>"
],
"events_by_id": {},
"external_transaction_hash": "<string>"
}
]
}
{
"error": "<string>"
}
{
"error": "<string>"
}
Returns the update history in ascending order, paged, from ledger begin or optionally starting after a record time. Unlike /v0/updates, this endpoint returns responses that are consistent across different scan instances. Event ids returned by this endpoint are not comparable to event ids returned by /v0/updates. Updates are ordered lexicographically by (migration id, record time). For a given migration id, each update has a unique record time.
curl --request POST \
--url 'https://scan.sv-1.global.canton.network.sync.global/api/scan/v1/updates' \
--header 'Content-Type: application/json' \
--data '{
"after": {
"after_migration_id": 123,
"after_record_time": "<string>"
},
"page_size": 123,
"daml_value_encoding": "compact_json"
}'
import json
import requests
url = "https://scan.sv-1.global.canton.network.sync.global/api/scan/v1/updates"
headers = {'Content-Type': 'application/json'}
payload = json.loads(r'''{
"after": {
"after_migration_id": 123,
"after_record_time": "<string>"
},
"page_size": 123,
"daml_value_encoding": "compact_json"
}''')
response = requests.request(
"POST", url, headers=headers, json=payload
)
print(response.text)
const response = await fetch('https://scan.sv-1.global.canton.network.sync.global/api/scan/v1/updates', {
method: 'POST',
headers: {
"Content-Type": "application/json"
},
body: JSON.stringify({
"after": {
"after_migration_id": 123,
"after_record_time": "<string>"
},
"page_size": 123,
"daml_value_encoding": "compact_json"
}),
});
console.log(await response.text());
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => 'https://scan.sv-1.global.canton.network.sync.global/api/scan/v1/updates',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_POSTFIELDS => <<<'JSON'
{
"after": {
"after_migration_id": 123,
"after_record_time": "<string>"
},
"page_size": 123,
"daml_value_encoding": "compact_json"
}
JSON,
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
echo $response;
package main
import (
"bytes"
"fmt"
"io"
"net/http"
)
func main() {
req, _ := http.NewRequest("POST", "https://scan.sv-1.global.canton.network.sync.global/api/scan/v1/updates", bytes.NewBufferString(`{
"after": {
"after_migration_id": 123,
"after_record_time": "<string>"
},
"page_size": 123,
"daml_value_encoding": "compact_json"
}`))
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("https://scan.sv-1.global.canton.network.sync.global/api/scan/v1/updates"))
.header("Content-Type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("""
{
"after": {
"after_migration_id": 123,
"after_record_time": "<string>"
},
"page_size": 123,
"daml_value_encoding": "compact_json"
}
"""))
.build();
var response = HttpClient.newHttpClient().send(
request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
require 'net/http'
require 'uri'
uri = URI('https://scan.sv-1.global.canton.network.sync.global/api/scan/v1/updates')
request = Net::HTTP::Post.new(uri)
request['Content-Type'] = 'application/json'
request.body = <<~JSON
{
"after": {
"after_migration_id": 123,
"after_record_time": "<string>"
},
"page_size": 123,
"daml_value_encoding": "compact_json"
}
JSON
response = Net::HTTP.start(uri.hostname, uri.port) do |http|
http.request(request)
end
puts response.body
{
"transactions": [
{
"update_id": "<string>",
"migration_id": 123,
"workflow_id": "<string>",
"record_time": "<string>",
"synchronizer_id": "<string>",
"effective_at": "<string>",
"offset": "<string>",
"root_event_ids": [
"<string>"
],
"events_by_id": {},
"external_transaction_hash": "<string>"
}
]
}
{
"error": "<string>"
}
{
"error": "<string>"
}
Body
application/json
object
OpenAPI type:
UpdateHistoryRequestAfter.The transactions returned will either have a higher migration id or the same migration id and a record_time greater than the migration id and record time specified.Show child attributes
Show child attributes
number
required
OpenAPI type:
integer (int64).The migration id from which to start returning transactions. This is inclusive.string
required
The record time to start returning transactions from. This only affects transactions with the same migration id as after_migration_id. Higher migration ids are always considered to be later.
number
required
OpenAPI type:
integer (int32).The maximum number of transactions returned for this request.object
OpenAPI type:
DamlValueEncoding.How daml values should be encoded in the response. “compact_json” is a compact, human-readable JSON encoding. It is the same encoding as the one used in the HTTP JSON API or the JavaScript codegen. “protobuf_json” is a verbose JSON encoding that is more difficult to parse, but contains type information, i.e., the values can be parsed losslessly without having access to the Daml source code. Optional and defaults to “compact_json”.Allowed values: compact_json, protobuf_json.Responses
200
okapplication/json
UpdateHistoryItem[]
required
Show child attributes
Show child attributes
UpdateHistoryTransaction
Show child attributes
Show child attributes
string
required
The id of the update.
integer (int64)
required
The migration id of the synchronizer.
string
required
This transaction’s Daml workflow ID; a workflow ID can be associated with multiple transactions. If empty, no workflow ID was set.
string
required
The time at which the transaction was sequenced, with microsecond resolution, using ISO-8601 representation.
string
required
The id of the synchronizer through which this transaction was sequenced.
string
required
Ledger effective time, using ISO-8601 representation. This is the time returned by
getTime for all Daml executed as part of this transaction, both by the submitting participant and all confirming participants.string
required
The absolute offset. Note that this field may not be the same across nodes, and therefore should not be compared between SVs. However, within a single SV’s scan, it is monotonically, lexicographically increasing.
string[]
required
Roots of the transaction tree. These are guaranteed to occur as keys of the
events_by_id object.object
required
Changes to the ledger that were caused by this transaction, keyed by ID. Values are nodes of the transaction tree. Within a transaction, IDs may be referenced by
root_event_ids or child_event_ids in ExercisedEvent herein.string
For an externally signed transaction, contains the external transaction hash signed by the external party. Can be used to correlate an external submission with a committed transaction. This field is conditionally omitted from JSON when null (see OmitNullString).
UpdateHistoryReassignment
A contract reassignment between synchronizer. May be an assignment or unassignment.
Show child attributes
Show child attributes
string
required
The id of the update.
string
required
The absolute offset. Note that this field may not be the same across nodes, and therefore should not be compared between SVs.
string
required
The time at which the transaction was sequenced.
oneOf
required
The reassignment event. May be an assignment or unassignment.
Show child attributes
Show child attributes
UpdateHistoryAssignment
Show child attributes
Show child attributes
string
required
The party ID who submitted this reassignment
string
required
The id of the synchronizer from which the contract was reassigned
string
required
The id of the synchronizer to which the contract was reassigned
integer (int64)
required
The migration id of the target synchronizer
string
required
The id of the corresponding unassign event; this assignment will usually, but not always, occur after the so-identified unassignment event.
CreatedEvent
required
The corresponding contract create event
Show child attributes
Show child attributes
string
required
string
required
The ID of this particular event. Equal to the key of this element of the containing
events_by_id if this is part of a TreeEvent.string
required
The ID of the created contract.
string
required
The template of the created contract.
string
required
The package name of the created contract.
object
required
The arguments that have been used to create the contract, in the form of JSON representation of a Daml record.
string (date-time)
required
Ledger effective time of the transaction that created the contract.
string[]
required
Signatories to the contract, in the form of party IDs.
string[]
required
Observers to the contract, in the form of party IDs.
integer (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 0.
UpdateHistoryUnassignment
Show child attributes
Show child attributes
string
required
The party who submitted this reassignment
string
required
The id of the synchronizer from which the contract was reassigned
integer (int64)
required
The migration id of the synchronizer from which the contract was reassigned
string
required
The id of the synchronizer to which the contract was reassigned
string
required
The id of the unassign event, to later be correlated to an assign event
integer (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 0.
string
required
The id of the unassigned contract
400
bad requestapplication/json
string
required
500
internal server errorapplication/json
string
required
History
Updated
0.6.0The POST /v1/updates operation changed in this snapshot.
Updated
0.5.17The POST /v1/updates operation changed in this snapshot.
Deprecated
0.5.10Added
0.5.10