Skip to content

transaction_chain

Access transaction chains

Index

Path
GET /v7.0/transaction_chains
Description
List transaction chains
Authentication required
yes
Scope
transaction_chain#index
Aliases
list
Blocking
no

Input parameters

Layout
object
Namespace
transaction_chain
ParameterTypeRequiredDetails
from_id
From ID
 Integer no

List objects with IDs greater or lower than this value

Default: null

Validation rules
RuleDetails
Number
  • Must be a number after parameter type conversion.
  • Minimum: 0 (inclusive).

Validation error message: must be at least 0
limit
Limit
 Integer no

Number of objects to retrieve

Default: 25

Validation rules
RuleDetails
Number
  • Must be a number after parameter type conversion.
  • Minimum: 0 (inclusive).
  • Maximum: 1000 (inclusive).

Validation error message: must be between 0 and 1000
name
Name
 String no

For internal use only

Default: null
state
State
 String no

Default: null

Validation rules
RuleDetails
Include

Allowed values:

  • staged
  • queued
  • done
  • rollbacking
  • failed
  • fatal
  • resolved

Validation error message: %{value} cannot be used
user
User
 Resource no
user_session
User session
 Resource no
class_name
Class name
 String no

Search by concerned class name

Default: null
row_id
Row id
 Integer no

Search by concerned row id

Default: null

Output parameters

Layout
object_list
Namespace
transaction_chains
ParameterTypeDescription
id
Chain ID
 Integer
name
Name
 String For internal use only
label
Label
 String Human-friendly name
state
State
 String
size
Size
 Integer Number of transactions in the chain
progress
Progress
 Integer How many transactions are finished
user
User
 Resource
user_session
User session
 Resource
created_at
Creation date
 Datetime
concerns
Concerns
 Custom

Show

Path
GET /v7.0/transaction_chains/{transaction_chain_id}
Description
Show transaction chain
Authentication required
yes
Scope
transaction_chain#show
Aliases
find
Blocking
no

Input parameters

No parameters.

Output parameters

Layout
object
Namespace
transaction_chain
ParameterTypeDescription
id
Chain ID
 Integer
name
Name
 String For internal use only
label
Label
 String Human-friendly name
state
State
 String
size
Size
 Integer Number of transactions in the chain
progress
Progress
 Integer How many transactions are finished
user
User
 Resource
user_session
User session
 Resource
created_at
Creation date
 Datetime
concerns
Concerns
 Custom