List import job items

GET

/api/v1/import-jobs/{job_id}/items

const url = 'http://127.0.0.1:8080/api/v1/import-jobs/example/items?limit=50&offset=0&filter=imported';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'http://127.0.0.1:8080/api/v1/import-jobs/example/items?limit=50&offset=0&filter=imported' \
  --header 'Authorization: Bearer <token>'

One row per recipe the import was asked to bring in, in the order they were selected. Filtering is by what a reader is looking for rather than by storage state.

Authorizations

bearerToken
browserSession

Parameters

Path Parameters

job_id

required

string

Query Parameters

limit

integer format: int64

default: 50 >= 1 <= 200

offset

integer format: int64

filter

Review-required and informational describe consequences rather than storage states

string

Allowed values: imported skipped review-required informational failed pending cancelled

Review-required and informational describe consequences rather than storage states

Responses

200

application/json

object

items

required

Array<object> | null

object

deferred_assets

required

Photographs not fetched yet whose addresses the recipe retains

integer format: int64

diagnostics

Array<object> | null

object

area

required

string

class

required

string

Allowed values: blocking actionable informational

code

required

string

count

required

integer format: int64

>= 1

message

required

string

targets

Array<object> | null

object

action

string

evidence

string

field

string

object_id

string

preserved

string

resolution

object

authored_form

required

string

candidate_unit_ids

required

Array<string> | null

required

string

kind

required

string

resolution_key

required

string

source_end

required

integer format: int64

source_start

required

integer format: int64

key

additional properties

any

key

additional properties

any

key

additional properties

any

dropped_assets

required

Photographs this recipe names that could not be retrieved and were left out

integer format: int64

error

string

filename

string

finished_at

string format: date-time

import_event_id

string

library_entry_id

string

outcome

string

Allowed values: created replaced skipped

position

required

integer format: int64

recipe_id

string

review_required

required

boolean

revision

integer format: int64

>= 1

source_url

string

started_at

string format: date-time

state

required

string

Allowed values: pending running imported skipped failed cancelled

title

required

string

key

additional properties

any

limit

required

integer format: int64

offset

required

integer format: int64

total

required

integer format: int64

key

additional properties

any

Example

{
  "items": [
    {
      "diagnostics": [
        {
          "class": "blocking"
        }
      ],
      "outcome": "created",
      "state": "pending"
    }
  ]
}

401

No valid session or API token (authentication-required), or the credential sent is invalid (invalid-credentials).

application/problem+json

object

code

required

string

detail

required

string

status

required

integer format: int64

title

required

string

type

required

string

key

additional properties

any

Example^generated

{
  "code": "example",
  "detail": "example",
  "status": 1,
  "title": "example",
  "type": "example"
}

404

Not Found

application/problem+json

object

code

Stable application error code; clients may also use the problem type suffix.

string

detail

A human-readable explanation specific to this occurrence of the problem.

string

errors

Optional list of individual error details

Array<object> | null

object

location

Where the error occurred, e.g. ‘body.items[3].tags’ or ‘path.thing-id’

string

message

Error message text

string

value

The value at the given location

key

additional properties

any

instance

A URI reference that identifies the specific occurrence of the problem.

string format: uri

params

Structured context for the stable error code.

object

key

additional properties

any

status

HTTP status code

integer format: int64

title

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

string

type

A URI reference to human-readable documentation for the error.

string format: uri

default: about:blank

violations

Array<object>

object

code

required

string

location

required

string

params

object

key

additional properties

any

key

additional properties

any

Example

{
  "detail": "Property foo is required but is missing.",
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "about:blank"
}

422

Unprocessable Entity

application/problem+json

object

code

Stable application error code; clients may also use the problem type suffix.

string

detail

A human-readable explanation specific to this occurrence of the problem.

string

errors

Optional list of individual error details

Array<object> | null

object

location

Where the error occurred, e.g. ‘body.items[3].tags’ or ‘path.thing-id’

string

message

Error message text

string

value

The value at the given location

key

additional properties

any

instance

A URI reference that identifies the specific occurrence of the problem.

string format: uri

params

Structured context for the stable error code.

object

key

additional properties

any

status

HTTP status code

integer format: int64

title

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

string

type

A URI reference to human-readable documentation for the error.

string format: uri

default: about:blank

violations

Array<object>

object

code

required

string

location

required

string

params

object

key

additional properties

any

key

additional properties

any

Example

{
  "detail": "Property foo is required but is missing.",
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "about:blank"
}

500

Internal Server Error

application/problem+json

object

code

Stable application error code; clients may also use the problem type suffix.

string

detail

A human-readable explanation specific to this occurrence of the problem.

string

errors

Optional list of individual error details

Array<object> | null

object

location

Where the error occurred, e.g. ‘body.items[3].tags’ or ‘path.thing-id’

string

message

Error message text

string

value

The value at the given location

key

additional properties

any

instance

A URI reference that identifies the specific occurrence of the problem.

string format: uri

params

Structured context for the stable error code.

object

key

additional properties

any

status

HTTP status code

integer format: int64

title

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

string

type

A URI reference to human-readable documentation for the error.

string format: uri

default: about:blank

violations

Array<object>

object

code

required

string

location

required

string

params

object

key

additional properties

any

key

additional properties

any

Example

{
  "detail": "Property foo is required but is missing.",
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "about:blank"
}

List import job items

Authorizations

Parameters

Path Parameters

Query Parameters

Responses

200

Example

401

Examplegenerated

404

Example

422

Example

500

Example

Example^generated