Skip to main content
POST

JSON Ledger API

​
Parties external generate topology

OpenAPISince 3.4Changed 3.5
You may use this endpoint to generate the common external topology transactions which can be signed externally and uploaded as part of the allocate party process Note that this request will create a normal namespace using the same key for the identity as for signing. More elaborate schemes such as multi-signature or decentralized parties require you to construct the topology transactions yourself.

​
Protocol Details

​
Inputs

​
Request body

application/json
​
string
required
Synchronizer-id for which we are building this request. Required
​
string
required
The actual party id will be constructed from this hint and a fingerprint of the public key Required
​
object
required
OpenAPI type: SigningPublicKey.
​
boolean
If true, then the local participant will only be observing, not confirming. Default false. Optional
​
string[]
Other participant ids which should be confirming for this party Optional: can be empty
​
number
OpenAPI type: integer (int32).Confirmation threshold >= 1 for the party. Defaults to all available confirmers (or if set to 0). Optional
​
string[]
Other observing participant ids for this party Optional: can be empty

​
Outputs

​
200

application/json
​
string
required
The generated party id Required
​
string
required
The fingerprint of the supplied public key Required
​
string[]
required
The serialized topology transactions which need to be signed and submitted as part of the allocate party process Note that the serialization includes the versioning information. Therefore, the transaction here is serialized as an UntypedVersionedMessage which in turn contains the serialized TopologyTransaction in the version supported by the synchronizer. Required: must be non-empty
​
string
required
the multi-hash which may be signed instead of each individual transaction Required: must be non-empty

​
400

text/plain
​
string
required

​
default

application/json
​
string
required
​
string
required
​
string
​
string
​
Map_String
required
​
Tuple2_String_String[]
​
integer (int32)
required
​
integer (int32)
​
string
​
boolean

​
History

Changed3.5

The POST /v2/parties/external/generate-topology operation changed in this snapshot.

Introduced3.4