Skip to main content
Version: 2.0

Get a job by ID

GET 
/v2/jobs/:job_id

Get a job by a specific ID. Jobs are background processes like replacing the filterable metadata attributes.

Request​

Path Parameters

    job_id stringrequired

    Possible values: Value must match regular expression job_.+$

    The ID of the job to get.

Header Parameters

    Request-Timeout integer

    Possible values: >= 1

    The API will make a best effort to complete the request in the specified seconds or time out.

    Request-Timeout-Millis integer

    Possible values: >= 1

    The API will make a best effort to complete the request in the specified milliseconds or time out.

Responses​

A job.

Schema
    id string

    Possible values: Value must match regular expression job_.+$

    The ID of the job.

    type string

    Possible values: [rebuild_vector_index, replace_filter_attributes, unknown]

    The type of job.

    corpus_keys CorpusKey[]

    Possible values: <= 50 characters, Value must match regular expression [a-zA-Z0-9_\=\-]+$

    The corpora that this job belongs to. It may not belong to any corpora.

    state JobState

    Possible values: [unknown, queued, started, completed, failed, failed_will_retry, aborted]

    created_at date-time

    Specifies when the job was created.

    started_at date-time

    Specifies when the job was started.

    completed_at date-time

    Specifies when the job was completed.

    created_by_username string

    The username of the user who created the job. This property may be missing, e.g., if the job was created by the system, not a user.

Loading...