Quality Samples

List samples

Returns samples, optionally filtered and paginated.

Filtering behavior: The 'tags' parameter performs an exact match against one or more tags. The 'sampleName' parameter performs an exact match on the sample name. The 'searchKey' parameter performs a case-insensitive partial match against both the sample name and the asset name path, and cannot be combined with the other filter parameters (tags, sampleName, assetTypePath, assetNamePath, sampleType). The 'assetTypePath' parameter performs an exact match on the asset type path. The 'assetNamePath' parameter performs an exact match on the full asset name path. The 'sampleType' parameter performs an exact match on the sample type (e.g. "uploaded" or "generated").

get/v2/quality/samples

Request

  • Base URL: https://api.cloud.precisely.com
  • URL: https://api.cloud.precisely.com/v2/quality/samples
  • Auth: HTTP bearer

Query parameters

tagsstring[]

Optional set of tags to filter by (exact match)

sampleNamestring

Optional sample name to filter by (exact match)

searchKeystring

Optional case-insensitive partial match against sample name and asset name path; cannot be combined with other filters

assetTypePathstring

Optional asset type path to filter by (exact match)

assetNamePathstring

Optional asset name path to filter by (exact match)

sampleTypestring

Optional sample type to filter by (exact match), e.g. "uploaded" or "generated"

pageinteger

Zero-based page index; defaults to 0

sizeinteger

Page size; defaults to 20

ascendingboolean

Sort direction; defaults to true (ascending)

sortBystring

Field to sort by; defaults to "name"

Response

List of sample summaries

assetNamePathstring
assetTypePathstring
createdDatestring date-time
daysLeftToPurgeinteger
lastModifiedDatestring date-time
namestring
numberOfRowsinteger
sampleStorageProviderstring
sampleTypestring
tagsstring[]

Changes

No recorded changes to this operation across all 1 revision of this API.