Experiments

Gets an experiment by its unique identifier

get/api/v1/experiments/{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/experiments/:id/get.ts
A function with typed inputs. Its response is checked against the schema.

X-Fieldsstring mask

An optional fields mask

Success

idinteger

ID for the Experiment resource.

snapshotinteger

ID for the underlying Experiment snapshot.

createdOnstring date-time

Timestamp when the Experiment resource was created.

snapshotCreatedOnstring date-time

Timestamp when the Experiment resource snapshot was created.

lastModifiedOnstring date-time

Timestamp when the Experiment resource was last modified.

latestSnapshotboolean

Whether or not the Experiment resource is the latest version.

hasDraftboolean

Whether a draft exists for the Experiment resource.

deletedboolean

Whether the Experiment resource has been deleted.

namestring required

Name of the Experiment resource.

descriptionstring

Description of the Experiment resource.

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
- warning
  deleted the path request parameter id
- 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
Feb 11, 2026a73101579c5c Revision changes
- info
  added the optional property to the response with the status