Skip to main content
An MLST result is a multilocus sequence typing analysis — a specialized analysis that identifies the sequence type (ST) of an isolate by typing housekeeping loci against a curated MLST scheme. MLST results are produced by jobs whose analysis_type is mlst. The below table summarizes all of the properties for the MLST resource, with the JSON schema type of each property listed below in italics.
​
$uri
string
required
read-only
Pattern: ^/api/v1/mlsts/[a-f0-9]{16}$
Example:

"/api/v1/mlsts/0d77065796f8d173"

​
created_at
string<date-time>
required

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

​
job
jobs · object
required

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

​
sample
samples · object
required

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

​
complete
boolean
default:false
​
error_msg
string | null

The error message from the analysis, if it failed.

Maximum string length: 255
​
job_args
Job Args · object

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

​
success
boolean
default:false
​
updated_at
string<date-time> | null

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