ONonecodex

GET assets instances

Changed on
get/api/v1/assets

Request

  • Base URL
    https://app.onecodex.com
  • URL
    https://app.onecodex.com/api/v1/assets
  • Auth
    API key in header X-API-Key

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.

filenamestring required

The asset filename.

namestring required

A display name for the asset. Defaults to the filename if not provided at upload time.

sizeinteger nullable

The size of the uploaded file in bytes.

status'importing' | 'available' | 'failed' required

The status of the asset. importing while the file is being copied to One Codex storage, available once the asset is ready to use, and failed if the import did not succeed.

Example response

[
  {
    "$uri": "/api/v1/assets/0d77065796f8d173",
    "uploader": {
      "__DOLLAR_REF__": "/api/v1/users/a1b2c3d4e5f67890"
    }
  }
]

Changes