returnActionRun

Required scopes: returns_read

Arguments

ID!

required

The id of the run.

Returns

One run of a return action over a set of returns. A run works through its returns in the background; poll returnActionRun until status is no longer RUNNING.

Show fields

ReturnAction

The action the run applies. Null for the moment before a run that has only just started reports it.

ReturnActionRunCounts!

required

Outcome totals so far.

Show fields

Int!

required

Returns the same action was already in progress on, which the run left alone.

Int!

required

Returns the action failed on.

Int!

required

Returns the action was applied to.

Int!

required

Returns the action did not apply to.

Int!

required

The returns in the run.

ID!

required

The run’s id, for returnActionRun.

[ReturnActionResult!]!

required

One entry per return, in the order they were given. Live while the run is RUNNING.

Show fields

String

A stable code for a skipped or failed return, such as INELIGIBLE or CLAIM_UNDER_REDO_REVIEW.

String

Why the return was skipped or failed.

ID!

required

The id of the return. Read the return itself with the return query.

ReturnActionResultStatus!

required

What the run did to this return.

ReturnActionRunStatus!

required

Whether the run is still working.

Example

query {
  returnActionRun(id: "...") {
    action
    id
    status
  }
}

Getting Started

Guides

Reference

returnActionRun

Arguments

Returns

Example

​Arguments

​Returns

​Example

Arguments

Returns

Example