ONonecodex

GET assemblies instances

Changed on
get/api/v1/assemblies

Request

  • Base URL
    https://app.onecodex.com
  • URL
    https://app.onecodex.com/api/v1/assemblies
  • 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 nullable required
sizeinteger nullable required
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/assemblies/0d77065796f8d173",
    "genome": {
      "__DOLLAR_REF__": "/api/v1/genomes/a1b2c3d4e5f67890"
    },
    "input_samples": [
      {
        "__DOLLAR_REF__": "/api/v1/samples/a1b2c3d4e5f67890"
      }
    ],
    "job": {
      "__DOLLAR_REF__": "/api/v1/jobs/a1b2c3d4e5f67890"
    },
    "owner": {
      "__DOLLAR_REF__": "/api/v1/users/a1b2c3d4e5f67890"
    },
    "primary_annotation_set": {
      "__DOLLAR_REF__": "/api/v1/annotation_sets/a1b2c3d4e5f67890"
    }
  }
]

Changes