Sign in

v1

latestOpenAPI 3.0.02026-07-1329122146.2 KB
AdminService

List the jobs associated with this account. Jobs are background processes like replacing the filterable metadata attributes.

Some tips for this API:

  • This operation works with the Personal API Key and OAuth 2.0 (in a JWT "Bearer Token") authentication. You can find details of how to set up and use OAuth 2.0 here.
  • It's best practice to filter as much as possible (by date, by status, and/or by job ID) to make job lists as easy to interpret as possible, as there can be many for a given time window.
post/v1/list-jobs

Headers

customer-idinteger required

Enter the Customer ID to use for the request.

timeoutstring

(Optional) Enter the timeout value of the request in seconds, such as 10S or 30S.

Request body

jobIdstring

Optional filters. If specified, the filters are logically ANDed.

[Optional] If specified, return the job for this id.

corpusIdinteger[]

[Optional] If specified, return jobs for these corpora only.

epochSecsstring int64

[Optional] Get jobs that were created since this epoch timestamp. Max allowed value is 180 days ago. Default is 180 days.

stateAdminJobState[]

[Optional] Get jobs with these states. If not specified, all job states are fetched. Default: If not set, JOB_STATE__QUEUED and JOB_STATE__STARTED are returned.

numResultsinteger

Maximum results to return. Max allowed value is 100.

pageKeystring byte

A key that is passed in to retrieve a specific page of results. Leave empty to retrieve first page. Subsequent page request should use the page key returned in previous response, and all other fields are ignored.

Response

A successful response.

pageKeystring byte

A key that is passed into a subsequent result in order to retrieve the next page of results.