Skip to main content
POST
Discard an assignment set

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Parâmetros de caminho

setId
string<uuid>
obrigatório

Assignment set identifier.

Corpo

application/json
reason
enum<string>
obrigatório

Why the composition was called off. abandoned: nobody is going to finish it. member_ineligible: a line in it can never be sold and was holding every other line with it. counterparty_declined: the fund or its administrator walked away outside the remessa. superseded: replaced by another composition. Required — free text is a disposition nobody can count.

Opções disponíveis:
abandoned,
member_ineligible,
counterparty_declined,
superseded
note
string

The particulars, in the operator's own words. Optional; omitted rather than blanked on the audit row when there is nothing to add.

Maximum string length: 512

Resposta

OK

fromState
string
obrigatório

Where the set stood when the decision landed, or the state it was already in on a replay.

replayed
boolean
obrigatório

True when this set was ALREADY discarded and nothing was written. No second audit row was appended and no second decision was recorded.

setId
string
obrigatório

The composition that was called off.

state
string
obrigatório

Always cancelled: the terminal state a discarded composition rests in. Nothing is deleted — the items, the transitions, the approval and the custodied evidence all stand.