Get details of a task

This call returns details of the specified task. The task is referred to by its ID, which you can obtain by making the call to list all tasks you can access.

The task details include its creator, its start and end time, the number of jobs completed in it, and its input and output files. You can also see the status of the task.

πŸ“˜

If you are using Seven Bridges Platform EU, please use the following endpoint: https://eu-api.sbgenomics.com/v2/tasks/{task_id}

Response

See a list of Seven Bridges Platform-specific response codes that may be contained in the body of the response.

The response body for a batch task will contain information about the task. The content will be a little different depending on whether the task in question is a batch task (a parent task) or one task that is part of a batch (a child task).

Example of the "errors" array, contained in the response body:

"errors": [
    {
      "type": "error/task_validation/input/schema",
      "message": "Value for this input does not match the expected type.",
      "input_id": "FASTQ"
    },
    {
      "type": "error/task_validation/input/schema",
      "message": "Value for this input does not match the expected type.",
      "input_id": "SnpEff_Database"
    },
    {
      "type": "error/task_validation/input/schema",
      "message": "Value for this input does not match the expected type.",
      "input_id": "Reference"
    }
  ]

More on task validations and validation errors

Whenever you request to create or run a task on the Platform, it will be validated against several criteria. Similarly, when you create or modify any input for a task, these will be validated.
All validations errors are stored as a high-level errors array property in the API response.

You may get the following errors if a task fails these validations:

NumberValidation error typeValidation messageComment
1error/task_validation/input/schemaValue for this input does not match the expected type.This error arises when the input value for a task, or a single app in a task, is the wrong data type, for example, if you have submitted an array of files to an input port that expects a single file, or if you have submitted a file to an input port that expects a string.
2error/task_validation/input/invalid_name_filesSome files on this input contain impermissible characters in their name. Please change the file names before running the task since irregular file names can often lead to certain tools failing.This error occurs when you enter a space or other special character that can cause problems when running a command line tool.
3error/task_validation/input/files_missingSome files found in this input cannot be found in the project.All of the input files need to be in the same project where the task is being run. This error occurs when some input files cannot be found in the project.
4error/task_validation/input/secondary_files_missingSome secondary (index) files required by this input cannot be found in the projectThis error occurs when an app requires secondary files for an input, typically index files (i.e. a .BAI file for a .BAM file input) and those files cannot be found in the project.
Language