Collection Uploads
Community
Enterprise

List File Upload Jobs

Changed on

Lists available file upload jobs

get/api/v2/file-upload

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/v2/file-upload
  • Auth: one of:
    • HTTP bearer
    • API key in header Authorization and API key in header RequestDate and API key in header Signature

Query parameters

sort_bystring

Sort by column. Can be used multiple times; prepend a hyphen for descending order. See parameter description for details about which columns are sortable.

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

user_idstring

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

user_email_addressstring

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

statusstring

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

status_messagestring

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

start_timestring

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

end_timestring

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

last_ingeststring

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

idstring

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

created_atstring

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

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

updated_atstring

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

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

deleted_atstring

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

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

skipinteger

The number of items to skip in a paginated response.

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

limitinteger

The limit of results requested by the client.

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

Response

OK

countinteger

The total number of results.

skipinteger

The number of items to skip in a paginated response.

limitinteger

The limit of results requested by the client.

Changes

  • 40bf219eced6Revision changes
    • breaking

      added the pattern ^((eq|neq|gt|gte|lt|lte):)?-?[0-9]+$ to the query request parameter id

    • breaking

      added the pattern ^((eq|neq|gt|gte|lt|lte):)?-?[0-9]+$ to the query request parameter status

    • breaking

      added the pattern ^((eq|neq|gt|gte|lt|lte):)?[0-9]{4}-[0-9]{2}-[0-9]{2}[Tt][0-9]{2}:[0-9]{2}:[0-9]{2}(\.[0-9]{1,9})?([Zz]|-[0-9]{2}:[0-9]{2})$ to the query request parameter created_at

    • breaking

      added the pattern ^((eq|neq|gt|gte|lt|lte):)?[0-9]{4}-[0-9]{2}-[0-9]{2}[Tt][0-9]{2}:[0-9]{2}:[0-9]{2}(\.[0-9]{1,9})?([Zz]|-[0-9]{2}:[0-9]{2})$ to the query request parameter deleted_at

    • breaking

      added the pattern ^((eq|neq|gt|gte|lt|lte):)?[0-9]{4}-[0-9]{2}-[0-9]{2}[Tt][0-9]{2}:[0-9]{2}:[0-9]{2}(\.[0-9]{1,9})?([Zz]|-[0-9]{2}:[0-9]{2})$ to the query request parameter end_time

    • breaking

      added the pattern ^((eq|neq|gt|gte|lt|lte):)?[0-9]{4}-[0-9]{2}-[0-9]{2}[Tt][0-9]{2}:[0-9]{2}:[0-9]{2}(\.[0-9]{1,9})?([Zz]|-[0-9]{2}:[0-9]{2})$ to the query request parameter last_ingest

    • breaking

      added the pattern ^((eq|neq|gt|gte|lt|lte):)?[0-9]{4}-[0-9]{2}-[0-9]{2}[Tt][0-9]{2}:[0-9]{2}:[0-9]{2}(\.[0-9]{1,9})?([Zz]|-[0-9]{2}:[0-9]{2})$ to the query request parameter start_time

    • breaking

      added the pattern ^((eq|neq|gt|gte|lt|lte):)?[0-9]{4}-[0-9]{2}-[0-9]{2}[Tt][0-9]{2}:[0-9]{2}:[0-9]{2}(\.[0-9]{1,9})?([Zz]|-[0-9]{2}:[0-9]{2})$ to the query request parameter updated_at

    • breaking

      added the pattern ^((eq|~eq|neq):)?[^:]+$ to the query request parameter status_message

    • breaking

      added the pattern ^((eq|~eq|neq):)?[^:]+$ to the query request parameter user_email_address

    • breaking

      added the pattern ^((eq|~eq|neq):)?[^:]+$ to the query request parameter user_id

    • info

      for the query request parameter created_at, the format was generalized from date-time to no format

    • info

      for the query request parameter deleted_at, the format was generalized from date-time to no format

    • info

      for the query request parameter end_time, the format was generalized from date-time to no format

    • info

      for the query request parameter id, the type was generalized from integer to string

    • info

      for the query request parameter last_ingest, the format was generalized from date-time to no format

    • info

      for the query request parameter start_time, the format was generalized from date-time to no format

    • info

      for the query request parameter status, the type was generalized from integer to string

    • info

      for the query request parameter updated_at, the format was generalized from date-time to no format

  • 6aaeba6ecdc5Revision changes
    • breaking

      for the query request parameter created_at, the format changed from no format to date-time

    • breaking

      for the query request parameter deleted_at, the format changed from no format to date-time

    • breaking

      for the query request parameter end_time, the format changed from no format to date-time

    • breaking

      for the query request parameter id, the type changed from string to integer

    • breaking

      for the query request parameter last_ingest, the format changed from no format to date-time

    • breaking

      for the query request parameter start_time, the format changed from no format to date-time

    • breaking

      for the query request parameter status, the type changed from string to integer

    • breaking

      for the query request parameter updated_at, the format changed from no format to date-time

    • info

      removed the pattern ^((eq|neq|gt|gte|lt|lte):)?-?[0-9]+$ from the query request parameter id

    • info

      removed the pattern ^((eq|neq|gt|gte|lt|lte):)?-?[0-9]+$ from the query request parameter status

    • info

      removed the pattern ^((eq|neq|gt|gte|lt|lte):)?[0-9]{4}-[0-9]{2}-[0-9]{2}[Tt][0-9]{2}:[0-9]{2}:[0-9]{2}(\.[0-9]{1,9})?([Zz]|-[0-9]{2}:[0-9]{2})$ from the query request parameter created_at

    • info

      removed the pattern ^((eq|neq|gt|gte|lt|lte):)?[0-9]{4}-[0-9]{2}-[0-9]{2}[Tt][0-9]{2}:[0-9]{2}:[0-9]{2}(\.[0-9]{1,9})?([Zz]|-[0-9]{2}:[0-9]{2})$ from the query request parameter deleted_at

    • info

      removed the pattern ^((eq|neq|gt|gte|lt|lte):)?[0-9]{4}-[0-9]{2}-[0-9]{2}[Tt][0-9]{2}:[0-9]{2}:[0-9]{2}(\.[0-9]{1,9})?([Zz]|-[0-9]{2}:[0-9]{2})$ from the query request parameter end_time

    • info

      removed the pattern ^((eq|neq|gt|gte|lt|lte):)?[0-9]{4}-[0-9]{2}-[0-9]{2}[Tt][0-9]{2}:[0-9]{2}:[0-9]{2}(\.[0-9]{1,9})?([Zz]|-[0-9]{2}:[0-9]{2})$ from the query request parameter last_ingest

    • info

      removed the pattern ^((eq|neq|gt|gte|lt|lte):)?[0-9]{4}-[0-9]{2}-[0-9]{2}[Tt][0-9]{2}:[0-9]{2}:[0-9]{2}(\.[0-9]{1,9})?([Zz]|-[0-9]{2}:[0-9]{2})$ from the query request parameter start_time

    • info

      removed the pattern ^((eq|neq|gt|gte|lt|lte):)?[0-9]{4}-[0-9]{2}-[0-9]{2}[Tt][0-9]{2}:[0-9]{2}:[0-9]{2}(\.[0-9]{1,9})?([Zz]|-[0-9]{2}:[0-9]{2})$ from the query request parameter updated_at

    • info

      removed the pattern ^((eq|~eq|neq):)?[^:]+$ from the query request parameter status_message

    • info

      removed the pattern ^((eq|~eq|neq):)?[^:]+$ from the query request parameter user_email_address

    • info

      removed the pattern ^((eq|~eq|neq):)?[^:]+$ from the query request parameter user_id