ONonflow
ScheduledTransactions

Get scheduled transaction by ID

Changed on

Returns the scheduled transaction with the given ID.

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

Request

  • Base URL
    https://rest-testnet.onflow.org
  • URL
    https://rest-testnet.onflow.org/experimental/v1/scheduled/transaction/{id}
  • Auth
    none required

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

  • 9f7bc0dffcceRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

  • 70791e5544f0Revision changes
    • breaking

      the response property / became optional for the status

    • info

      added the optional property // to the response with the status