Artifact

Gets a list of all Artifact resources

Changed on Sep 30, 2026

get/api/v1/artifacts/

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/artifacts/get.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

sortBystring

The name of the column to sort.

descendingboolean

Boolean indicating whether to sort by descending or not.

searchstring

Search terms for the query (* and ? wildcards).

groupIdinteger

Filter results by the Group ID.

indexinteger

Starting index of the current page.

pageLengthinteger

Number of results to return per page.

outputParamsstring

Ordered List of Plugin Task Parameter Ids of the output values produced by the ArtifactTask associated with the target Artifacts.

Headers

X-Fieldsstring mask

An optional fields mask

Response

Success

indexinteger

Starting index of the current page.

isCompleteboolean

Boolean indicating if more data is available.

totalNumResultsinteger

Total number of results.

firststring

URL to first page in results set.

nextstring

URL to next page in results set.

prevstring

URL to last page in results set.

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
- info
  api tag Artifact added
- info
  api tag Artifacts removed
- 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
- breaking
  removed the required property ////// from the response with the status
- info
  added the new optional query request parameter descending
- info
  added the new optional query request parameter outputParams
- info
  added the new optional query request parameter sortBy
- 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 the optional property ////// to the response with the status

Operation history (3 revisions)