{"_id":"564372751ecf381700343c1e","__v":6,"category":{"_id":"5601aee850ee460d0002224c","__v":20,"project":"55faeacad0e22017005b8265","version":"55faeacad0e22017005b8268","pages":["56023786930fe1170074bd2c","561d53a09463520d00cd11ef","561d546d31d9630d001eb5d1","561d54af31d9630d001eb5d3","561d54e56386060d00e0601e","561d554d9463520d00cd11f2","564246059f4ed50d008be1af","5643712a0d9748190079defb","564372751ecf381700343c1e","5643742008894c0d00031ed3","5643747a0d9748190079df01","564375c988f3a60d00ac86b0","56437d0f0d9748190079df13","56437e83f49bfa0d002f560a","56437f7d0d9748190079df15","5643810508894c0d00031ef5","5643826f88f3a60d00ac86cb","564382de88f3a60d00ac86ce","56e07ba14685db1700d94873","56e08c9b903c7a29001d5352"],"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-09-22T19:41:28.703Z","from_sync":false,"order":8,"slug":"tasks-and-workflows-guide","title":"Tasks and Workflows Guide"},"project":"55faeacad0e22017005b8265","parentDoc":null,"version":{"_id":"55faeacad0e22017005b8268","project":"55faeacad0e22017005b8265","__v":34,"createdAt":"2015-09-17T16:31:06.800Z","releaseDate":"2015-09-17T16:31:06.800Z","categories":["55faeacbd0e22017005b8269","55faf550764f50210095078e","55faf5b5626c341700fd9e96","55faf8a7825d5f19001fa386","560052f91503430d007cc88f","560054f73aa0520d00da0b1a","56005aaf6932a00d00ba7c62","56005c273aa0520d00da0b3f","5601ae7681a9670d006d164d","5601ae926811d00d00ceb487","5601aeb064866b1900f4768d","5601aee850ee460d0002224c","5601afa02499c119000faf19","5601afd381a9670d006d1652","561d4c78281aec0d00eb27b6","561d588d8ca8b90d00210219","563a5f934cc3621900ac278c","5665c5763889610d0008a29e","566710a36819320d000c2e93","56ddf6df8a5ae10e008e3926","56e1c96b2506700e00de6e83","56e1ccc4e416450e00b9e48c","56e1ccdfe63f910e00e59870","56e1cd10bc46be0e002af26a","56e1cd21e416450e00b9e48e","56e3139a51857d0e008e77be","573b4f62ef164e2900a2b881","57c9d1335fd8ca0e006308ed","57e2bd9d1e7b7220000d7fa5","57f2b992ac30911900c7c2b6","58adb5c275df0f1b001ed59b","58c81b5c6dc7140f003c3c46","595412446ed4d9001b3e7b37","59e76ce41938310028037295"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"v1","version_clean":"1.0.0","version":"1"},"user":"55fae9d4825d5f19001fa379","updates":["58918d7c0152e20f00bef6fd"],"next":{"pages":[],"description":""},"createdAt":"2015-11-11T16:53:09.035Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"name":"","code":"{\n\t\"name\": \"test-success\",\n\t\"description\": \"Runs a no-op task that writes successful output status.\",\n\t\"version\": \"0.0.1\",\n\t\"properties\": {\n\t\t\"isPublic\": true,\n\t\t\"timeout\": 7200\n\t},\n\t\"inputPortDescriptors\": [{\n\t\t\t\"required\": true,\n\t\t\t\"description\": \"A string input.\",\n\t\t\t\"name\": \"inputstring\",\n\t\t\t\"type\": \"string\"\n\t\t},\n\t\t{\n\t\t\t\"name\": \"dependency_input\",\n\t\t\t\"type\": \"string\"\n\t\t}\n\t],\n\t\"outputPortDescriptors\": [{\n\t\t\"name\": \"dependency_output\",\n\t\t\"type\": \"string\"\n\t}],\n\t\"containerDescriptors\": [{\n\t\t\"type\": \"DOCKER\",\n\t\t\"command\": \"\",\n\t\t\"properties\": {\n\t\t\t\"image\": \"tdgp/test-success\",\n\t\t\t\"mounts\": [{\n\t\t\t\t\"local\": \"$task_data_dir\",\n\t\t\t\t\"container\": \"/mnt/work\",\n\t\t\t\t\"read_only\": false\n\t\t\t}]\n\t\t}\n\t}]\n\n}","language":"json"}]},"method":"post","results":{"codes":[{"name":"","code":" test-success successfully registered.","language":"json","status":200}]},"settings":"","auth":"required","params":[],"url":"/workflows/v1/tasks"},"isReference":false,"order":7,"body":"Version property is required part of the JSON definition[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"The \\\"try it out\\\" feature is not available for this API request.\"\n}\n[/block]\nFor details on how to register a task in the GBDX task registry, see [Workflow API Course](doc:workflow-api-course).\n\nSee [How to Version a Task](doc:how-to-version-a-task) for more information on how to register a new version of a task.","excerpt":"Register a new task or an updated version of an existing task.","slug":"register-a-task-with-the-task-registry","type":"endpoint","title":"Register a task"}

postRegister a task

Register a new task or an updated version of an existing task.

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format


Documentation

Version property is required part of the JSON definition[block:callout] { "type": "info", "title": "The \"try it out\" feature is not available for this API request." } [/block] For details on how to register a task in the GBDX task registry, see [Workflow API Course](doc:workflow-api-course). See [How to Version a Task](doc:how-to-version-a-task) for more information on how to register a new version of a task.