Whether a run still describes its import

GET

/orgs/{org}/imports/{id}/runs/{run}

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

• Production
• Staging

Which of the run’s flows the import still holds as the run read them: the same source, bound to the same flow, the same stored file, read under the same options. A run’s records name rows as (flow, row number), and a row’s number is its place in its file as read — so a replaced file, or one read with another header row or sheet, puts different rows at the same numbers, and the run’s results for that flow no longer describe the import’s rows. unchanged and changed list flow ids (null for a run of one unnamed flow). The cleaning is not compared: exclusions and cell edits do not renumber a file. Any member of the org may read it.

Authorizations

• sessionAuth
• apiTokenAuth

Parameters

Path Parameters

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.

Responses

200

The run’s flows, by whether the import still holds each one’s file as the run read it, and what it set out to walk.

Media typeapplication/json

object

id

required

string

unchanged

required

Array<string | null>

changed

required

Array<string | null>

importVersion

required

The import’s version this was answered against: a change to the import after it — a file replaced, another reading — is one this answer does not know about.

integer

plan

required

What the run set out to walk, as the page that ran it said at its authorisation (plan): its files in the order it met them, each with the rows it ran (endRow null: to the file’s end), and where it began when it picked up part-way (from). A run picking up where it stopped walks this rather than the ranges on screen now, which a reopened import resets. Null for a run kept before plans were, or one whose page sent none: unknown, never guessed.

object

files

required

Array<object>

object

flowId

required

string | null

range

required

object

startRow

required

integer

endRow

required

integer | null

from

required

Where a run that picked up part-way began (#1252): the file, by its flow, and the row. Null for a run that began at its start, and for one kept before this was.

object

flowId

required

string | null

row

required

integer

Example^generated

{
  "id": "example",
  "unchanged": [
    "example"
  ],
  "changed": [
    "example"
  ],
  "importVersion": 1,
  "plan": {
    "files": [
      {
        "flowId": "example",
        "range": {
          "startRow": 1,
          "endRow": 1
        }
      }
    ],
    "from": {
      "flowId": "example",
      "row": 1
    }
  }
}

401

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

Example^generated

{
  "error": "example",
  "code": "example"
}

403

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

Example^generated

{
  "error": "example",
  "code": "example"
}

404

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

Example^generated

{
  "error": "example",
  "code": "example"
}

409

A reading’s options were written by a newer build of Sloose than this one (FROM_FUTURE), and cannot be compared by this one.

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

Example^generated

{
  "error": "example",
  "code": "example"
}