Sign in

v1

latestOpenAPI 3.1.02026-07-267418115.3 KB

GET samples instances

get/api/v1/samples

Query parameters

pageinteger

Page number. Defaults to 1. See Pagination for more details.

per_pageinteger

Number of requested paginated records. Defaults to 50. See Pagination for more details.

sortstring nullable

Optional Mongo-style JSON sort clause, e.g., sort={"created_at": true} to sort by created_at (descending)

wherestring nullable

Optional Mongo-style JSON filter clause, e.g., where={"$uri": {"$eq": "/api/v1/samples/0ee172af60e84f61"}}

Response

OK

$uristring required
created_atstring date-time required

Timestamp for when the object was created on the One Codex platform, encoded as a RFC 3339 timestamp.

error_msgstring nullable

An error message if the sample failed to upload, import, or validate.

filenamestring nullable

The sample filename.

sizeinteger nullable

The size of the uploaded file in bytes.

status'awaiting_data' | 'importing' | 'validating' | 'failed_validation' | 'available' | 'deleted' required

Enum for user-facing data status.

This is a subset of DataStatus for the status attribute in the APIs.

updated_atstring date-time nullable

Timestamp for when the object was last updated on the One Codex platform, encoded as a RFC 3339 timestamp.

visibility'public' | 'shared' | 'private' | 'importing' | 'awaiting data' required

Enum for the v1 API visibility attribute.

Note: this is legacy and only exists for backwards-compatibility in the public v1 API.

Example response

[
  {
    "$uri": "/api/v1/samples/0d77065796f8d173",
    "metadata": {
      "__DOLLAR_REF__": "/api/v1/metadata/a1b2c3d4e5f67890"
    },
    "owner": {
      "__DOLLAR_REF__": "/api/v1/users/a1b2c3d4e5f67890"
    },
    "primary_classification": {
      "__DOLLAR_REF__": "/api/v1/classifications/a1b2c3d4e5f67890"
    },
    "project": {
      "__DOLLAR_REF__": "/api/v1/projects/a1b2c3d4e5f67890"
    },
    "tags": [
      {
        "__DOLLAR_REF__": "/api/v1/tags/a1b2c3d4e5f67890"
      }
    ]
  }
]