supanovasupanovaDOCS
Open Launchpad
Launchpad documentation
operations

Get one owned operation.

GET /api/v1/operations/{operationId}. Get one owned operation.

Request

GET /api/v1/operations/{operationId}

Authentication is required. Supported credentials: a customer API key with read scope in X-API-Key or a signed-in customer session token in Authorization: Bearer …. Send one credential type only; never both.

Parameters

NameInTypeRequiredConstraintsDescription
operationIdpathstringYesformat: uuid; pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$—
X-Service-Act-AsheaderstringNomin length: 3; max length: 512Service-principal path only (local and devnet stages; refused by configuration on mainnet). With an OAuth client-credentials bearer token from the validator, names the allow-listed Party the client acts as. Missing: 400 SERVICE_ACT_AS_REQUIRED; not allow-listed: 403 SERVICE_PARTY_NOT_ALLOWED. Ignored for customer session tokens.
X-Request-IdheaderstringNomin length: 8; max length: 128; pattern: ^[A-Za-z0-9._:-]+$Optional client correlation identifier. The server always generates a separate authoritative request ID and retains a valid supplied value only as secondary audit correlation metadata.

cURL

Set OPERATION_ID to the path and required query values before running this example. URL-encode path values as needed.

bash
curl --fail-with-body --silent --show-error \
  --request GET \
  --url "https://launch-api.supanova.app/api/v1/operations/${OPERATION_ID}" \
  --header "X-API-Key: $SUPANOVA_API_KEY"

Responses

200

The owned operation.

HeaderTypeDescription
X-Request-IdstringServer-generated request correlation identifier to retain for support and reconciliation.

Content type: application/json

Type: object.

FieldTypeRequiredConstraintsDescription
cantonCommandIdstring or nullYes——
cantonUpdateIdstring or nullYes—The ledger update that completed the operation, when it is the only operation that update completed. Always null for swap.execute operations of trade orders and user-signed trades: their status follows the order or trade (submitted, confirmed, rejected, cancelled, expired) and the update id, offset and record time are in result.ledgerExecution, since one batch-fill update settles many orders.
completedAtone or more variants · Schema 1Yes——
correlationIdstringYesformat: uuid; pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$—
createdAtstringYesformat: date-time; pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$—
errorone or more variants · Schema 2Yes——
expiresAtone or more variants · Schema 1Yes——
idstringYesformat: uuid; pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$—
networkIdstringYespattern: ^canton:[-_a-zA-Z0-9]{1,32}$—
resultone or more variants · Schema 3Yes—Status-specific evidence: ledgerExecution (updateId, offset, recordTime) for a confirmed operation, ledgerPreparation while a signature is awaited, expiredAt or cancelledAt for those terminal states, walletReport for a wallet-reported outcome, else null.
statusstringYesallowed: "received", "validating", "awaiting_signature", "ready", "submitted", "confirmed", "failed", "rejected", "expired", "cancelled"—
typestringYesmin length: 1; max length: 128—
updatedAtstringYesformat: date-time; pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$—

Additional fields are not allowed.

400

The request is malformed or failed validation. Codes: VALIDATION_FAILED, AMBIGUOUS_CREDENTIALS, SERVICE_ACT_AS_REQUIRED.

HeaderTypeDescription
X-Request-IdstringServer-generated request correlation identifier to retain for support and reconciliation.

Content type: application/json

Standard envelope: error.code, error.message, optional error.details, and requestId. See error handling and the full code registry.

401

Credentials are missing, malformed, expired or revoked. Codes: AUTHENTICATION_REQUIRED, INVALID_AUTHORIZATION_HEADER, INVALID_ACCESS_TOKEN, SESSION_REVOKED, API_KEY_INVALID, API_KEY_REVOKED.

HeaderTypeDescription
X-Request-IdstringServer-generated request correlation identifier to retain for support and reconciliation.

Content type: application/json

Standard envelope: error.code, error.message, optional error.details, and requestId. See error handling and the full code registry.

403

The credential may not call this route. Owner routes accept only a customer API key: an internal master key answers API_KEY_ROUTE_NOT_ALLOWED. Codes: ACCOUNT_RESTRICTED, ANONYMOUS_ACCOUNT_NOT_ALLOWED, API_KEY_ROUTE_NOT_ALLOWED, SERVICE_PARTY_NOT_ALLOWED, SERVICE_PRINCIPAL_NOT_ALLOWED, SIGNUP_NOT_INVITED, API_KEY_IP_NOT_ALLOWED, PRODUCT_ACCOUNT_RESTRICTED.

HeaderTypeDescription
X-Request-IdstringServer-generated request correlation identifier to retain for support and reconciliation.

