Skip to main content
GET
/
api
/
v1
/
classifications
GET classifications instances
curl --request GET \
  --url https://app.onecodex.com/api/v1/classifications \
  --header 'X-API-Key: <api-key>'
[
  {
    "$uri": "/api/v1/classifications/a1b2c3d4e5f67890",
    "complete": false,
    "created_at": "2023-11-07T05:31:56Z",
    "error_msg": "<string>",
    "job": {
      "type": "<unknown>",
      "pattern": "<unknown>",
      "example": "<unknown>"
    },
    "job_args": {},
    "sample": {
      "type": "<unknown>",
      "pattern": "<unknown>",
      "example": "<unknown>"
    },
    "success": false
  }
]

Documentation Index

Fetch the complete documentation index at: https://developer.onecodex.com/llms.txt

Use this file to discover all available pages before exploring further.

GET all Classification instances. Returns a paginated list of Classifications.

Authorizations

​
X-API-Key
string
header
required

Query Parameters

​
page
integer<int32>
default:1

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

​
per_page
integer<int32>
default:50

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

​
sort
object

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

​
where
object

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

Response

200 - application/json

Successful operation

​
$uri
string
Pattern: ^/api/v1/classifications\/[^/]+$
Example:

"/api/v1/classifications/a1b2c3d4e5f67890"

​
complete
boolean
default:false
​
created_at
string<date-time>

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

​
error_msg
string | null
Maximum string length: 255
​
job
object

A reference to the versioned job underlying the analysis, e.g., {"$ref": "/api/v1/jobs/d512cb556241440f"}.

​
job_args
object

The arguments passed into this analysis (can be null).

​
sample
object

A reference to the sample underlying the analysis, e.g., {"$ref": "/api/v1/sample/0ee172af60e84f61"}.

​
success
boolean
default:false