{"__v":17,"_id":"56328f54b904a10d0032f72c","category":{"__v":92,"_id":"55faf9aa17b9d00d00969f49","pages":["56312d239ead230d00a188f2","56312e0d82d96a0d00b0fb08","56315777fc94aa0d00e9b553","56315b779ead230d00a1894a","5631657c9c25801700dac34f","56317884fc94aa0d00e9b586","56318386c3b04b0d00ba9bb9","563240ccdcc27a170082363b","563240dfbddb091700ad5e82","563240edfe9acd1900cc1d10","56324504fa40240d007c8d5f","56324b30c3b04b0d00ba9c96","563273ae45f2cb0d006be3fa","563273c08c9cda0d0025266d","563273cc38f8aa0d00d30f55","563273d838f8aa0d00d30f59","5632740945f2cb0d006be3fc","56327411df556c0d00cd0905","5632741b8c9cda0d0025266f","563274ea10b6040d008793d8","5632757cdf556c0d00cd0908","563275b710b6040d008793da","563275f938f8aa0d00d30f60","5632762fb904a10d0032f6fc","5632767110b6040d008793dd","563276c0b904a10d0032f700","5632770162c48a0d00334d53","5632843d8c9cda0d00252698","5632846e62c48a0d00334d78","56328a7e49e16d0d00122420","56328aaf49e16d0d00122425","56328b2238f8aa0d00d30f88","56328b6c8c9cda0d002526a2","56328c0710b6040d008793ff","56328c3710b6040d00879401","56328c5938f8aa0d00d30f8c","56328c90b904a10d0032f722","56328cc449e16d0d0012242a","56328ce68c9cda0d002526a8","56328d1338f8aa0d00d30f8e","56328d5810b6040d00879407","56328d7cdf556c0d00cd092f","56328d9a10b6040d00879409","56328db438f8aa0d00d30f92","56328dd762c48a0d00334d8b","56328df649e16d0d0012242d","56328e1edf556c0d00cd0931","56328e4662c48a0d00334d8e","56328e5edf556c0d00cd0933","56328e8f8c9cda0d002526ab","56328eb3b904a10d0032f72a","56328edb38f8aa0d00d30f95","56328ef210b6040d0087940d","56328f148c9cda0d002526ad","56328f2962c48a0d00334d90","56328f54b904a10d0032f72c","56328f6c38f8aa0d00d30f98","56328f858c9cda0d002526af","56328fae62c48a0d00334d95","56328fd838f8aa0d00d30f9c","5637f069ee0ee60d0024ec18","5641ffaa9417b40d00c0fc35","564355240d9748190079dea9","5644cfeb2c74cf1900da4831","56450f856b0ca50d00f6bd8f","56706537cbb2fb0d00f7c7dd","567065bc3d29830d00376213","56706fc2cbb2fb0d00f7c87e","568bf5a1e662f40d00eee866","568c0699e662f40d00eee881","568cff0274c77f2d00d56d51","568d10f58602880d001ce277","568d2abc37b636250036b904","568d343413c5ad0d00b34efb","568d593a8602880d001ce2d3","568e64135e12fb0d00325160","568e66f05e12fb0d00325162","568e78aa5e12fb0d0032517a","569433cfd8c04d1700e5ae0c","56943723d8c04d1700e5ae14","5694393b3e9d080d00f0655d","5694e6cf953b810d008f91bc","5694f301c5c5ce0d00058e68","569502ef9797fa1900f704e7","5695063bcaa32519009c40b3","569511cccaa32519009c40d9","569557e2fcb1032d0089dfe2","569562fefcb1032d0089dfee","56956428fe18811700c9c058","569639b87596a90d0014e5a3","56a90197e590350d004b5103","56a9021e9ec7660d002e08c2"],"project":"55faf11ba62ba1170021a9a7","version":"55faf11ba62ba1170021a9aa","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-09-17T17:34:34.937Z","from_sync":false,"order":26,"slug":"api","title":"API Reference"},"parentDoc":null,"project":"55faf11ba62ba1170021a9a7","user":"554340dfb7f4540d00fcef1d","version":{"__v":37,"_id":"55faf11ba62ba1170021a9aa","project":"55faf11ba62ba1170021a9a7","createdAt":"2015-09-17T16:58:03.490Z","releaseDate":"2015-09-17T16:58:03.490Z","categories":["55faf11ca62ba1170021a9ab","55faf8f4d0e22017005b8272","55faf91aa62ba1170021a9b5","55faf929a8a7770d00c2c0bd","55faf932a8a7770d00c2c0bf","55faf94b17b9d00d00969f47","55faf958d0e22017005b8274","55faf95fa8a7770d00c2c0c0","55faf96917b9d00d00969f48","55faf970a8a7770d00c2c0c1","55faf98c825d5f19001fa3a6","55faf99aa62ba1170021a9b8","55faf99fa62ba1170021a9b9","55faf9aa17b9d00d00969f49","55faf9b6a8a7770d00c2c0c3","55faf9bda62ba1170021a9ba","5604570090ee490d00440551","5637e8b2fbe1c50d008cb078","5649bb624fa1460d00780add","5671974d1b6b730d008b4823","5671979d60c8e70d006c9760","568e8eef70ca1f0d0035808e","56d0a2081ecc471500f1795e","56d4a0adde40c70b00823ea3","56d96b03dd90610b00270849","56fbb83d8f21c817002af880","573c811bee2b3b2200422be1","576bc92afb62dd20001cda85","5771811e27a5c20e00030dcd","5785191af3a10c0e009b75b0","57bdf84d5d48411900cd8dc0","57ff5c5dc135231700aed806","5804caf792398f0f00e77521","58458b4fba4f1c0f009692bb","586d3c287c6b5b2300c05055","58ef66d88646742f009a0216","58f5d52d7891630f00fe4e77"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"updates":["56704a031dabd80d00b12207"],"next":{"pages":[],"description":""},"createdAt":"2015-10-29T21:27:48.637Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"method":"get","results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":true,"order":72,"body":"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](doc:list-tasks-you-can-access).\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"https://cgc-api.sbgenomics.com/v2/tasks/{task_id}\",\n      \"language\": \"text\",\n      \"name\": \"Path\"\n    }\n  ]\n}\n[/block]\nThe 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.\n\n##Request\n\n###Example request\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"GET /v2/tasks/08c5ce64-1551-4b7d-b054-63a1517bc7bb HTTP/1.1\\nHost: cgc-api.sbgenomics.com\\nX-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74\\n\",\n      \"language\": \"http\",\n      \"name\": null\n    },\n    {\n      \"code\": \"curl  -s -H \\\"X-SBG-Auth-Token: 6282d5e2121d43e7900e9d52b15845e7\\\" -H \\\"content-type: application/json\\\" -X GET \\\"https://cgc-api.sbgenomics.com/v2/tasks/08c5ce64-1551-4b7d-b054-63a1517bc7bb\\\"\",\n      \"language\": \"curl\",\n      \"name\": \"cURL\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n###Header Fields\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Name\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"`X-SBG-Auth-Token`\\n_required_\",\n    \"0-1\": \"Your CGC [authentication token](doc:get-your-authentication-token).\",\n    \"h-2\": \"\"\n  },\n  \"cols\": 2,\n  \"rows\": 1\n}\n[/block]\n###Path parameters\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"`task_id`\\n_required_\",\n    \"h-0\": \"Name\",\n    \"h-1\": \"Description\",\n    \"0-1\": \"The ID of the task you are querying\"\n  },\n  \"cols\": 2,\n  \"rows\": 1\n}\n[/block]\n###Query parameters\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Name\",\n    \"h-1\": \"Data type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"`fields`\",\n    \"0-1\": \"string\",\n    \"0-2\": \"Selector specifying a subset of fields to include in the response.\"\n  },\n  \"cols\": 3,\n  \"rows\": 1\n}\n[/block]\n##Response\n\n[See a list of CGC-specific response codes that may be contained in the body of the response.](doc:api-status-codes) \n\nThe 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).\n\n###Regular task response body\nThe example below contains an example response body from a regular (non-batch) task.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"href\\\": \\\"https://api.sbgenomics.com/v2/tasks/f586a3fb-c9e4-4415-b22b-648a66969a37\\\",\\n  \\\"id\\\": \\\"f586a3fb-c9e4-4415-b22b-648a66969a37\\\",\\n  \\\"name\\\": \\\"grep run - 11-26-15 14:14:14\\\",\\n  \\\"status\\\": \\\"COMPLETED\\\",\\n  \\\"project\\\": \\\"RFranklin/test\\\",\\n  \\\"app\\\": \\\"RFranklin/my-project/grep/5\\\",\\n  \\\"type\\\": \\\"v2\\\",\\n  \\\"batch\\\": false,\\n  \\\"created_by\\\": \\\"RFranklin\\\",\\n  \\\"executed_by\\\": \\\"RFranklin\\\",\\n  \\\"start_time\\\": \\\"2015-11-26T14:14:14Z\\\",\\n  \\\"end_time\\\": \\\"2015-11-26T14:20:30Z\\\",\\n  \\\"execution_status\\\": {\\n        \\\"steps_completed\\\": 19,\\n        \\\"system_limit\\\": false,\\n        \\\"account_limit\\\": false,\\n        \\\"instance_init\\\": false,\\n        \\\"steps_total\\\": 19,\\n        \\\"message\\\": \\\"Completed\\\",\\n        \\\"duration\\\": 0,\\n        \\\"queued_duration\\\": 0,\\n        \\\"running_duration\\\": 0,\\n        \\\"execution_duration\\\": 0\\n      },\\n  \\\"price\\\": {\\n    \\\"currency\\\": \\\"USD\\\",\\n    \\\"amount\\\": \\\"0.23\\\",\\n    \\\"breakdown\\\": {\\n      \\\"storage\\\": \\\"0.00\\\",\\n      \\\"computation\\\": \\\"0.23\\\"\\n    }\\n  },\\n  \\\"inputs\\\": {\\n    \\\"file_to_search\\\": {\\n      \\\"class\\\": \\\"File\\\",\\n      \\\"path\\\": \\\"5655df71e4b08c5d86970945\\\",\\n      \\\"name\\\": \\\"test-text.txt\\\"\\n    },\\n    \\\"lines_of_context\\\": 2,\\n    \\\"pattern_to_find\\\": \\\"word\\\"\\n  },\\n  \\\"outputs\\\": {\\n    \\\"pattern_found\\\": {\\n      \\\"path\\\": \\\"5657152ee4b0298dd2cdf724\\\",\\n      \\\"name\\\": \\\"output.txt\\\",\\n      \\\"class\\\": \\\"File\\\"\\n    }\\n  }\\n}\",\n      \"language\": \"json\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n###Batch task response body\nThe example below contains an example response body from batch task. \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"href\\\": \\\"https://staging-api.sbgenomics.com/v2/tasks/a547a1c4-45c3-441e-857e-caf2a2df96ad\\\",\\n    \\\"id\\\": \\\"a547a1c4-45c3-441e-857e-caf2a2df96ad\\\",\\n    \\\"name\\\": \\\"Tengfei and Damir playing\\\",\\n    \\\"status\\\": \\\"ABORTED\\\",\\n    \\\"project\\\": \\\"damirk/batch-test\\\",\\n    \\\"app\\\": \\\"damirk/batch-test/whole-exome-sequencing-gatk-2-3-9-lite/2\\\",\\n    \\\"type\\\": \\\"v2\\\",\\n    \\\"created_by\\\": \\\"damirk\\\",\\n    \\\"executed_by\\\": \\\"damirk\\\",\\n    \\\"start_time\\\": \\\"2016-04-05T12:18:14Z\\\",\\n    \\\"end_time\\\": \\\"2016-04-07T11:04:42Z\\\",\\n    \\\"batch\\\": true,\\n    \\\"batch_input\\\": \\\"FASTQ\\\",\\n    \\\"batch_by\\\": {\\n        \\\"type\\\": \\\"CRITERIA\\\",\\n        \\\"criteria\\\": [\\n            \\\"metadata.sample_id\\\",\\n            \\\"metadata.library_id\\\"\\n        ]\\n    },\\n    \\\"execution_status\\\": {\\n        \\\"duration\\\": '123456789',\\n        \\\"running_duration\\\": '120453636',\\n        \\\"queued_duration\\\": '3456789',\\n        \\\"message\\\": \\\"Batch tasks list initialization.\\\",\\n        \\\"queued\\\": 0,\\n        \\\"running\\\": 0,\\n        \\\"completed\\\": 0,\\n        \\\"failed\\\": 0,\\n        \\\"aborted\\\": 0,\\n        \\\"execution_duration\\\": 0\\n        \\\"system_limit\\\": false,\\n        \\\"account_limit\\\": false,\\n    },\\n    \\\"price\\\": {\\n        \\\"currency\\\": \\\"USD\\\",\\n        \\\"amount\\\": \\\"0.00\\\",\\n    },\\n    \\\"inputs\\\": {\\n        \\\"Known_SNPs\\\": [\\n            {\\n                \\\"class\\\": \\\"File\\\",\\n                \\\"path\\\": \\\"5702cd5a60b27cfe6e8c13bf\\\",\\n                \\\"name\\\": \\\"dbsnp_137.b37.vcf\\\"\\n            }\\n        ],\\n        <snip>\\n    }\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\n\n###Interpreting the response body\nThe following key-value pairs in the response body indicate the batch status of the task:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Key\",\n    \"h-1\": \"Datatype of value\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"`\\\"batch\\\"`\",\n    \"1-0\": \"`\\\"parent\\\"`\",\n    \"0-1\": \"boolean\",\n    \"0-2\": \"Set to `True` if the task is a parent batch task; otherwise `False`.\",\n    \"1-1\": \"string\",\n    \"1-2\": \"The ID of the parent task, in the case that the task is part of a batch (i.e. a child task).\",\n    \"2-0\": \"`\\\"batch_group\\\"`\",\n    \"2-1\": \"dictionary\",\n    \"2-2\": \"Present only for child tasks. \\nThis describes the structure of the parent task, i.e. the criteria by which tasks are batched.\\n\\n1. If tasks are batched per item in the input, the structure is as shown in the following example:\\n\\n`\\\"batch_group\\\": {\\n    \\\"value\\\": \\\"C18-146.fastq\\\",\\n    \\\"fields\\\": {}\\n}`\\n\\n2. If tasks are batched by metadata fields, the structure is as shown in the following example:\\n\\n`\\\"batch_group\\\": {\\n    \\\"value\\\": \\\"hg19, E18127-pool40-L2355\\\",\\n    \\\"fields\\\": {\\n        \\\"metadata.library_id\\\": \\\"hg19\\\",\\n        \\\"metadata.sample_id\\\": \\\"E18127-pool40-L2355\\\"\\n    }\\n}`\",\n    \"3-0\": \"`\\\"execution_status\\\"`\",\n    \"3-1\": \"dictionary\",\n    \"3-2\": \"For a parent task, this describes the number of child tasks in any given state, in the following form:\\n\\n`\\\"execution_status\\\": {\\n    \\\"message\\\": \\\"Running\\\",\\n    \\\"queued\\\": 1,\\n    \\\"running\\\": 5,\\n    \\\"completed\\\": 2,\\n    \\\"failed\\\": 1,\\n    \\\"aborted\\\": 0\\n}`\\n\\nFor a child task or a single task (not part of a batch), the execution status lists a number of steps.\",\n    \"4-0\": \"`\\\"errors\\\"`\",\n    \"4-1\": \"array\",\n    \"4-2\": \"If there are any errors related to task validation, they will be represented here in an array. Each of the errors is represented by a dictionary, containing the error type, a human readable message, and the ID of the input responsible for the input. There may also be further data, if it is available. \\n\\nSee below for an example of the error array, and information on interpreting it.\"\n  },\n  \"cols\": 3,\n  \"rows\": 5\n}\n[/block]\n###Example of the `\"errors\"` array, contained in the response body:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"\\\"errors\\\": [\\n    {\\n      \\\"type\\\": \\\"error/task_validation/input/schema\\\",\\n      \\\"message\\\": \\\"Value for this input does not match the expected type.\\\",\\n      \\\"input_id\\\": \\\"FASTQ\\\"\\n    },\\n    {\\n      \\\"type\\\": \\\"error/task_validation/input/schema\\\",\\n      \\\"message\\\": \\\"Value for this input does not match the expected type.\\\",\\n      \\\"input_id\\\": \\\"SnpEff_Database\\\"\\n    },\\n    {\\n      \\\"type\\\": \\\"error/task_validation/input/schema\\\",\\n      \\\"message\\\": \\\"Value for this input does not match the expected type.\\\",\\n      \\\"input_id\\\": \\\"Reference\\\"\\n    }\\n  ]\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n###More on task validations and validation errors\nWhenever 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.\nAll validations errors are stored as a high-level `errors` array property in the API response.\n\nYou may get the following errors if a task fails these validations:\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Number\",\n    \"h-1\": \"Validation error type\",\n    \"h-2\": \"Validation message\",\n    \"0-0\": \"1\",\n    \"1-0\": \"2\",\n    \"2-0\": \"3\",\n    \"3-0\": \"4\",\n    \"0-1\": \"error/task_validation/input/schema\",\n    \"1-1\": \"error/task_validation/input/invalid_name_files\",\n    \"2-1\": \"error/task_validation/input/files_missing\",\n    \"3-1\": \"error/task_validation/input/secondary_files_missing\",\n    \"0-2\": \"Value for this input does not match the expected type.\",\n    \"1-2\": \"Some 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.\",\n    \"2-2\": \"Some files found in this input cannot be found in the project.\",\n    \"3-2\": \"Some secondary (index) files required by this input cannot be found in the project\",\n    \"h-3\": \"Comment\",\n    \"0-3\": \"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.\",\n    \"1-3\": \"This error occurs when you enter a space or other special character that can cause problems when running a command line tool.\",\n    \"2-3\": \"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.\",\n    \"3-3\": \"This 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.\"\n  },\n  \"cols\": 4,\n  \"rows\": 4\n}\n[/block]","excerpt":"/tasks/{task_id}","slug":"get-details-of-a-task","type":"endpoint","title":"Get details of a task"}

getGet details of a task

/tasks/{task_id}

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](doc:list-tasks-you-can-access). [block:code] { "codes": [ { "code": "https://cgc-api.sbgenomics.com/v2/tasks/{task_id}", "language": "text", "name": "Path" } ] } [/block] 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. ##Request ###Example request [block:code] { "codes": [ { "code": "GET /v2/tasks/08c5ce64-1551-4b7d-b054-63a1517bc7bb HTTP/1.1\nHost: cgc-api.sbgenomics.com\nX-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74\n", "language": "http", "name": null }, { "code": "curl -s -H \"X-SBG-Auth-Token: 6282d5e2121d43e7900e9d52b15845e7\" -H \"content-type: application/json\" -X GET \"https://cgc-api.sbgenomics.com/v2/tasks/08c5ce64-1551-4b7d-b054-63a1517bc7bb\"", "language": "curl", "name": "cURL" } ], "sidebar": true } [/block] ###Header Fields [block:parameters] { "data": { "h-0": "Name", "h-1": "Description", "0-0": "`X-SBG-Auth-Token`\n_required_", "0-1": "Your CGC [authentication token](doc:get-your-authentication-token).", "h-2": "" }, "cols": 2, "rows": 1 } [/block] ###Path parameters [block:parameters] { "data": { "0-0": "`task_id`\n_required_", "h-0": "Name", "h-1": "Description", "0-1": "The ID of the task you are querying" }, "cols": 2, "rows": 1 } [/block] ###Query parameters [block:parameters] { "data": { "h-0": "Name", "h-1": "Data type", "h-2": "Description", "0-0": "`fields`", "0-1": "string", "0-2": "Selector specifying a subset of fields to include in the response." }, "cols": 3, "rows": 1 } [/block] ##Response [See a list of CGC-specific response codes that may be contained in the body of the response.](doc:api-status-codes) 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). ###Regular task response body The example below contains an example response body from a regular (non-batch) task. [block:code] { "codes": [ { "code": "{\n \"href\": \"https://api.sbgenomics.com/v2/tasks/f586a3fb-c9e4-4415-b22b-648a66969a37\",\n \"id\": \"f586a3fb-c9e4-4415-b22b-648a66969a37\",\n \"name\": \"grep run - 11-26-15 14:14:14\",\n \"status\": \"COMPLETED\",\n \"project\": \"RFranklin/test\",\n \"app\": \"RFranklin/my-project/grep/5\",\n \"type\": \"v2\",\n \"batch\": false,\n \"created_by\": \"RFranklin\",\n \"executed_by\": \"RFranklin\",\n \"start_time\": \"2015-11-26T14:14:14Z\",\n \"end_time\": \"2015-11-26T14:20:30Z\",\n \"execution_status\": {\n \"steps_completed\": 19,\n \"system_limit\": false,\n \"account_limit\": false,\n \"instance_init\": false,\n \"steps_total\": 19,\n \"message\": \"Completed\",\n \"duration\": 0,\n \"queued_duration\": 0,\n \"running_duration\": 0,\n \"execution_duration\": 0\n },\n \"price\": {\n \"currency\": \"USD\",\n \"amount\": \"0.23\",\n \"breakdown\": {\n \"storage\": \"0.00\",\n \"computation\": \"0.23\"\n }\n },\n \"inputs\": {\n \"file_to_search\": {\n \"class\": \"File\",\n \"path\": \"5655df71e4b08c5d86970945\",\n \"name\": \"test-text.txt\"\n },\n \"lines_of_context\": 2,\n \"pattern_to_find\": \"word\"\n },\n \"outputs\": {\n \"pattern_found\": {\n \"path\": \"5657152ee4b0298dd2cdf724\",\n \"name\": \"output.txt\",\n \"class\": \"File\"\n }\n }\n}", "language": "json" } ], "sidebar": true } [/block] ###Batch task response body The example below contains an example response body from batch task. [block:code] { "codes": [ { "code": "{\n \"href\": \"https://staging-api.sbgenomics.com/v2/tasks/a547a1c4-45c3-441e-857e-caf2a2df96ad\",\n \"id\": \"a547a1c4-45c3-441e-857e-caf2a2df96ad\",\n \"name\": \"Tengfei and Damir playing\",\n \"status\": \"ABORTED\",\n \"project\": \"damirk/batch-test\",\n \"app\": \"damirk/batch-test/whole-exome-sequencing-gatk-2-3-9-lite/2\",\n \"type\": \"v2\",\n \"created_by\": \"damirk\",\n \"executed_by\": \"damirk\",\n \"start_time\": \"2016-04-05T12:18:14Z\",\n \"end_time\": \"2016-04-07T11:04:42Z\",\n \"batch\": true,\n \"batch_input\": \"FASTQ\",\n \"batch_by\": {\n \"type\": \"CRITERIA\",\n \"criteria\": [\n \"metadata.sample_id\",\n \"metadata.library_id\"\n ]\n },\n \"execution_status\": {\n \"duration\": '123456789',\n \"running_duration\": '120453636',\n \"queued_duration\": '3456789',\n \"message\": \"Batch tasks list initialization.\",\n \"queued\": 0,\n \"running\": 0,\n \"completed\": 0,\n \"failed\": 0,\n \"aborted\": 0,\n \"execution_duration\": 0\n \"system_limit\": false,\n \"account_limit\": false,\n },\n \"price\": {\n \"currency\": \"USD\",\n \"amount\": \"0.00\",\n },\n \"inputs\": {\n \"Known_SNPs\": [\n {\n \"class\": \"File\",\n \"path\": \"5702cd5a60b27cfe6e8c13bf\",\n \"name\": \"dbsnp_137.b37.vcf\"\n }\n ],\n <snip>\n }\n}", "language": "json" } ] } [/block] ###Interpreting the response body The following key-value pairs in the response body indicate the batch status of the task: [block:parameters] { "data": { "h-0": "Key", "h-1": "Datatype of value", "h-2": "Description", "0-0": "`\"batch\"`", "1-0": "`\"parent\"`", "0-1": "boolean", "0-2": "Set to `True` if the task is a parent batch task; otherwise `False`.", "1-1": "string", "1-2": "The ID of the parent task, in the case that the task is part of a batch (i.e. a child task).", "2-0": "`\"batch_group\"`", "2-1": "dictionary", "2-2": "Present only for child tasks. \nThis describes the structure of the parent task, i.e. the criteria by which tasks are batched.\n\n1. If tasks are batched per item in the input, the structure is as shown in the following example:\n\n`\"batch_group\": {\n \"value\": \"C18-146.fastq\",\n \"fields\": {}\n}`\n\n2. If tasks are batched by metadata fields, the structure is as shown in the following example:\n\n`\"batch_group\": {\n \"value\": \"hg19, E18127-pool40-L2355\",\n \"fields\": {\n \"metadata.library_id\": \"hg19\",\n \"metadata.sample_id\": \"E18127-pool40-L2355\"\n }\n}`", "3-0": "`\"execution_status\"`", "3-1": "dictionary", "3-2": "For a parent task, this describes the number of child tasks in any given state, in the following form:\n\n`\"execution_status\": {\n \"message\": \"Running\",\n \"queued\": 1,\n \"running\": 5,\n \"completed\": 2,\n \"failed\": 1,\n \"aborted\": 0\n}`\n\nFor a child task or a single task (not part of a batch), the execution status lists a number of steps.", "4-0": "`\"errors\"`", "4-1": "array", "4-2": "If there are any errors related to task validation, they will be represented here in an array. Each of the errors is represented by a dictionary, containing the error type, a human readable message, and the ID of the input responsible for the input. There may also be further data, if it is available. \n\nSee below for an example of the error array, and information on interpreting it." }, "cols": 3, "rows": 5 } [/block] ###Example of the `"errors"` array, contained in the response body: [block:code] { "codes": [ { "code": "\"errors\": [\n {\n \"type\": \"error/task_validation/input/schema\",\n \"message\": \"Value for this input does not match the expected type.\",\n \"input_id\": \"FASTQ\"\n },\n {\n \"type\": \"error/task_validation/input/schema\",\n \"message\": \"Value for this input does not match the expected type.\",\n \"input_id\": \"SnpEff_Database\"\n },\n {\n \"type\": \"error/task_validation/input/schema\",\n \"message\": \"Value for this input does not match the expected type.\",\n \"input_id\": \"Reference\"\n }\n ]", "language": "json" } ] } [/block] ###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: [block:parameters] { "data": { "h-0": "Number", "h-1": "Validation error type", "h-2": "Validation message", "0-0": "1", "1-0": "2", "2-0": "3", "3-0": "4", "0-1": "error/task_validation/input/schema", "1-1": "error/task_validation/input/invalid_name_files", "2-1": "error/task_validation/input/files_missing", "3-1": "error/task_validation/input/secondary_files_missing", "0-2": "Value for this input does not match the expected type.", "1-2": "Some 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.", "2-2": "Some files found in this input cannot be found in the project.", "3-2": "Some secondary (index) files required by this input cannot be found in the project", "h-3": "Comment", "0-3": "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.", "1-3": "This error occurs when you enter a space or other special character that can cause problems when running a command line tool.", "2-3": "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.", "3-3": "This 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." }, "cols": 4, "rows": 4 } [/block]