List File Upload Jobs

Lists available file upload jobs

Authorizations

Authorization

string

header

required

Authorization: Bearer $JWT_TOKEN

Headers

Prefer

integer

default:

0

Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240.

Required range: x > 0

Query Parameters

sort_by

string

Sortable columns are user_email_address, status, status_message, start_time, end_time, last_ingest, id, created_at, updated_at, and deleted_at.

user_id

string

Filter results by column string value. Valid filter predicates are eq, ~eq, neq.

user_email_address

string

Filter results by column string value. Valid filter predicates are eq, ~eq, neq.

status

integer

Filter results by column integer value. Valid filter predicates are eq, neq, gt, gte, lt, lte.

status_message

string

Filter results by column string value. Valid filter predicates are eq, ~eq, neq.

start_time

string

Filter results by column timestamp value formatted as an RFC-3339 string. Valid filter predicates are eq, neq, gt, gte, lt, lte.

end_time

string

Filter results by column timestamp value formatted as an RFC-3339 string. Valid filter predicates are eq, neq, gt, gte, lt, lte.

last_ingest

string

Filter results by column timestamp value formatted as an RFC-3339 string. Valid filter predicates are eq, neq, gt, gte, lt, lte.

id

integer

Filter results by column integer value. Valid filter predicates are eq, neq, gt, gte, lt, lte.

created_at

string

Filter results by created_at value. See filter schema details for valid predicates.

updated_at

string

Filter results by updated_at value. See filter schema details for valid predicates.

deleted_at

string

Filter results by deleted_at value. See filter schema details for valid predicates.

skip

integer

This query parameter is used for determining the number of objects to skip in pagination.

Required range: x > 0

limit

integer

This query parameter is used for setting an upper limit of objects returned in paginated responses.

Required range: x > 0

Response

200

application/json

OK

count

integer

The total number of results.

Required range: x > 0

skip

integer

The number of items to skip in a paginated response.

Required range: x > 0

limit

integer

The limit of results requested by the client.

Required range: x > 0

data

object[]

Show child attributes

data.id

integer

This is the unique identifier for this object.

data.created_at

string

data.updated_at

string

data.deleted_at

object

Show child attributes

data.deleted_at.time

string

An RFC-3339 formatted string

data.deleted_at.valid

boolean

Valid is true if time is not null.

data.user_id

string

data.user_email_address

string

data.status

enum<integer>

This enum describes the current status of a Job. Values are:

• -1 Invalid
• 0 Ready
• 1 Running
• 2 Complete
• 3 Canceled
• 4 Timed Out
• 5 Failed
• 6 Ingesting
• 7 Analyzing
• 8 Partially Complete

Available options:

-1,

0,

1,

2,

3,

4,

5,

6,

7,

8

data.status_message

string

data.start_time

string

data.end_time

string

data.last_ingest

string