Query completions list (blocking call) Subscribe to command completion events
POST
JSON Ledger API
Query completions list (blocking call) Subscribe to command completion events
OpenAPISince 3.5
CompletionStream. Notice: This endpoint should be used for small results set. When number of results exceeded node configuration limit (http-list-max-elements-limit) there will be an error (413 Content Too Large) returned.
Protocol Details
Inputs
Query parameters
number
OpenAPI type:
integer (int64).maximum number of elements to return, this param is ignored if is bigger than server settingnumber
OpenAPI type:
integer (int64).timeout to complete and send result if no new elements are received (for open ended streams)Request body
application/json
string[]
If specified, only completions of commands are included, which have at least one of the
act_as parties in the given set of parties. Only Ledger API users with CanReadAsAnyParty permission allowed to provide no parties. Must be a valid PartyIdString (as described in value.proto). Optional: can be emptynumber
OpenAPI type:
integer (int64).This optional field indicates the minimum offset for completions. This can be used to resume an earlier completion stream. If not set the ledger uses the ledger begin offset instead. If specified, it must be a valid absolute offset (positive integer) or zero (ledger begin offset). If the ledger has been pruned, this parameter must be specified and greater than the pruning offset. (the pruning offset is accessible on the StateService.GetLatestPrunedOffsets endpoint) OptionalOutputs
200
application/json
CompletionStreamResponse[]
required
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
Introduced
3.5