ONonecodex

POST jobs publish

Changed on
post/api/v1/jobs/{id}/publish

Request

  • Base URL
    https://app.onecodex.com
  • URL
    https://app.onecodex.com/api/v1/jobs/{id}/publish
  • Auth
    API key in header X-API-Key

Path parameters

idstring required

Request body

autorun_on_org_sample_uploadboolean nullable

Response

OK

$uristring required
analysis_typestring required

The type of analysis. See the analysis resource for more details.

created_atstring date-time required

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

draftboolean required

Whether the job is an unpublished draft. Draft jobs are only visible to their creator.

job_args_schemaobject required

The JSON schema for the arguments taken by the job (can be an empty object, i.e., {}).

namestring required

The name of the job (this is displayed in the dropdown on the analysis page of the One Codex web application).

publicboolean required

Whether the job is publicly available. For most jobs this will be true. Custom, private jobs are also available, and will only be visible to users whose samples (or samples shared with them) have been analyzed using that job.

Example response

{
  "$uri": "/api/v1/jobs/0d77065796f8d173"
}

Changes