{"_id":"56328f2962c48a0d00334d90","parentDoc":null,"version":{"_id":"55faf11ba62ba1170021a9aa","project":"55faf11ba62ba1170021a9a7","__v":38,"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","59a555bccdbd85001bfb1442"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"__v":18,"project":"55faf11ba62ba1170021a9a7","user":"554340dfb7f4540d00fcef1d","category":{"_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","__v":92,"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-09-17T17:34:34.937Z","from_sync":false,"order":27,"slug":"api","title":"API Reference"},"updates":["56a61d1efb12a40d006c4779"],"next":{"pages":[],"description":""},"createdAt":"2015-10-29T21:27:05.014Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"settings":"","examples":{"codes":[]},"method":"post","results":{"codes":[]},"auth":"required","params":[],"url":""},"isReference":true,"order":69,"body":"This call creates a new task.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"https://cgc-api.sbgenomics.com/v2/tasks\",\n      \"language\": \"text\",\n      \"name\": \"Path\"\n    }\n  ]\n}\n[/block]\n##Request\n\n###Example request\nIn the example, the new task is included in the body as `new-task.json`, shown below.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"POST /v2/tasks 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 --data-binary \\\":::at:::new-task.json\\\" -s -H \\\"X-SBG-Auth-Token: 6282d5e2121d43e7900e9d52b15845e7\\\" -H \\\"content-type: application/json\\\" -X POST \\\"https://cgc-api.sbgenomics.com/v2/tasks\\\"\",\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###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    \"1-0\": \"`run`\",\n    \"1-1\": \"boolean\",\n    \"1-2\": \"If set to `true`, API will run the task upon creation. If not specified, default value of `false` is applied and task is not run, but a draft task is created.\"\n  },\n  \"cols\": 3,\n  \"rows\": 2\n}\n[/block]\n#Request body\n\nYou can see a list of the app's input nodes on the Seven Bridges Platform on the **apps** page for the project. Specify the files to input to the nodes using the files' IDs, which you can obtain using the call to [GET /files](doc:list-files-in-a-project).\n\n##Request body\nThe request body should be a JSON object specifying the app that you want to run, and assigning input files to its input nodes. It is entered as a list of key-value pairs. The keys specify the name and description of the task to be created, the app to executed, and details of its inputs files. The keys, and their permitted values, are described below.\n\nYou can see a list of the app's input nodes on the CGC, on the **apps** page for the project. Specify the files to input to the nodes using the files' IDs, which you can obtain using the call to <a href=\"http://docs.cancergenomicscloud.org/docs/list-files-in-a-project\">GET /files</a>.\n[block:callout]\n{\n  \"type\": \"success\",\n  \"title\": \"Batch tasks\",\n  \"body\": \"This API call can be used to create and run batch tasks. You can either use the app's default batching, override batching or disable batching completely.\\n\\nA **parent task** is a task that specifies criteria by which to batch its inputs into a series of further sub-tasks, called **child tasks**.\\n\\nSee the documentation on [batching tasks](doc:perform-batch-analysis) for more details on batching criteria.\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Key\",\n    \"h-1\": \"Datatype of value\",\n    \"h-2\": \"Description of value\",\n    \"0-0\": \"`\\\"name\\\"`\",\n    \"1-0\": \"`\\\"description\\\"`\",\n    \"2-0\": \"`\\\"project\\\"`\",\n    \"3-0\": \"`\\\"app\\\"`\",\n    \"4-0\": \"`\\\"inputs\\\"`\",\n    \"0-1\": \"string\",\n    \"1-1\": \"string\",\n    \"2-1\": \"string\",\n    \"3-1\": \"string\",\n    \"4-1\": \"dictionary.\",\n    \"0-2\": \"The name of the task\",\n    \"1-2\": \"An optional description of the task\",\n    \"2-2\": \"The [short name](http://docs.cancergenomicscloud.org/v1.0/docs/the-cgc-api#section-identifying-projects-users-apps-files-and-tasks) of the project that you want to create the task in\",\n    \"3-2\": \"The specification of the app that you want to run. Recall that apps are specified by their projects, in the form `{project_owner}/{project}/{app_name}`\",\n    \"4-2\": \"See the [API Overview](doc:the-cgc-api)  section on [specifying inputs](http://docs.cancergenomicscloud.org/v1.0/docs/the-cgc-api#section-inputs) for information on creating input objects.\",\n    \"5-0\": \"<a name=\\\"batch-input\\\"></a>\\\"`batch_input\\\"`\",\n    \"5-1\": \"string\",\n    \"5-2\": \"The ID of the input on which you wish to batch. You would typically batch on the input consisting of a list of files. If this parameter is omitted, the default batching criteria defined for the app will be used.\",\n    \"6-0\": \"<a name=\\\"batch-by\\\"></a>\\\"`batch_by\\\"`\",\n    \"6-1\": \"dictionary\",\n    \"6-2\": \"This specifies the criteria on which to batch. It can be in one of two formats.\\n\\n1. If you wish to batch per item in the app's input (i.e., typically per file in a list of files) then specify a dictionary with the following format:\\n`{\\n   \\\"type\\\": \\\"ITEM\\\"\\n}`\\n\\n2. If you wish to batch by groups of inputs, you should specify the criteria satisfied by each group. This should be a common metadata value in one, or more, metadata fields.\\n\\nTo do this, specify a dictionary with the following format:\\n\\n`{\\n   \\\"type\\\": \\\"CRITERIA\\\",\\n   \\\"criteria\\\": [\\n        \\\"metadata.<field_1>\\\", \\\"metadata.<field_2>\\\"\\n    ]\\n}`\\nThis will group inputs by shared metadata values for `<field_1>` and `<field_2>`, in that order. Arbitrarily many metadata fields may be listed, and the order in which fields are grouped will respect the order of the list.\",\n    \"7-0\": \"`use_interruptible_instances`\",\n    \"7-1\": \"Boolean\",\n    \"7-2\": \"This field can be true or false. Set this field to true to allow the use of [spot instances](doc:about-spot-instances).\"\n  },\n  \"cols\": 3,\n  \"rows\": 8\n}\n[/block]\n###Example request body\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{   \\\"description\\\": \\\"my draft task\\\",\\n    \\\"name\\\": \\\"RFranklin, Experiment IV\\\",\\n    \\\"app\\\": \\\"RFranklin/my-project/new-test-app\\\",\\n    \\\"project\\\": \\\"RFranklin/my-project\\\",\\n    \\\"use_interruptible_instances\\\": true,\\n    \\\"inputs\\\": {\\n        \\\"cuffdiff_zip\\\": {\\n            \\\"class\\\": \\\"File\\\",\\n            \\\"path\\\": \\\"562785e6e4b00a1d67a8b1aa\\\",\\n            \\\"name\\\": \\\"example_human_known_indels.vcf\\\"\\n        }\\n    }\\n}\",\n      \"language\": \"json\"\n    }\n  ]\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). \nThe following key-value pairs in the response body indicate the batch status of the task:\n\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  },\n  \"cols\": 3,\n  \"rows\": 4\n}\n[/block]\n###Example response body\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"href\\\": \\\"https://cgc-api.sbgenomics.com/v2/tasks/a8497170-fcc3-4605-8f1f-8346aa84306a\\\",\\n  \\\"id\\\": \\\"a8497170-fcc3-4605-8f1f-8346aa84306a\\\",\\n  \\\"name\\\": \\\"RFranklin, Experiment IV\\\",\\n  \\\"description\\\": \\\"my draft task\\\",\\n  \\\"status\\\": \\\"DRAFT\\\",\\n  \\\"project\\\": \\\"RFranklin/my-project\\\",\\n  \\\"use_interruptible_instances\\\": true,\\n  \\\"app\\\": \\\"RFranklin/my-project/new-test-app/0\\\",\\n  \\\"type\\\": \\\"v2\\\",\\n  \\\"created_by\\\": \\\"RFranklin\\\",\\n  \\\"start_time\\\": \\\"2016-01-12T19:20:10Z\\\",\\n  \\\"inputs\\\": {\\n    \\\"dispersion_threshold\\\": null,\\n    \\\"cuffdiff_zip\\\": {\\n      \\\"class\\\": \\\"File\\\",\\n      \\\"path\\\": \\\"562785e6e4b00a1d67a8b1aa\\\",\\n      \\\"name\\\": \\\"example_human_known_indels.vcf\\\"\\n    },\\n    \\\"density_threshold\\\": null,\\n    \\\"thresholds_off\\\": null\\n  },\\n  \\\"outputs\\\": {\\n    \\\"archive\\\": null,\\n    \\\"html\\\": null\\n  }\\n}\\n\",\n      \"language\": \"json\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","excerpt":"/tasks","slug":"create-a-new-task","type":"endpoint","title":"Create a new draft task"}

postCreate a new draft task

/tasks

This call creates a new task. [block:code] { "codes": [ { "code": "https://cgc-api.sbgenomics.com/v2/tasks", "language": "text", "name": "Path" } ] } [/block] ##Request ###Example request In the example, the new task is included in the body as `new-task.json`, shown below. [block:code] { "codes": [ { "code": "POST /v2/tasks HTTP/1.1\nHost: cgc-api.sbgenomics.com\nX-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74\n", "language": "http", "name": null }, { "code": "curl --data-binary \"@new-task.json\" -s -H \"X-SBG-Auth-Token: 6282d5e2121d43e7900e9d52b15845e7\" -H \"content-type: application/json\" -X POST \"https://cgc-api.sbgenomics.com/v2/tasks\"", "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] ###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.", "1-0": "`run`", "1-1": "boolean", "1-2": "If set to `true`, API will run the task upon creation. If not specified, default value of `false` is applied and task is not run, but a draft task is created." }, "cols": 3, "rows": 2 } [/block] #Request body You can see a list of the app's input nodes on the Seven Bridges Platform on the **apps** page for the project. Specify the files to input to the nodes using the files' IDs, which you can obtain using the call to [GET /files](doc:list-files-in-a-project). ##Request body The request body should be a JSON object specifying the app that you want to run, and assigning input files to its input nodes. It is entered as a list of key-value pairs. The keys specify the name and description of the task to be created, the app to executed, and details of its inputs files. The keys, and their permitted values, are described below. You can see a list of the app's input nodes on the CGC, on the **apps** page for the project. Specify the files to input to the nodes using the files' IDs, which you can obtain using the call to <a href="http://docs.cancergenomicscloud.org/docs/list-files-in-a-project">GET /files</a>. [block:callout] { "type": "success", "title": "Batch tasks", "body": "This API call can be used to create and run batch tasks. You can either use the app's default batching, override batching or disable batching completely.\n\nA **parent task** is a task that specifies criteria by which to batch its inputs into a series of further sub-tasks, called **child tasks**.\n\nSee the documentation on [batching tasks](doc:perform-batch-analysis) for more details on batching criteria." } [/block] [block:parameters] { "data": { "h-0": "Key", "h-1": "Datatype of value", "h-2": "Description of value", "0-0": "`\"name\"`", "1-0": "`\"description\"`", "2-0": "`\"project\"`", "3-0": "`\"app\"`", "4-0": "`\"inputs\"`", "0-1": "string", "1-1": "string", "2-1": "string", "3-1": "string", "4-1": "dictionary.", "0-2": "The name of the task", "1-2": "An optional description of the task", "2-2": "The [short name](http://docs.cancergenomicscloud.org/v1.0/docs/the-cgc-api#section-identifying-projects-users-apps-files-and-tasks) of the project that you want to create the task in", "3-2": "The specification of the app that you want to run. Recall that apps are specified by their projects, in the form `{project_owner}/{project}/{app_name}`", "4-2": "See the [API Overview](doc:the-cgc-api) section on [specifying inputs](http://docs.cancergenomicscloud.org/v1.0/docs/the-cgc-api#section-inputs) for information on creating input objects.", "5-0": "<a name=\"batch-input\"></a>\"`batch_input\"`", "5-1": "string", "5-2": "The ID of the input on which you wish to batch. You would typically batch on the input consisting of a list of files. If this parameter is omitted, the default batching criteria defined for the app will be used.", "6-0": "<a name=\"batch-by\"></a>\"`batch_by\"`", "6-1": "dictionary", "6-2": "This specifies the criteria on which to batch. It can be in one of two formats.\n\n1. If you wish to batch per item in the app's input (i.e., typically per file in a list of files) then specify a dictionary with the following format:\n`{\n \"type\": \"ITEM\"\n}`\n\n2. If you wish to batch by groups of inputs, you should specify the criteria satisfied by each group. This should be a common metadata value in one, or more, metadata fields.\n\nTo do this, specify a dictionary with the following format:\n\n`{\n \"type\": \"CRITERIA\",\n \"criteria\": [\n \"metadata.<field_1>\", \"metadata.<field_2>\"\n ]\n}`\nThis will group inputs by shared metadata values for `<field_1>` and `<field_2>`, in that order. Arbitrarily many metadata fields may be listed, and the order in which fields are grouped will respect the order of the list.", "7-0": "`use_interruptible_instances`", "7-1": "Boolean", "7-2": "This field can be true or false. Set this field to true to allow the use of [spot instances](doc:about-spot-instances)." }, "cols": 3, "rows": 8 } [/block] ###Example request body [block:code] { "codes": [ { "code": "{ \"description\": \"my draft task\",\n \"name\": \"RFranklin, Experiment IV\",\n \"app\": \"RFranklin/my-project/new-test-app\",\n \"project\": \"RFranklin/my-project\",\n \"use_interruptible_instances\": true,\n \"inputs\": {\n \"cuffdiff_zip\": {\n \"class\": \"File\",\n \"path\": \"562785e6e4b00a1d67a8b1aa\",\n \"name\": \"example_human_known_indels.vcf\"\n }\n }\n}", "language": "json" } ] } [/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). 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." }, "cols": 3, "rows": 4 } [/block] ###Example response body [block:code] { "codes": [ { "code": "{\n \"href\": \"https://cgc-api.sbgenomics.com/v2/tasks/a8497170-fcc3-4605-8f1f-8346aa84306a\",\n \"id\": \"a8497170-fcc3-4605-8f1f-8346aa84306a\",\n \"name\": \"RFranklin, Experiment IV\",\n \"description\": \"my draft task\",\n \"status\": \"DRAFT\",\n \"project\": \"RFranklin/my-project\",\n \"use_interruptible_instances\": true,\n \"app\": \"RFranklin/my-project/new-test-app/0\",\n \"type\": \"v2\",\n \"created_by\": \"RFranklin\",\n \"start_time\": \"2016-01-12T19:20:10Z\",\n \"inputs\": {\n \"dispersion_threshold\": null,\n \"cuffdiff_zip\": {\n \"class\": \"File\",\n \"path\": \"562785e6e4b00a1d67a8b1aa\",\n \"name\": \"example_human_known_indels.vcf\"\n },\n \"density_threshold\": null,\n \"thresholds_off\": null\n },\n \"outputs\": {\n \"archive\": null,\n \"html\": null\n }\n}\n", "language": "json" } ], "sidebar": true } [/block]