ONonecodex

POST samples instances_import

Changed on
post/api/v1/samples/import

Request

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

Request body

import_type'url'
paired_uristring nullable
uristring required

Example request

{
  "metadata": {
    "external_sample_id": "LIMS-2024-00123"
  },
  "project": {
    "__DOLLAR_REF__": "/api/v1/projects/a1b2c3d4e5f67890"
  }
}

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"
    }
  ]
}

Changes