Looking up contract data by contract ID

POST /v2/contracts/contract-by-id

Request

curl --request POST \
  --url 'http://localhost:7575/v2/contracts/contract-by-id' \
  --header 'Authorization: Bearer $TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"contractId":"string","queryingParties":["string"]}'

200 response

{
  "createdEvent": {
    "offset": 0,
    "nodeId": 0,
    "contractId": "string",
    "templateId": "string",
    "contractKey": "string",
    "contractKeyHash": "string",
    "createArgument": "string",
    "createdEventBlob": "string",
    "interfaceViews": [
      {}
    ],
    "witnessParties": [
      "string"
    ],
    "signatories": [
      "string"
    ],
    "observers": [
      "string"
    ],
    "createdAt": "string",
    "packageName": "string",
    "representativePackageId": "string",
    "acsDelta": false
  }
}

JSON Ledger API

Looking up contract data by contract ID

OpenAPISince 3.4Changed 3.5

Looking up contract data by contract ID. This endpoint is experimental / alpha, therefore no backwards compatibility is guaranteed. This endpoint must not be used to look up contracts which entered the participant via party replication or repair service.

Protocol Details

Operation IDpostV2ContractsContract-by-id

AuthenticationBearer token

Published3.5

Inputs

Request body

application/json

contractId · string · required

The ID of the contract. Must be a valid LedgerString (as described in value.proto). Required

queryingParties · string[]

The list of querying parties The stakeholders of the referenced contract must have an intersection with any of these parties to return the result. If no querying_parties specified, all possible contracts could be returned. Optional: can be empty

Outputs

200

application/json

createdEvent · CreatedEvent · required

Records that a contract has been created, and choices may now be exercised on it.

400

text/plain

value · string · required

default

application/json

code · string · required

cause · string · required

correlationId · string

traceId · string

context · Map_String · required

resources · Tuple2_String_String[]

errorCategory · integer (int32) · required

grpcCodeValue · integer (int32)

retryInfo · string

definiteAnswer · boolean

History

Changed3.5

The POST /v2/contracts/contract-by-id operation changed in this snapshot.

Introduced3.4

Request

curl --request POST \
  --url 'http://localhost:7575/v2/contracts/contract-by-id' \
  --header 'Authorization: Bearer $TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"contractId":"string","queryingParties":["string"]}'

200 response

{
  "createdEvent": {
    "offset": 0,
    "nodeId": 0,
    "contractId": "string",
    "templateId": "string",
    "contractKey": "string",
    "contractKeyHash": "string",
    "createArgument": "string",
    "createdEventBlob": "string",
    "interfaceViews": [
      {}
    ],
    "witnessParties": [
      "string"
    ],
    "signatories": [
      "string"
    ],
    "observers": [
      "string"
    ],
    "createdAt": "string",
    "packageName": "string",
    "representativePackageId": "string",
    "acsDelta": false
  }
}