Skip to content

action_state

Browse states of blocking actions

Cancel

Path
POST /v7.0/action_states/{action_state_id}/cancel
Description
Cancel a pending action
Authentication required
no
Scope
action_state#cancel
Aliases
Blocking
yes

Input parameters

No parameters.

Output parameters

No parameters.

Index

Path
GET /v7.0/action_states
Description
List pending action states
Authentication required
no
Scope
action_state#index
Aliases
list
Blocking
no

Input parameters

Layout
hash
Namespace
action_state
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: null

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
order
Order
 String no

Template order

Default: newest

Validation rules
RuleDetails
Include

Allowed values:

  • newest
  • oldest

Validation error message: %{value} cannot be used

Output parameters

Layout
hash_list
Namespace
action_states
ParameterTypeDescription
id
Id
 Integer
label
Label
 String
finished
Finished
 Boolean
status
Status
 Boolean Whether the action is proceeding successfully or has failed
current
Current progress
 Integer
total
Total
 Integer The action is finished when current reaches total
unit
Unit
 String Unit of current and total
can_cancel
Can cancel
 Boolean When true, this action can be cancelled
created_at
Created at
 Datetime
updated_at
Updated at
 Datetime When the progress was last updated

Poll

Path
GET /v7.0/action_states/{action_state_id}/poll
Description
Return when the action is completed, its progress changes, or a timeout occurs
Authentication required
no
Scope
action_state#poll
Aliases
Blocking
no

Input parameters

Layout
hash
Namespace
action_state
ParameterTypeRequiredDetails
timeout
Timeout
 Float no

Timeout in seconds

Default: 15

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

Validation error message: must be between 0 and 30
update_in
Update in
 Float no

Return early when status, current, or total changes; the value is passed to API-specific polling implementations

Default: null
status
Status
 Boolean no

Status value to compare when update_in is set

Default: null
current
Current
 Integer no

Current progress value to compare when update_in is set

Default: null
total
Total
 Integer no

Total progress value to compare when update_in is set

Default: null

Output parameters

Layout
hash
Namespace
action_state
ParameterTypeDescription
id
Id
 Integer
label
Label
 String
finished
Finished
 Boolean
status
Status
 Boolean Whether the action is proceeding successfully or has failed
current
Current progress
 Integer
total
Total
 Integer The action is finished when current reaches total
unit
Unit
 String Unit of current and total
can_cancel
Can cancel
 Boolean When true, this action can be cancelled
created_at
Created at
 Datetime
updated_at
Updated at
 Datetime When the progress was last updated

Show

Path
GET /v7.0/action_states/{action_state_id}
Description
Show the state of a pending action
Authentication required
no
Scope
action_state#show
Aliases
find
Blocking
no

Input parameters

No parameters.

Output parameters

Layout
hash
Namespace
action_state
ParameterTypeDescription
id
Id
 Integer
label
Label
 String
finished
Finished
 Boolean
status
Status
 Boolean Whether the action is proceeding successfully or has failed
current
Current progress
 Integer
total
Total
 Integer The action is finished when current reaches total
unit
Unit
 String Unit of current and total
can_cancel
Can cancel
 Boolean When true, this action can be cancelled
created_at
Created at
 Datetime
updated_at
Updated at
 Datetime When the progress was last updated