POST /v2/updates/update-by-id

Lookup an update by its ID. If there is no update with this ID, or all the events are filtered, an UPDATE_NOT_FOUND error will be raised.

POST /v2/updates/update-by-id

POST /v2/updates/update-by-id

cURL

curl --request POST \
  --url https://api.example.com/v2/updates/update-by-id \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "updateId": "<string>",
  "updateFormat": {
    "includeReassignments": {
      "filtersByParty": {},
      "filtersForAnyParty": {
        "cumulative": [
          {
            "identifierFilter": {
              "Empty": {}
            }
          }
        ]
      },
      "verbose": true
    },
    "includeTopologyEvents": {
      "includeParticipantAuthorizationEvents": {
        "parties": [
          "<string>"
        ]
      }
    }
  }
}
'

import requests

url = "https://api.example.com/v2/updates/update-by-id"

payload = {
    "updateId": "<string>",
    "updateFormat": {
        "includeReassignments": {
            "filtersByParty": {},
            "filtersForAnyParty": { "cumulative": [{ "identifierFilter": { "Empty": {} } }] },
            "verbose": True
        },
        "includeTopologyEvents": { "includeParticipantAuthorizationEvents": { "parties": ["<string>"] } }
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    updateId: '<string>',
    updateFormat: {
      includeReassignments: {
        filtersByParty: {},
        filtersForAnyParty: {cumulative: [{identifierFilter: {Empty: {}}}]},
        verbose: true
      },
      includeTopologyEvents: {includeParticipantAuthorizationEvents: {parties: ['<string>']}}
    }
  })
};

fetch('https://api.example.com/v2/updates/update-by-id', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/v2/updates/update-by-id",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'updateId' => '<string>',
    'updateFormat' => [
        'includeReassignments' => [
                'filtersByParty' => [
                                
                ],
                'filtersForAnyParty' => [
                                'cumulative' => [
                                                                [
                                                                                                                                'identifierFilter' => [
                                                                                                                                                                                                                                                                'Empty' => [
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                
                                                                                                                                                                                                                                                                ]
                                                                                                                                ]
                                                                ]
                                ]
                ],
                'verbose' => true
        ],
        'includeTopologyEvents' => [
                'includeParticipantAuthorizationEvents' => [
                                'parties' => [
                                                                '<string>'
                                ]
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v2/updates/update-by-id"

	payload := strings.NewReader("{\n  \"updateId\": \"<string>\",\n  \"updateFormat\": {\n    \"includeReassignments\": {\n      \"filtersByParty\": {},\n      \"filtersForAnyParty\": {\n        \"cumulative\": [\n          {\n            \"identifierFilter\": {\n              \"Empty\": {}\n            }\n          }\n        ]\n      },\n      \"verbose\": true\n    },\n    \"includeTopologyEvents\": {\n      \"includeParticipantAuthorizationEvents\": {\n        \"parties\": [\n          \"<string>\"\n        ]\n      }\n    }\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/v2/updates/update-by-id")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"updateId\": \"<string>\",\n  \"updateFormat\": {\n    \"includeReassignments\": {\n      \"filtersByParty\": {},\n      \"filtersForAnyParty\": {\n        \"cumulative\": [\n          {\n            \"identifierFilter\": {\n              \"Empty\": {}\n            }\n          }\n        ]\n      },\n      \"verbose\": true\n    },\n    \"includeTopologyEvents\": {\n      \"includeParticipantAuthorizationEvents\": {\n        \"parties\": [\n          \"<string>\"\n        ]\n      }\n    }\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v2/updates/update-by-id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"updateId\": \"<string>\",\n  \"updateFormat\": {\n    \"includeReassignments\": {\n      \"filtersByParty\": {},\n      \"filtersForAnyParty\": {\n        \"cumulative\": [\n          {\n            \"identifierFilter\": {\n              \"Empty\": {}\n            }\n          }\n        ]\n      },\n      \"verbose\": true\n    },\n    \"includeTopologyEvents\": {\n      \"includeParticipantAuthorizationEvents\": {\n        \"parties\": [\n          \"<string>\"\n        ]\n      }\n    }\n  }\n}"

response = http.request(request)
puts response.read_body

200

{
  "update": {
    "OffsetCheckpoint": {
      "value": {
        "offset": 123,
        "synchronizerTimes": [
          {
            "synchronizerId": "<string>",
            "recordTime": "<string>"
          }
        ]
      }
    }
  }
}

"<string>"

{
  "code": "<string>",
  "cause": "<string>",
  "context": {},
  "errorCategory": 123,
  "correlationId": "<string>",
  "traceId": "<string>",
  "resources": [
    [
      "<string>"
    ]
  ],
  "grpcCodeValue": 123,
  "retryInfo": "<string>",
  "definiteAnswer": true
}

Authorizations

httpAuthapiKeyAuth

Authorization · string · header · required

Ledger API standard JWT token

Body

application/json

updateId · string · required

The ID of a particular update. Must be a valid LedgerString (as described in value.proto).

Required

updateFormat · UpdateFormat · object · required

The format for the update.

Required

Show child attributes

Response

200

application/json

update · Update · object

Update

Update

Update

Update

Show child attributes