{"_id":"567c46a37c40060d005604c1","user":"5511dee39171e82b00897349","editedParams2":true,"parentDoc":null,"version":{"_id":"5661fdca55e4450d00e62c73","project":"5511df3be2990b0d00fb071d","__v":2,"createdAt":"2015-12-04T20:55:38.639Z","releaseDate":"2015-12-04T20:55:38.639Z","categories":["5661fdcb55e4450d00e62c74","5661fdcb55e4450d00e62c75","5661fdcb55e4450d00e62c76","5661fdcb55e4450d00e62c77","5661fdcb55e4450d00e62c78","5661fdcb55e4450d00e62c79","567c42b13241c20d00b7312e"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"2.0.0","version":"2.0"},"editedParams":true,"project":"5511df3be2990b0d00fb071d","__v":4,"category":{"_id":"5661fdcb55e4450d00e62c79","version":"5661fdca55e4450d00e62c73","__v":8,"pages":["5661fdcc55e4450d00e62c80","5661fdcc55e4450d00e62c81","5661fdcc55e4450d00e62c82","5661fdcc55e4450d00e62c83","5661fdcc55e4450d00e62c84","5661fdcc55e4450d00e62c85","5661fdcc55e4450d00e62c86","5661fdcc55e4450d00e62c87","5661fdcc55e4450d00e62c88","567c46a37c40060d005604c1","567c479a8eb5b20d00210557","567c4829815f250d0094adbb","567c48a3815f250d0094adbd","567c496b7c40060d005604c5","567c4af88eb5b20d00210559","567c4cb9abbcf90d00ca50c2"],"project":"5511df3be2990b0d00fb071d","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-08-27T12:30:20.218Z","from_sync":false,"order":1,"slug":"alerts-notifications","title":"Tasks & Results"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-12-24T19:25:23.050Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"language":"text","code":"curl https://api.astrodigital.com/v2.0/tasks -H 'Authorization: Token YOUR_AUTH_TOKEN'"}]},"method":"get","results":{"codes":[{"name":"","status":200,"language":"json","code":"{\n    \"count\":1,\n    \"next\":null,\n    \"previous\":null,\n    \"results\":[\n        {\n            \"id\":1,\n            \"name\":\"My Alert\",\n            \"created_at\":\"2016-01-27T15:24:03.126309Z\",\n            \"updated_at\":\"2016-01-27T15:24:03.126335Z\",\n            \"query\":{\n              \t\"cloud_from\":0,\n              \t\"cloud_to\":20,\n                \"date_to\":\"2015-02-02\",\n                \"aoi\":{\n                    \"coordinates\":[\n                      [\n                        [10.571722984313965,51.38249533118676],\n                        [10.571722984313965,51.39307388836406],\n                        [10.588459968566895,51.39307388836406],\n                        [10.588459968566895,51.38249533118676],\n                        [10.571722984313965,51.38249533118676]\n                      ]\n                    ],\n                    \"type\":\"Polygon\"\n                },\n                \"date_from\":\"2015-01-01\"\n            },\n            \"recurring\":false,\n            \"end_date\":null,\n            \"status\":\"ACTIVE\",\n            \"status_time\":\"2016-01-27T15:24:03.126087Z\",\n            \"expected_results\":20,\n            \"aoi\":1,\n            \"products\":[\n                {\n                    \"product\":\"true_color\",\n                    \"actions\":[\"mapbox\",\"raw\",\"processed\"]\n                }\n            ]\n        }\n    ]\n}"}]},"settings":"56a8d993c0e02f0d007fa916","auth":"required","params":[{"_id":"567c46a37c40060d005604c4","ref":"","in":"query","required":false,"desc":"Filter by status of the Task. `ACTIVE`, `IN PROGRESS`,`COMPLETED`","default":"","type":"string","name":"status"},{"_id":"567c46a37c40060d005604c3","ref":"","in":"query","required":false,"desc":"Filter by the earliest data of the observed archive","default":"","type":"datetime","name":"date_from"},{"_id":"567c46a37c40060d005604c2","ref":"","in":"query","required":false,"desc":"Filter by the latest data of the observed archive","default":"","type":"datetime","name":"date_to"},{"_id":"56a8dea63c7e030d007971c1","ref":"","in":"query","required":false,"desc":"Filter by whether Task is recurring or not.","default":"","type":"boolean","name":"recurring"},{"_id":"56a8dea63c7e030d007971c0","ref":"","in":"query","required":false,"desc":"Filter by the name of the task.","default":"","type":"string","name":"name"},{"_id":"56a8dea63c7e030d007971bf","ref":"","in":"query","required":false,"desc":"Filter by the ID of the associated AOI.","default":"","type":"int","name":"aoi_id"},{"_id":"56a8dea63c7e030d007971be","ref":"","in":"query","required":false,"desc":"Filter by valid product type (e.g. `true_color`, `ndvi_image`)","default":"","type":"string","name":"product"},{"_id":"574649d47af791170073ca7c","ref":"","in":"query","required":false,"desc":"Number of items in the API response. Limit is 10,000 items per page","default":"100","type":"int","name":"page_size"},{"_id":"580823ef73557d0f00a1e42b","ref":"","in":"query","required":false,"desc":"Minimal date of the updated task","default":"","type":"yyyy-mm-dd","name":"updated_from"},{"_id":"580823ef73557d0f00a1e42a","ref":"","in":"query","required":false,"desc":"Maximal date of the updated taks","default":"","type":"yyyy-mm-dd","name":"updated_to"}],"url":"/tasks"},"isReference":false,"order":1,"body":"Provides a listing of all [Tasks](doc:overview), filtered by available query parameters. The result will return the complete state of the Task, including it's current status, what [Products](doc:products) it is producing, and the full query used to create the Task. \n\nDetails about the returned information is available in the table below.\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"id\",\n    \"1-0\": \"name\",\n    \"2-0\": \"created_at\",\n    \"3-0\": \"updated_at\",\n    \"4-0\": \"query\",\n    \"5-0\": \"recurring\",\n    \"6-0\": \"end_date\",\n    \"7-0\": \"status\",\n    \"8-0\": \"status_time\",\n    \"9-0\": \"expected_results\",\n    \"10-0\": \"aoi\",\n    \"11-0\": \"products\",\n    \"0-1\": \"Unique platform identifier for the Task.\",\n    \"1-1\": \"User provided name for the Task.\",\n    \"2-1\": \"Date the Task was created at.\",\n    \"3-1\": \"Date the Task was last updated at.\",\n    \"5-1\": \"Is this a recurring Task?\",\n    \"6-1\": \"End date of the Task.\",\n    \"7-1\": \"The status of the Task. `ACTIVE` or `COMPLETED`\",\n    \"8-1\": \"The time the status was last set.\",\n    \"9-1\": \"A rough number of expected results for the Task.\",\n    \"10-1\": \"A unique platform ID for the AOI the Task has set.\",\n    \"11-1\": \"The Products and actions the Task will perform on matching imagery.\",\n    \"4-1\": \"A valid JSON object, for more information, read about [queries](doc:tasks-1).\",\n    \"12-0\": \"cloud_from\",\n    \"12-1\": \"Minimal percentage of cloudy pixels\",\n    \"13-1\": \"Maximal percentage of cloudy pixels\",\n    \"13-0\": \"cloud_to\"\n  },\n  \"cols\": 2,\n  \"rows\": 14\n}\n[/block]","excerpt":"","slug":"tasks","type":"endpoint","title":"/tasks"}

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

