Sign in
ScheduledTransactions

Get scheduled transaction by ID

Returns the scheduled transaction with the given ID.

get/experimental/v1/scheduled/transaction/{id}

Path parameters

idstring hexadecimal required

A 32-byte unique identifier for an entity.

The scheduled transaction identifier (hex-encoded).

Query parameters

expandstring[]

A comma-separated list indicating which properties of the content to expand.

selectstring[]

A comma-separated list indicating which properties of the content to return.

Response

The scheduled transaction.

idstring uint64 required

Scheduler-assigned uint64 identifier.

status'scheduled' | 'executed' | 'cancelled' | 'failed' required

The current lifecycle status of a scheduled transaction.

priority'low' | 'medium' | 'high' required

The execution priority of a scheduled transaction.

timestampstring required

Scheduled execution timestamp as a UFix64 decimal string.

execution_effortstring required

Execution effort estimate as a UFix64 decimal string.

feesstring required

Scheduled fee as a UFix64 decimal string.

transaction_handler_ownerstring hexadecimal required

The 8-byte address of an account.

transaction_handler_type_identifierstring required

Fully qualified Cadence type identifier of the transaction handler (e.g. A.1654653399040a61.MyScheduler.Handler).

transaction_handler_uuidstring uint64 required

Resource UUID of the transaction handler.

transaction_handler_public_pathstring

Public path of the transaction handler, if set.

fees_returnedstring

Fees returned on cancellation, as a UFix64 decimal string.

fees_deductedstring

Fees deducted on cancellation, as a UFix64 decimal string.

created_transaction_idstring hexadecimal required

A 32-byte unique identifier for an entity.

executed_transaction_idstring hexadecimal

A 32-byte unique identifier for an entity.

cancelled_transaction_idstring hexadecimal

A 32-byte unique identifier for an entity.

created_atstring date-time required

Timestamp of the block in which the scheduled transaction was created (RFC 3339).

completed_atstring date-time

Timestamp of the block in which the scheduled transaction was executed or cancelled (RFC 3339). Populated only when status is executed, cancelled, or failed.

is_placeholderboolean

True if the scheduled transaction was created during bootstrapping based on the current chain state, not based on a protocol event. When true, block_height, transaction_id, tx_index, and event_index are absent.

Changes