Content type: application/json

Standard envelope: error.code, error.message, optional error.details, and requestId. See error handling and the full code registry.

404

No resource the caller may see matches the path.

HeaderTypeDescription
X-Request-IdstringServer-generated request correlation identifier to retain for support and reconciliation.

Content type: application/json

Standard envelope: error.code, error.message, optional error.details, and requestId. See error handling and the full code registry.

429

The caller exceeded an IP or principal request budget.

HeaderTypeDescription
Retry-AfterintegerWhole seconds to wait before retrying a rate-limited request.
X-Request-IdstringServer-generated request correlation identifier to retain for support and reconciliation.

Content type: application/json

Standard envelope: error.code, error.message, optional error.details, and requestId. See error handling and the full code registry.

503

A dependency is unavailable or the feature is not enabled on this deployment. Codes: AUTHENTICATION_UNAVAILABLE, AUTHORIZATION_UNAVAILABLE.

HeaderTypeDescription
X-Request-IdstringServer-generated request correlation identifier to retain for support and reconciliation.

Content type: application/json

Standard envelope: error.code, error.message, optional error.details, and requestId. See error handling and the full code registry.

default

Machine-readable API error. The HTTP status identifies the error class.

HeaderTypeDescription
X-Request-IdstringServer-generated request correlation identifier to retain for support and reconciliation.

Content type: application/json

Standard envelope: error.code, error.message, optional error.details, and requestId. See error handling and the full code registry.

Nested schemas

Field links above lead to the complete nested object, array, and variant definitions below. Required fields are scoped to their containing object.

Schema 1

Response 200.completedAt

Type: one or more variants.

At least one of these variants must match:

  • Variant 1: string. format: date-time; pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
  • Variant 2: null.

Schema 2

Response 200.error

Type: one or more variants.

At least one of these variants must match:

  • Variant 1: object · Schema 4.
  • Variant 2: null.

Schema 3

Response 200.result

Type: one or more variants.

Status-specific evidence: ledgerExecution (updateId, offset, recordTime) for a confirmed operation, ledgerPreparation while a signature is awaited, expiredAt or cancelledAt for those terminal states, walletReport for a wallet-reported outcome, else null.

At least one of these variants must match:

  • Variant 1: one or more variants · Schema 5.
  • Variant 2: null.

Schema 4

Response 200.error variant 1

Type: object.

FieldTypeRequiredConstraintsDescription
codestringYes——
messagestring or nullYes——

Additional fields are not allowed.

Schema 5

Response 200.result variant 1

Type: one or more variants.

At least one of these variants must match:

Schema 6

Response 200.result variant 1 variant 1

Type: object.

FieldTypeRequiredConstraintsDescription
ledgerPreparationobject · Schema 12Yes——

Additional fields are not allowed.

Schema 7

Response 200.result variant 1 variant 2

Type: object.

FieldTypeRequiredConstraintsDescription
ledgerExecutionobject · Schema 13Yes——

Additional fields are not allowed.

Schema 8

Response 200.result variant 1 variant 3

Type: object.

FieldTypeRequiredConstraintsDescription
walletReportobject · Schema 14Yes——

Additional fields are not allowed.

Schema 9

Response 200.result variant 1 variant 4

Type: object.

FieldTypeRequiredConstraintsDescription
confirmedtrueYes——
execution"simulated"Yes——

Additional fields are not allowed.

Schema 10

Response 200.result variant 1 variant 5

Type: object.

FieldTypeRequiredConstraintsDescription
expiredAtstringYesformat: date-time; pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$—
reason"operation_deadline_elapsed"Yes——

Additional fields are not allowed.

Schema 11

Response 200.result variant 1 variant 6

Type: object.

FieldTypeRequiredConstraintsDescription
cancelledAtstringYesformat: date-time; pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$—
reasonstringYesallowed: "account_closed_before_submission", "order_cancelled"—

Additional fields are not allowed.

Schema 12

Response 200.result variant 1 variant 1.ledgerPreparation

Type: object.

FieldTypeRequiredConstraintsDescription
kindstringYesallowed: "application-submission", "interactive-submission", "wallet-submission"—
commandIdstringYesmin length: 1; max length: 255—
actAsarray of string · Schema 15Yesmin items: 1; max items: 8—
synchronizerIdstringYesmin length: 1; max length: 512—
hashingSchemeVersionstringYesmin length: 1; max length: 64—
preparedAtstringYesformat: date-time; pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$—
signedByone or more variants · Schema 16Yes——
preparedTransactionone or more variants · Schema 17Yes——
preparedTransactionHashone or more variants · Schema 18Yes——
applicationChoiceone or more variants · Schema 19Yes——
applicationPolicyone or more variants · Schema 19Yes——
disclosedContractsone or more variants · Schema 20No——
submissionAttemptone or more variants · Schema 21Yes——

