Skip to content

What a retry inherits from the runs before it

GET
/orgs/{org}/imports/{id}/runs/{run}/inherited
curl --request GET \
--url https://api.sloose.com/orgs/org_9f3c/imports/imp_4d1a/runs/run_7c2e/inherited \
--header 'Authorization: Bearer <token>'

The records the run this one retries — and whatever that run itself inherited — already made, which this retry does not write again: gathered when the retry was authorised, so what a retry inherits does not change and does not depend on how long the runs before it are kept, or on whether the meter counted it as a retry. Newline-delimited JSON. The first line says what the run stands on — retried, the run it retries, and which of that run’s sources start over, because their file, or how the file is read, has changed since, so their rows are written again: { "retried", "startedOver": [{ "flowId", "label" }] }. A run that stands on none — one authorised without naming a run of this import that has ended, or a dry run — is answered that line alone, with retried null. Every line after it is one run record at attempt 0, of one of three kinds. inherited, for a row and module whose record the chain made: { "rowKey", "flowId", "rowNumber", "module", "recordId", "code", "keys", "patched", … } — code says how the chain made it (created or updated), keys the values it was indexed under for links and matches (less the fields its patches may have changed), and patched the fields its after-save patches filled. inherited with "phase": "patch", for an after-save patch that filled a field and put keys on its record: the same shape with target the field, recordId the record and keys the values the patch put on it, which a later row’s link or match may search on. And unanswered, naming no record, for a row and module whose create the chain sent and never heard back about, with nothing in the chain making the record since: it may have been made all the same, so the retry that makes it says the record may exist twice. Any member of the org may read it.

org
required

The org id the session was issued for. A token for one org can never read another.

string
Example
org_9f3c

The org id the session was issued for. A token for one org can never read another.

id
required

The import id.

string
Example
imp_4d1a

The import id.

run
required

The run id, from POST /entitlements/runs/authorise.

string
Example
run_7c2e

The run id, from POST /entitlements/runs/authorise.

Newline-delimited JSON: what the run stands on and which sources start over, then each record inherited.

Media typeapplication/x-ndjson
string
Examplegenerated
example

No bearer, or one that is expired, revoked or no longer resolves to a member.

Media typeapplication/json

The error envelope every non-2xx answer uses.

object
error
required

Human-readable explanation.

string
code

Machine-readable reason. Absent on a few legacy 400s.

string
key
additional properties
Examplegenerated
{
"error": "example",
"code": "example"
}

The bearer’s role is too low, or it was issued for a different org.

Media typeapplication/json

The error envelope every non-2xx answer uses.

object
error
required

Human-readable explanation.

string
code

Machine-readable reason. Absent on a few legacy 400s.

string
key
additional properties
Examplegenerated
{
"error": "example",
"code": "example"
}

No such import or run, or it is not visible to this session.

Media typeapplication/json

The error envelope every non-2xx answer uses.

object
error
required

Human-readable explanation.

string
code

Machine-readable reason. Absent on a few legacy 400s.

string
key
additional properties
Examplegenerated
{
"error": "example",
"code": "example"
}

A run’s inheritance is in storage this deployment cannot reach (code: NOT_CONFIGURED).

Media typeapplication/json

The error envelope every non-2xx answer uses.

object
error
required

Human-readable explanation.

string
code

Machine-readable reason. Absent on a few legacy 400s.

string
key
additional properties
Examplegenerated
{
"error": "example",
"code": "example"
}

Report a problem with this page