/v2/interactive-submission/preferred-package-version

A preferred package is the highest-versioned package for a provided package-name that is vetted by all the participants hosting the provided parties.

Ledger API clients should use this endpoint for constructing command submissions that are compatible with the provided preferred package, by making informed decisions on:

• which are the compatible packages that can be used to create contracts
• which contract or exercise choice argument version can be used in the command
• which choices can be executed on a template or interface of a contract

Can be accessed by any Ledger API client with a valid token when Ledger API authorization is enabled.

Provided for backwards compatibility, it will be removed in the Canton version 3.4.0

GET /v2/interactive-submission/preferred-package-version

/v2/interactive-submission/preferred-package-version

cURL

curl --request GET \
  --url https://api.example.com/v2/interactive-submission/preferred-package-version \
  --header 'Authorization: Bearer <token>'

200

{
  "packagePreference": {
    "packageReference": {
      "packageId": "<string>",
      "packageName": "<string>",
      "packageVersion": "<string>"
    },
    "synchronizerId": "<string>"
  }
}

Authorizations

httpAuthapiKeyAuth

Authorization · string · header · required

Ledger API standard JWT token

Query Parameters

parties · string[]

package-name · string · required

vetting_valid_at · string<date-time>

synchronizer-id · string

Response

200

application/json

packagePreference · PackagePreference · object

Not populated when no preferred package is found

Optional

Show child attributes