Additional fields are not allowed.

Schema 13

Response 200.result variant 1 variant 2.ledgerExecution

Type: object.

FieldTypeRequiredConstraintsDescription
updateIdstringYesmin length: 1; max length: 255—
offsetstringYesmin length: 1; max length: 64—
recordTimeone or more variants · Schema 22Yes——
synchronizerIdone or more variants · Schema 23Yes——
recoveredbooleanYes——
exercisedobject · Schema 24Yes——

Additional fields are not allowed.

Schema 14

Response 200.result variant 1 variant 3.walletReport

Type: object.

FieldTypeRequiredConstraintsDescription
commandIdone or more variants · Schema 23Yes——
errorCodeone or more variants · Schema 25Yes——
reportedAtstringYesformat: date-time; pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$—
source"wallet"Yes——
statusstringYesallowed: "submitted", "rejected"—
updateIdone or more variants · Schema 23Yes——

Additional fields are not allowed.

Schema 15

Response 200.result variant 1 variant 1.ledgerPreparation.actAs

Type: array of string.

min items: 1; max items: 8

Array items: string. min length: 1; max length: 512

Schema 16

Response 200.result variant 1 variant 1.ledgerPreparation.signedBy

Type: one or more variants.

At least one of these variants must match:

  • Variant 1: string. min length: 4; max length: 160
  • Variant 2: null.

Schema 17

Response 200.result variant 1 variant 1.ledgerPreparation.preparedTransaction

Type: one or more variants.

At least one of these variants must match:

  • Variant 1: string. max length: 4194304
  • Variant 2: null.

Schema 18

Response 200.result variant 1 variant 1.ledgerPreparation.preparedTransactionHash

Type: one or more variants.

At least one of these variants must match:

  • Variant 1: string. max length: 512
  • Variant 2: null.

Schema 19

Response 200.result variant 1 variant 1.ledgerPreparation.applicationChoice

Type: one or more variants.

At least one of these variants must match:

  • Variant 1: object · Schema 24.
  • Variant 2: null.

Schema 20

Response 200.result variant 1 variant 1.ledgerPreparation.disclosedContracts

Type: one or more variants.

At least one of these variants must match:

  • Variant 1: array of object · Schema 26. max items: 64
  • Variant 2: null.

Schema 21

Response 200.result variant 1 variant 1.ledgerPreparation.submissionAttempt

Type: one or more variants.

At least one of these variants must match:

  • Variant 1: object · Schema 27.
  • Variant 2: null.

Schema 22

Response 200.result variant 1 variant 2.ledgerExecution.recordTime

Type: one or more variants.

At least one of these variants must match:

  • Variant 1: string. max length: 64
  • Variant 2: null.

Schema 23

Response 200.result variant 1 variant 2.ledgerExecution.synchronizerId

Type: one or more variants.

At least one of these variants must match:

  • Variant 1: string. min length: 1; max length: 512
  • Variant 2: null.

Schema 24

Response 200.result variant 1 variant 2.ledgerExecution.exercised

Type: object.

Additional field values: any value.

Schema 25

Response 200.result variant 1 variant 3.walletReport.errorCode

Type: one or more variants.

At least one of these variants must match:

  • Variant 1: string. min length: 1; max length: 128
  • Variant 2: null.

Schema 26

Response 200.result variant 1 variant 1.ledgerPreparation.disclosedContracts variant 1

Type: array of object.

max items: 64

Array items: object · Schema 28.

Schema 27

Response 200.result variant 1 variant 1.ledgerPreparation.submissionAttempt variant 1

Type: object.

FieldTypeRequiredConstraintsDescription
submissionIdstringYesmin length: 1; max length: 255—
beginExclusiveintegerYesminimum: 0; maximum: 9007199254740991—
startedAtstringYesformat: date-time; pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$—

Additional fields are not allowed.

Schema 28

Response 200.result variant 1 variant 1.ledgerPreparation.disclosedContracts variant 1 item

Type: object.

FieldTypeRequiredConstraintsDescription
contractIdstringYesmin length: 1; max length: 255—
createdEventBlobstringYesmin length: 1—
synchronizerIdstringYesmin length: 1; max length: 512—
templateIdstringYesmin length: 1; max length: 255—

Additional fields are not allowed.

Source contract

This page is generated from the checked-in customer OpenAPI snapshot. Download JSON, download YAML, or compare the live API reference. Snapshot provenance records the retrieval date and checksum.

Generated from the public API contractDeveloper settings