{"_id":"56e08c9b903c7a29001d5352","editedParams2":true,"editedParams":true,"project":"55faeacad0e22017005b8265","user":"55fae9d4825d5f19001fa379","__v":0,"parentDoc":null,"version":{"_id":"55faeacad0e22017005b8268","project":"55faeacad0e22017005b8265","__v":35,"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","5a009de510890d001c2aabfe"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"v1","version_clean":"1.0.0","version":"1"},"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":9,"slug":"tasks-and-workflows-guide","title":"Tasks and Workflows Guide"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-03-09T20:50:35.260Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"settings":"5601fdaa1ba3720d00a6b981","examples":{"codes":[{"code":"https://geobigdata.io/workflows/v1/workflows/4249073422254282656","language":"text"}]},"method":"get","results":{"codes":[{"language":"json","code":"{\n    \"tasks\": [\n        {\n            \"inputs\": [\n                {\n                    \"source\": null,\n                    \"dataflow_channel\": null,\n                    \"type\": \"string\",\n                    \"name\": \"destination\",\n                    \"value\": \"http://test-tdgplatform-com/temp/123\"\n                },\n                {\n                    \"source\": \"AComp:data\",\n                    \"dataflow_channel\": null,\n                    \"type\": \"directory\",\n                    \"name\": \"data\",\n                    \"value\": null\n                }\n            ],\n            \"outputs\": [],\n            \"start_time\": null,\n            \"taskType\": \"StageDataToS3\",\n            \"id\": \"4250661822931558921\",\n            \"name\": \"StagetoS3\",\n            \"note\": null,\n            \"state\": {\n                \"state\": \"pending\",\n                \"event\": \"submitted\"\n            },\n            \"run_parameters\": {\n                \"mounts\": [\n                    {\n                        \"read_only\": false,\n                        \"local\": \"/mnt/glusterfs\",\n                        \"container\": \"/mnt/glusterfs\"\n                    },\n                    {\n                        \"read_only\": false,\n                        \"local\": \"$task_data_dir\",\n                        \"container\": \"/mnt/work\"\n                    }\n                ],\n                \"image\": \"tdgp/stagetos3:latest\",\n                \"command\": \"\",\n                \"devices\": []\n            },\n            \"timeout\": 7200,\n            \"instance_info\": {\n                \"domain\": \"default\"\n            }\n        },\n        {\n            \"inputs\": [\n                {\n                    \"source\": \"FastOrtho:data\",\n                    \"dataflow_channel\": null,\n                    \"type\": \"one-b\",\n                    \"name\": \"data\",\n                    \"value\": null\n                }\n            ],\n            \"outputs\": [\n                {\n                    \"source\": null,\n                    \"dataflow_channel\": null,\n                    \"type\": \"one-b\",\n                    \"name\": \"data\",\n                    \"value\": null\n                }\n            ],\n            \"start_time\": null,\n            \"taskType\": \"AComp\",\n            \"id\": \"4250661822924686584\",\n            \"name\": \"AComp\",\n            \"note\": null,\n            \"state\": {\n                \"state\": \"pending\",\n                \"event\": \"submitted\"\n            },\n            \"run_parameters\": {\n                \"mounts\": [\n                    {\n                        \"read_only\": false,\n                        \"local\": \"/mnt/glusterfs\",\n                        \"container\": \"/mnt/glusterfs\"\n                    },\n                    {\n                        \"read_only\": false,\n                        \"local\": \"$task_data_dir\",\n                        \"container\": \"/mnt/work\"\n                    }\n                ],\n                \"image\": \"tdgp/acomp:latest\",\n                \"command\": \"\",\n                \"devices\": []\n            },\n            \"timeout\": 7200,\n            \"instance_info\": {\n                \"domain\": \"default\"\n            }\n        },\n        {\n            \"inputs\": [\n                {\n                    \"source\": null,\n                    \"dataflow_channel\": null,\n                    \"type\": \"string\",\n                    \"name\": \"demspecifier\",\n                    \"value\": \"SRTM90\"\n                },\n                {\n                    \"source\": null,\n                    \"dataflow_channel\": null,\n                    \"type\": \"one-b\",\n                    \"name\": \"data\",\n                    \"value\": \"http://test-tdgplatform-com/data/QB02/LV1B/053702625010_01_004/053702625010_01/053702625010_01_P013_MUL\"\n                }\n            ],\n            \"outputs\": [\n                {\n                    \"source\": null,\n                    \"dataflow_channel\": null,\n                    \"type\": \"fastortho\",\n                    \"name\": \"data\",\n                    \"value\": null\n                }\n            ],\n            \"start_time\": null,\n            \"taskType\": \"FastOrtho\",\n            \"id\": \"4250661822925088869\",\n            \"name\": \"FastOrtho\",\n            \"note\": null,\n            \"state\": {\n                \"state\": \"pending\",\n                \"event\": \"scheduled\"\n            },\n            \"run_parameters\": {\n                \"mounts\": [\n                    {\n                        \"read_only\": false,\n                        \"local\": \"/mnt/glusterfs\",\n                        \"container\": \"/mnt/glusterfs\"\n                    },\n                    {\n                        \"read_only\": false,\n                        \"local\": \"$task_data_dir\",\n                        \"container\": \"/mnt/work\"\n                    }\n                ],\n                \"image\": \"tdgp/fastortho:latest\",\n                \"command\": \"\",\n                \"devices\": []\n            },\n            \"timeout\": 7200,\n            \"instance_info\": {\n                \"domain\": \"default\"\n            }\n        }\n    ],\n    \"completed_time\": null,\n    \"state\": {\n        \"state\": \"pending\",\n        \"event\": \"scheduled\"\n    },\n    \"submitted_time\": \"2016-01-22T00:06:16.033147+00:00\",\n    \"owner\": \"owner's name\",\n    \"id\": \"4250661822937391977\"\n}","name":"","status":200},{"name":"","status":404,"language":"json","code":"{\n    \"status\": \"404 Not Found\",\n    \"message\": \"Not Found\"\n}"}]},"auth":"required","params":[{"_id":"564378bd0d9748190079df0c","ref":"","in":"path","required":true,"desc":"Workflow identifier","default":"ex 4042551429219561787","type":"string","name":"workflow_id"}],"url":"/workflows/v1/workflows/:workflow_id"},"isReference":false,"order":12,"body":"The \"Get a Worfklow\" API request will return the time submitted, status, and the tasks that were run. You must have a valid workflow ID to try this request. An invalid workflow id will return this error:\n\n{\n    \"status\": \"404 Not Found\",\n    \"message\": \"Not Found\"\n}\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"You need a token to try this request.\",\n  \"body\": \"For more information, see the Authentication Guide.\"\n}\n[/block]","excerpt":"Get a Workflow by Workflow ID, see status.","slug":"get-workflow-status","type":"endpoint","title":"Get Workflow Status"}

getGet Workflow Status

Get a Workflow by Workflow ID, see status.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

workflow_id:
required
stringex 4042551429219561787
Workflow identifier

Examples


Result Format


Documentation

The "Get a Worfklow" API request will return the time submitted, status, and the tasks that were run. You must have a valid workflow ID to try this request. An invalid workflow id will return this error: { "status": "404 Not Found", "message": "Not Found" } [block:callout] { "type": "info", "title": "You need a token to try this request.", "body": "For more information, see the Authentication Guide." } [/block]

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}