status:
string
Filter by status of the Task. `ACTIVE`, `IN PROGRESS`,`COMPLETED`
date_from:
datetime
Filter by the earliest data of the observed archive
date_to:
datetime
Filter by the latest data of the observed archive
recurring:
boolean
Filter by whether Task is recurring or not.
name:
string
Filter by the name of the task.
aoi_id:
integer
Filter by the ID of the associated AOI.
product:
string
Filter by valid product type (e.g. `true_color`, `ndvi_image`)
page_size:
integer100
Number of items in the API response. Limit is 10,000 items per page
updated_from:
yyyy-mm-dd
Minimal date of the updated task
updated_to:
yyyy-mm-dd
Maximal date of the updated taks

Examples


Result Format


Documentation

Provides a listing of all [Tasks](doc:overview), filtered by available query parameters. The result will return the complete state of the Task, including it's current status, what [Products](doc:products) it is producing, and the full query used to create the Task. Details about the returned information is available in the table below. [block:parameters] { "data": { "0-0": "id", "1-0": "name", "2-0": "created_at", "3-0": "updated_at", "4-0": "query", "5-0": "recurring", "6-0": "end_date", "7-0": "status", "8-0": "status_time", "9-0": "expected_results", "10-0": "aoi", "11-0": "products", "0-1": "Unique platform identifier for the Task.", "1-1": "User provided name for the Task.", "2-1": "Date the Task was created at.", "3-1": "Date the Task was last updated at.", "5-1": "Is this a recurring Task?", "6-1": "End date of the Task.", "7-1": "The status of the Task. `ACTIVE` or `COMPLETED`", "8-1": "The time the status was last set.", "9-1": "A rough number of expected results for the Task.", "10-1": "A unique platform ID for the AOI the Task has set.", "11-1": "The Products and actions the Task will perform on matching imagery.", "4-1": "A valid JSON object, for more information, read about [queries](doc:tasks-1).", "12-0": "cloud_from", "12-1": "Minimal percentage of cloudy pixels", "13-1": "Maximal percentage of cloudy pixels", "13-0": "cloud_to" }, "cols": 2, "rows": 14 } [/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 }}