ONonecodex

POST jobs run

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

Request

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

Path parameters

idstring required

Request body

descriptionstring nullable

Optional description. Visible to anyone who can see this run's results.

job_argsobject nullable required
populate_default_argumentsboolean nullable

Example request

{
  "dependencies": [
    {
      "analysis": {
        "__DOLLAR_REF__": "/api/v1/analyses/a1b2c3d4e5f67890"
      }
    }
  ],
  "sample": {
    "__DOLLAR_REF__": "/api/v1/samples/a1b2c3d4e5f67890"
  }
}

Response

OK

__DOLLAR_REF__string uri

Example response

{
  "__DOLLAR_REF__": "/api/v1/analyses/a1b2c3d4e5f67890"
}

Changes