Job

Gets a Job resource

Changed on Sep 30, 2026

get/api/v1/jobs/{id}

Request

Base URL
/ (relative, and the document was published on a file host, not at the API’s origin)
Auth
none declared
TypeScript
https://skmtc.dev/usnistgov/apis/dioptra-rest-api/docs/api/v1/jobs/:id/get.ts
A function with typed inputs. Its response is checked against the schema.

Headers

X-Fieldsstring mask

An optional fields mask

Response

Success

idinteger

ID for the Job resource.

snapshotinteger

ID for the underlying Job snapshot.

createdOnstring date-time

Timestamp when the Job resource was created.

snapshotCreatedOnstring date-time

Timestamp when the Job resource snapshot was created.

lastModifiedOnstring date-time

Timestamp when the Job resource was last modified.

latestSnapshotboolean

Whether or not the Job resource is the latest version.

hasDraftboolean

Whether a draft exists for the Job resource.

deletedboolean

Whether the Job resource has been deleted.

descriptionstring

Description of the Job resource.

valuesobject

A dictionary of keyword arguments to pass to the Job's Entrypoint.

artifactValuesobject

A dictionary of artifacts to pass to the Job's Entrypoint.

timeoutstring

The maximum alloted time for a job before it times out and is stopped. If omitted, the job timeout will default to 24 hours.

statusstring

The current status of the job. The allowed values are: queued, started, deferred, finished, failed.

Changes

Sep 30, 20267615a76631a4 Revision changes
- breaking
  the / response's property type changed from object to no type for status
- breaking
  the ////// response's property type changed from object to no type for status
- breaking
  the response's property type changed from object to no type for status
- breaking
  the response's property type changed from object to no type for status
- breaking
  the response's property type changed from object to no type for status
- breaking
  the response's property type changed from object to no type for status
- breaking
  the / response's property type changed from object to no type for status
- breaking
  the ////// response's property type changed from object to no type for status
- breaking
  the response's property type changed from object to no type for status
- warning
  deleted the path request parameter id
- info
  added the optional property ////// to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added to the response property allOf list for the response status
- info
  added to the response property allOf list for the response status
- info
  added to the response property allOf list for the response status
- info
  removed from the response property allOf list for the response status
- info
  removed from the response property allOf list for the response status
- info
  removed from the response property allOf list for the response status
- info
  the response's property default value {} was added for the status
Feb 11, 2026a73101579c5c Revision changes
- info
  added the optional property to the response with the status
- info
  added the optional property ///// to the response with the status
- info
  added the optional property ///// to the response with the status
- info
  added the optional property ///// to the response with the status
- info
  added the optional property to the response with the status
- info
  added to the / response property allOf list for the response status
- info
  removed from the / response property allOf list for the response status

Operation history (3 revisions)

Gets a Job resource

Request

Headers

Response 200OK

Changes

Response