{"_id":"5601a6cd6811d00d00ceb470","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":7,"slug":"tasks-and-workflows-guide","title":"Tasks and Workflows Guide"},"editedParams":true,"project":"55faeacad0e22017005b8265","version":{"_id":"55faeacad0e22017005b8268","project":"55faeacad0e22017005b8265","__v":32,"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"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"v1","version_clean":"1.0.0","version":"1"},"editedParams2":true,"parentDoc":null,"user":"55fae9d4825d5f19001fa379","__v":0,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-09-22T19:06:53.674Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"code":"https://geobigdata.io/workflows/v1/tasks/AOP_Strip_Processor","language":"text"}]},"method":"get","results":{"codes":[{"language":"json","code":"{\n  \"containerDescriptors\": [\n    {\n      \"command\": \"/bin/bash /dg/aws/apps/AOP-Processing/aws/gbdx/aop_strip_processor_task/aop_strip_processor_task_runner.sh\",\n      \"type\": \"DOCKER\",\n      \"properties\": {\n        \"image\": \"tdgp/aop:latest\",\n        \"domain\": \"raid\"\n      }\n    }\n  ],\n  \"description\": \"Processes a 1B strip using the AOP processing stack.\",\n  \"inputPortDescriptors\": [\n    {\n      \"required\": true,\n      \"type\": \"directory\",\n      \"description\": \"S3 location of 1B input data\",\n      \"name\": \"data\"\n    },\n    {\n      \"required\": false,\n      \"type\": \"directory\",\n      \"description\": \"S3 location of Bundle Block Adjustment results\",\n      \"name\": \"bba\"\n    },\n    {\n      \"required\": false,\n      \"type\": \"string\",\n      \"description\": \"Enable/disable AComp. Choices are 'true' or 'false'. Default is 'true'.\",\n      \"name\": \"enable_acomp\"\n    },\n    {\n      \"required\": false,\n      \"type\": \"string\",\n      \"description\": \"Enable/disable pan sharpening. Choices are 'true' or 'false'. Default is 'true'.\",\n      \"name\": \"enable_pansharpen\"\n    },\n    {\n      \"required\": false,\n      \"type\": \"string\",\n      \"description\": \"Enable/disable dynamic range adjustment. Choices are 'true' or 'false'. Default is 'true'.\",\n      \"name\": \"enable_dra\"\n    },\n    {\n      \"required\": false,\n      \"type\": \"string\",\n      \"description\": \"Enable/disable output tiling. Choices are 'true' or 'false'. Default is 'false'. If 'true', the 'ortho_tiling_scheme' input must be set.\",\n      \"name\": \"enable_tiling\"\n    },\n    {\n      \"required\": false,\n      \"type\": \"string\",\n      \"description\": \"Bands to process. Choices are 'PAN+MS', 'PAN', 'MS', 'Auto'. Default is 'Auto', which searches for band IDs in IMD files.\",\n      \"name\": \"bands\"\n    },\n    {\n      \"required\": false,\n      \"type\": \"string\",\n      \"description\": \"Comma-separated list of numeric strip parts to process. Default is to process all strip parts.\",\n      \"name\": \"parts\"\n    },\n    {\n      \"required\": false,\n      \"type\": \"string\",\n      \"description\": \"Ortho EPSG projection. String 'UTM' is also allowed. Specify along with ortho_pixel_size. Overridden by ortho_tiling_scheme if specified. Default is 'EPSG:4326'.\",\n      \"name\": \"ortho_epsg\"\n    },\n    {\n      \"required\": false,\n      \"type\": \"string\",\n      \"description\": \"Ortho pixel size in meters. Specify along with ortho_epsg. Overridden by ortho_tiling_scheme if specified. Default is 'Auto', which uses the pixel size of the input data.\",\n      \"name\": \"ortho_pixel_size\"\n    },\n    {\n      \"required\": false,\n      \"type\": \"string\",\n      \"description\": \"Ortho tiling scheme and zoom level, e.g. 'DGHalfMeter:18'. Overrides ortho_epsg and ortho_pixel_size.\",\n      \"name\": \"ortho_tiling_scheme\"\n    },\n    {\n      \"required\": false,\n      \"type\": \"string\",\n      \"description\": \"Ortho DEM specifier. Options are 'NED', 'SRTM30', 'SRTM90'. Default is 'SRTM90'.\",\n      \"name\": \"ortho_dem_specifier\"\n    },\n    {\n      \"required\": false,\n      \"type\": \"string\",\n      \"description\": \"Ortho pixel interpolation type. Options are 'Nearest', 'Bilinear', 'Cubic'. Default is 'Cubic'.\",\n      \"name\": \"ortho_interpolation_type\"\n    },\n    {\n      \"required\": false,\n      \"type\": \"string\",\n      \"description\": \"Dynamic range adjustment mode. Options are 'IntensityAdjust', 'BaseLayerMatch'. Default is 'IntensityAdjust'. 'BaseLayerMatch' is currently only compatible with EPSG:4326.\",\n      \"name\": \"dra_mode\"\n    },\n    {\n      \"required\": false,\n      \"type\": \"string\",\n      \"description\": \"Dynamic range adjustment low cutoff percentage. Range is from 0 to 100. Default is 0.5. Only used for 'IntensityAdjust' mode.\",\n      \"name\": \"dra_low_cutoff\"\n    },\n    {\n      \"required\": false,\n      \"type\": \"string\",\n      \"description\": \"Dynamic range adjustment high cutoff percentage. Range is from 0 to 100. Default is 99.95. Only used for 'IntensityAdjust' mode.\",\n      \"name\": \"dra_high_cutoff\"\n    },\n    {\n      \"required\": false,\n      \"type\": \"string\",\n      \"description\": \"Dynamic range adjustment gamma value. Default is 1.25. Only used for 'IntensityAdjust' mode.\",\n      \"name\": \"dra_gamma\"\n    },\n    {\n      \"required\": false,\n      \"type\": \"string\",\n      \"description\": \"Dynamic range adjustment output bit depth. Choices are 8 or 16. Default is 8. Only used for 'IntensityAdjust' mode.\",\n      \"name\": \"dra_bit_depth\"\n    },\n    {\n      \"required\": false,\n      \"type\": \"string\",\n      \"description\": \"S3 prefix of base layer for DRA BaseLayerMatch mode. Default is s3://dg-baselayer/v2/. Base layer should be tiled to DG tiling scheme level 9.\",\n      \"name\": \"dra_baselayer_prefix\"\n    },\n    {\n      \"required\": false,\n      \"type\": \"string\",\n      \"description\": \"Zoom level (i.e. size) of output tiles if tiling is enabled. Default is 12.\",\n      \"name\": \"tiling_zoom_level\"\n    }\n  ],\n  \"outputPortDescriptors\": [\n    {\n      \"required\": true,\n      \"type\": \"directory\",\n      \"description\": \"The output data directory\",\n      \"name\": \"data\"\n    },\n    {\n      \"required\": true,\n      \"type\": \"directory\",\n      \"description\": \"The output log directory\",\n      \"name\": \"log\"\n    }\n  ],\n  \"properties\": {\n    \"isPublic\": true,\n    \"timeout\": 36000\n  },\n  \"name\": \"AOP_Strip_Processor\"\n}","name":"","status":200}]},"settings":"5601fdaa1ba3720d00a6b981","auth":"required","params":[{"_id":"5601a6cd6811d00d00ceb471","ref":"","in":"path","required":false,"desc":"String Identifier of the task. For example, AOP_Strip_Processor","default":"AOP_Strip_Processor","type":"string","name":"task_id"}],"url":"/workflows/v1/tasks/:task_id"},"isReference":false,"order":8,"body":"[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"You need a token to try this request\",\n  \"body\": \"For information on how to get a token, see the Authentication Guide.\"\n}\n[/block]\nTask_id is the name, or string identifier, of the task. In this example, the task_ID \"AOP_Strip_Processor\" was used. Use [List Tasks](doc:list-tasks-in-thetask-registry) to see a complete list of available tasks.\n\nPlease see the [Task and Workflow Course](doc:task-and-workflow-course) for a complete explanation of the task definition.","excerpt":"Get a Task Definition from the Task Registry","slug":"get-a-task-definition-from-the-task-registry","type":"endpoint","title":"Get Task Definition"}

getGet Task Definition

Get a Task Definition from the Task Registry

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

task_id:
stringAOP_Strip_Processor
String Identifier of the task. For example, AOP_Strip_Processor

Examples


Result Format


Documentation

[block:callout] { "type": "warning", "title": "You need a token to try this request", "body": "For information on how to get a token, see the Authentication Guide." } [/block] Task_id is the name, or string identifier, of the task. In this example, the task_ID "AOP_Strip_Processor" was used. Use [List Tasks](doc:list-tasks-in-thetask-registry) to see a complete list of available tasks. Please see the [Task and Workflow Course](doc:task-and-workflow-course) for a complete explanation of the task definition.

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 }}