Skip to content

Get a source’s cleaning

GET
/orgs/{org}/imports/{id}/sources/{sid}/cleaning
curl --request GET \
--url https://api.sloose.com/orgs/org_9f3c/imports/imp_4d1a/sources/src_7c2e/cleaning \
--header 'Authorization: Bearer <token>'

The revision the source names, exactly as it was saved. A source has none until one is saved — and none again after its file is replaced or it is read under new options, since the rows the old one counted are not these.

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.

sid
required

The source id.

string
Example
src_7c2e

The source id.

The cleaning, exactly as it was saved.

Media typeapplication/json

The cleaning document, with its schemaVersion.

object
key
additional properties
Examplegenerated
{
"additionalProperty": "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 (IMPORT_NOT_FOUND) or source (SOURCE_NOT_FOUND); the source has no cleaning (code: CLEANING_NOT_FOUND); or it names one that is not in storage (code: CLEANING_NOT_IN_STORAGE) — saved once and lost since, which is not the same as none.

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"
}

This deployment has no storage for imports yet (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