{"_id":"5b0e13ffc4664e0003c75b18","__v":0,"parentDoc":null,"user":"554340dfb7f4540d00fcef1d","version":{"_id":"5b0e13ffc4664e0003c75a67","project":"5b0e13ffc4664e0003c75a66","__v":4,"createdAt":"2015-09-17T16:58:03.490Z","releaseDate":"2015-09-17T16:58:03.490Z","categories":["5b0e13ffc4664e0003c75a68","5b0e13ffc4664e0003c75a69","5b0e13ffc4664e0003c75a6a","5b0e13ffc4664e0003c75a6b","5b0e13ffc4664e0003c75a6c","5b0e13ffc4664e0003c75a6d","5b0e13ffc4664e0003c75a6e","5b0e13ffc4664e0003c75a6f","5b0e13ffc4664e0003c75a70","5b0e13ffc4664e0003c75a71","5b0e13ffc4664e0003c75a72","5b0e13ffc4664e0003c75a73","5b0e13ffc4664e0003c75a74","5b0e13ffc4664e0003c75a75","5b0e13ffc4664e0003c75a76","5b0e13ffc4664e0003c75a77","5b0e13ffc4664e0003c75a89","5b0e13ffc4664e0003c75a8a","5b0e13ffc4664e0003c75a9d","5b0e13ffc4664e0003c75a9e","5b0e13ffc4664e0003c75a9f","5b0e13ffc4664e0003c75aa0","5b0e13ffc4664e0003c75aa1","5b0e13ffc4664e0003c75aa2","5b0e13ffc4664e0003c75aa3","5b0e13ffc4664e0003c75aa4","5b0e13ffc4664e0003c75aa5","5b0e13ffc4664e0003c75aa6","5b0e13ffc4664e0003c75aa7","5b0e13ffc4664e0003c75aa8","5b0e13ffc4664e0003c75aa9","5b0e13ffc4664e0003c75aaa","5b0e13ffc4664e0003c75aab","5b0e13ffc4664e0003c75aac","5b0e13ffc4664e0003c75aad","5b0e13ffc4664e0003c75aae","5b0e13ffc4664e0003c75aaf","5b0e13ffc4664e0003c75ab2","5bb3374f4306ad0003eb18e7","5bbf3c5373e72a000318362b","5bc065567d1cb0000384c649","5cbf19a5f9181f0033fbb968"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"category":{"_id":"5b0e13ffc4664e0003c75a75","project":"5b0e13ffc4664e0003c75a66","version":"5b0e13ffc4664e0003c75a67","__v":0,"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-09-17T17:34:34.937Z","from_sync":false,"order":32,"slug":"api","title":"API Reference"},"project":"5b0e13ffc4664e0003c75a66","githubsync":"","metadata":{"title":"","description":"","image":[]},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-10-29T21:28:12.917Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","method":"post","examples":{"codes":[]},"auth":"required","params":[],"url":""},"isReference":true,"order":78,"body":"This call allows you to change the inputs and parameters of a 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://f4c-api.sbgenomics.com/v2/tasks/{task_id}\",\n      \"language\": \"text\",\n      \"name\": \"Path\"\n    }\n  ]\n}\n[/block]\n##Request\n\n###Example request\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"GET /v2/tasks/d4b11d92-8636-4db4-b72a-7444ef1b4d0d HTTP/1.1\\nHost: f4c-api.sbgenomics.com\\nX-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74\\n\",\n      \"language\": \"http\",\n      \"name\": null\n    },\n    {\n      \"code\": \"coming soon!\",\n      \"language\": \"curl\",\n      \"name\": \"cURL\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n###Example request body\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n \\n    \\\"inputs\\\": {\\n    \\\"infile\\\": {\\n        \\\"class\\\": \\\"File\\\",\\n        \\\"path\\\": \\\"562785e6e4b00a1d67a8b1aa\\\",\\n         \\\"name\\\": \\\"example_human_known_indels.vcf\\\"\\n    }\\n },\\n  \\n\\\"description\\\": \\\"Test\\\",\\n\\\"name\\\": \\\"test123412wqdq\\\"\\n}\",\n      \"language\": \"json\"\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 [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    \"1-0\": \"`version`\\n_required_\",\n    \"h-0\": \"Name\",\n    \"h-1\": \"Description\",\n    \"0-1\": \"The ID of the task you are changing.\",\n    \"1-1\": \"The version of the task you are changing.\"\n  },\n  \"cols\": 2,\n  \"rows\": 2\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 response codes that may be contained in the body of the response.](doc:api-status-codes) \n\n###Example response body\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"href\\\": \\\"https://f4c-api.sbgenomics.com/v2/tasks/d4b11d92-8636-4db4-b72a-7444ef1b4d0d\\\",\\n  \\\"id\\\": \\\"d4b11d92-8636-4db4-b72a-7444ef1b4d0d\\\",\\n  \\\"name\\\": \\\"testsenad\\\",\\n  \\\"description\\\": \\\"Test\\\",\\n  \\\"status\\\": \\\"Active\\\",\\n  \\\"project\\\": \\\"cwl-abc\\\",\\n  \\\"app_id\\\": \\\"genomko/cwl-abc/cat/2\\\",\\n  \\\"created_by\\\": \\\"genomko\\\",\\n  \\\"start_time\\\": \\\"2015-10-27T15:14:36Z\\\",\\n  \\\"inputs\\\": {\\n    \\\"infile\\\": {\\n      \\\"schema\\\": [\\n        \\\"null\\\",\\n        \\\"File\\\"\\n      ],\\n      \\\"value\\\": {\\n        \\\"class\\\": \\\"File\\\",\\n        \\\"path\\\": \\\"562785e6e4b00a1d67a8b1aa\\\",\\n        \\\"name\\\": \\\"example_human_known_indels.vcf\\\"\\n      },\\n      \\\"errors\\\": null,\\n      \\\"files\\\": null,\\n      \\\"missing_files\\\": null\\n    },\\n    \\\"outfile\\\": {\\n      \\\"schema\\\": [\\n        \\\"null\\\",\\n        \\\"string\\\"\\n      ],\\n      \\\"value\\\": null,\\n      \\\"errors\\\": null,\\n      \\\"files\\\": null,\\n      \\\"missing_files\\\": null\\n    }\\n  }\\n}\",\n      \"language\": \"json\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","excerpt":"/tasks/{task_id}","slug":"change-details-of-a-task","type":"endpoint","title":"Change details of a task"}

postChange details of a task

/tasks/{task_id}

This call allows you to change the inputs and parameters of a 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://f4c-api.sbgenomics.com/v2/tasks/{task_id}", "language": "text", "name": "Path" } ] } [/block] ##Request ###Example request [block:code] { "codes": [ { "code": "GET /v2/tasks/d4b11d92-8636-4db4-b72a-7444ef1b4d0d HTTP/1.1\nHost: f4c-api.sbgenomics.com\nX-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74\n", "language": "http", "name": null }, { "code": "coming soon!", "language": "curl", "name": "cURL" } ], "sidebar": true } [/block] ###Example request body [block:code] { "codes": [ { "code": "{\n \n \"inputs\": {\n \"infile\": {\n \"class\": \"File\",\n \"path\": \"562785e6e4b00a1d67a8b1aa\",\n \"name\": \"example_human_known_indels.vcf\"\n }\n },\n \n\"description\": \"Test\",\n\"name\": \"test123412wqdq\"\n}", "language": "json" } ], "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 [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_", "1-0": "`version`\n_required_", "h-0": "Name", "h-1": "Description", "0-1": "The ID of the task you are changing.", "1-1": "The version of the task you are changing." }, "cols": 2, "rows": 2 } [/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 response codes that may be contained in the body of the response.](doc:api-status-codes) ###Example response body [block:code] { "codes": [ { "code": "{\n \"href\": \"https://f4c-api.sbgenomics.com/v2/tasks/d4b11d92-8636-4db4-b72a-7444ef1b4d0d\",\n \"id\": \"d4b11d92-8636-4db4-b72a-7444ef1b4d0d\",\n \"name\": \"testsenad\",\n \"description\": \"Test\",\n \"status\": \"Active\",\n \"project\": \"cwl-abc\",\n \"app_id\": \"genomko/cwl-abc/cat/2\",\n \"created_by\": \"genomko\",\n \"start_time\": \"2015-10-27T15:14:36Z\",\n \"inputs\": {\n \"infile\": {\n \"schema\": [\n \"null\",\n \"File\"\n ],\n \"value\": {\n \"class\": \"File\",\n \"path\": \"562785e6e4b00a1d67a8b1aa\",\n \"name\": \"example_human_known_indels.vcf\"\n },\n \"errors\": null,\n \"files\": null,\n \"missing_files\": null\n },\n \"outfile\": {\n \"schema\": [\n \"null\",\n \"string\"\n ],\n \"value\": null,\n \"errors\": null,\n \"files\": null,\n \"missing_files\": null\n }\n }\n}", "language": "json" } ], "sidebar": true } [/block]