Skip to main content
The Functional Profile is an analysis which provides results for identifying gene families and pathways, profiling gene function and organism-specific contributions to metabolic pathways, and measuring gene abundance. The functional analysis leverages the classification resource to associate functional groups with taxonomic information, providing results that can be used to understand the functional capabilities of a sample and which organisms contribute to those functions. A functional profile has the same properties as an analysis, as well as a route for profile-specific results.
​
$uri
string
required
read-only
Pattern: ^/api/v1/functional_profiles/[a-f0-9]{16}$
Example:

"/api/v1/functional_profiles/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.