Changed in 12 of the 24 revisions of this API.151858

  • 9f7bc0dffcce2See the full diff
    • ○

      added the optional property completed_at to the response with the 200 status

      response-optional-property-added

    • ○

      added the required property created_at to the response with the 200 status

      response-required-property-added

  • 70791e5544f011See the full diff
    • ▲

      the response property handler_contract/code became optional for the status 200

      response-property-became-optional

    • ○

      added the optional property handler_contract/_expandable/code to the response with the 200 status

      response-optional-property-added

  • 5dbfe72ac3882See the full diff
    • ○

      added the optional property handler_contract/result to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property is_placeholder to the response with the 200 status

      response-optional-property-added

  • 85a743ac32f4212See the full diff
    • ▲

      removed the required property handler_contract/body from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property handler_contract/identifier from the response with the 200 status

      response-required-property-removed

    • ○

      added the optional property handler_contract/_links to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property handler_contract/block_height to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property handler_contract/event_index to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property handler_contract/is_placeholder to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property handler_contract/transaction to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property handler_contract/transaction_id to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property handler_contract/tx_index to the response with the 200 status

      response-optional-property-added

    • ○

      added the required property handler_contract/_expandable to the response with the 200 status

      response-required-property-added

    • ○

      added the required property handler_contract/address to the response with the 200 status

      response-required-property-added

    • ○

      added the required property handler_contract/code to the response with the 200 status

      response-required-property-added

    • ○

      added the required property handler_contract/code_hash to the response with the 200 status

      response-required-property-added

    • ○

      added the required property handler_contract/contract_id to the response with the 200 status

      response-required-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 8e6df1082d5e572See the full diff
    • ▲

      removed the required property handler_contract/_expandable from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property handler_contract/address from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property handler_contract/code from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property handler_contract/code_hash from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property handler_contract/contract_id from the response with the 200 status

      response-required-property-removed

    • ●

      removed the optional property handler_contract/_links from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property handler_contract/block_height from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property handler_contract/event_index from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property handler_contract/is_placeholder from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property handler_contract/transaction from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property handler_contract/transaction_id from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property handler_contract/tx_index from the response with the 200 status

      response-optional-property-removed

    • ○

      added the required property handler_contract/body to the response with the 200 status

      response-required-property-added

    • ○

      added the required property handler_contract/identifier to the response with the 200 status

      response-required-property-added

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • d9dee34cdec1212See the full diff
    • ▲

      removed the required property handler_contract/body from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property handler_contract/identifier from the response with the 200 status

      response-required-property-removed

    • ○

      added the optional property handler_contract/_links to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property handler_contract/block_height to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property handler_contract/event_index to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property handler_contract/is_placeholder to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property handler_contract/transaction to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property handler_contract/transaction_id to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property handler_contract/tx_index to the response with the 200 status

      response-optional-property-added

    • ○

      added the required property handler_contract/_expandable to the response with the 200 status

      response-required-property-added

    • ○

      added the required property handler_contract/address to the response with the 200 status

      response-required-property-added

    • ○

      added the required property handler_contract/code to the response with the 200 status

      response-required-property-added

    • ○

      added the required property handler_contract/code_hash to the response with the 200 status

      response-required-property-added

    • ○

      added the required property handler_contract/contract_id to the response with the 200 status

      response-required-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • c9fd030682dd21See the full diff
    • ●

      removed the optional property failed_transaction_id from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property scheduled_transaction_id from the response with the 200 status

      response-optional-property-removed

    • ○

      added the required property created_transaction_id to the response with the 200 status

      response-required-property-added

  • c3436f2de2b54See the full diff
    • ○

      added the optional property _expandable/handler_contract to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property handler_contract to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property result to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property transaction to the response with the 200 status

      response-optional-property-added

  • bc5d3963c7aa1See the full diff
    • ○

      added the required property _expandable to the response with the 200 status

      response-required-property-added

  • 989dc7c309fd4920See the full diff
    • ▲

      the id response's property type/format changed from string/hexadecimal to string/uint64 for status 200

      response-property-type-changed

    • ▲

      the timestamp response's property type/format changed from string/date-time to string/ for status 200

      response-property-type-changed

    • ▲

      removed the required property _expandable from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property handler from the response with the 200 status

      response-required-property-removed

    • ●

      removed the optional property result from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property transaction from the response with the 200 status

      response-optional-property-removed

    • ●

      added the new cancelled enum value to the status response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new executed enum value to the status response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new failed enum value to the status response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new high enum value to the priority response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new low enum value to the priority response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new medium enum value to the priority response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new scheduled enum value to the status response property for the response status 200

      response-property-enum-value-added

    • ○

      added the optional property cancelled_transaction_id to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property executed_transaction_id to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property failed_transaction_id to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property fees_deducted to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property fees_returned to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property scheduled_transaction_id to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property transaction_handler_public_path to the response with the 200 status

      response-optional-property-added

    • ○

      removed the Cancelled enum value from the status response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the Executed enum value from the status response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the Failed enum value from the status response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the High enum value from the priority response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the Low enum value from the priority response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the Medium enum value from the priority response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the Pending enum value from the status response property for the response status 200

      response-property-enum-value-removed

    • ○

      the id response's property pattern ^[a-fA-F0-9]{64}$ was removed for the status 200

      response-property-pattern-removed

    • ○

      added the required property execution_effort to the response with the 200 status

      response-required-property-added

    • ○

      added the required property fees to the response with the 200 status

      response-required-property-added

    • ○

      added the required property transaction_handler_owner to the response with the 200 status

      response-required-property-added

    • ○

      added the required property transaction_handler_type_identifier to the response with the 200 status

      response-required-property-added

    • ○

      added the required property transaction_handler_uuid to the response with the 200 status

      response-required-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog