{"_id":"59ea38011d044c00389c3f24","project":"55faeacad0e22017005b8265","version":{"_id":"55faeacad0e22017005b8268","project":"55faeacad0e22017005b8265","__v":36,"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","5a96f89c89442e002041144b"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"v1","version_clean":"1.0.0","version":"1"},"category":{"_id":"57e2bd9d1e7b7220000d7fa5","version":"55faeacad0e22017005b8268","__v":0,"project":"55faeacad0e22017005b8265","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-09-21T17:04:29.273Z","from_sync":false,"order":16,"slug":"answerfactory-web-application","title":"AnswerFactory Application"},"user":"56267741db1eda0d001c3dbb","__v":5,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-10-20T17:53:05.759Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"method":"get","examples":{"codes":[{"code":"https://vector.geobigdata.io/answer-factory-recipe-service/api/result?projectId=9523b75c-41e9-4a26-b580-aae6260e988b","language":"json"},{"code":"Request:\nGET /answer-factory-recipe-service/api/result?optional_query_param(s)\n\nParams:\n  accountId: the ID of the account\n  acquisitionId: the ID of the catalog item\n  id: the column ID\n  processingId : the GBDX workflow ID\n  projectId: the ID of the project\n  recipeId: the ID of the recipe\n  rootRecipeId: the ID of the root recipe\n  status: the status of the answer results\n  fields: comma delimited list of fields to return; by default, all fields returned\n\nHeaders:\n  Authorization: Bearer {token}\n  Accept: application/json\n\n\nResponse (success):\n200 OK\n\nBody:\n  [\n    {\n        \"id\": \"column id\",\n        \"projectId\": \"project id\",\n        \"owner\": \"user who submitted project\",\n        \"accountId\": \"account id of user who submitted project\",\n        \"recipeId\": \"identifier for recipe 1\",\n        \"recipeName\": \"name of recipe 1\",\n        \"rootRecipeId\": \"identifier of root recipe 1; can be identical to recipeId\",\n        \"runDate\": /* timestamp in millis from epoch format when result submitted */,\n        \"completeDate\": /* timestamp in millis from epoch format when result completes */,\n        \"processingId\": \"GBDX workflow id 1\",\n        \"status\": \"state of this result; possible values: pending, submitted, running, success, failed\",\n        \"statusDescription\": \"recipe specific explanation of current state\",\n        \"resultType\": \"type of return; possible values: vector-service\",\n        \"displayAs\": \"how this answer can be viewed; possible values: vector\",\n        \"resultDate\": [\n            /* timestamp in millis from epoch format of result; associated with acquisition timestamp */\n        ],\n        \"acquisitionIds\": [\n            \"catalog identifier 1\", \"catalog identifier 2\", ...\n        ],\n        \"idahoImages\": [\n            {\n                \"id\": \"idaho image id\",\n                \"bucket\": \"s3 bucket idaho images are found in\",\n                \"acquisitionId\": \"acquisition id\",\n                \"catalogId\": \"catalog id\",\n                \"productOrderId\": null,\n                \"timestamp\": /* timestamp in millis from epoch format of when catalog image was aquired */,\n                \"cloudCover\": /* double value, percent of catalog image hidden by clouds /*,\n                \"sensorName\": null,\n                \"bounds\": null\n            }\n        ],\n        \"geom\": {\n            \"type\": \"Polygon\",\n            \"coordinates\": [\n                    ...\n            ]\n        },\n        \"properties\": {\n            \"query_index\": \"index(es) results are found under\",\n            \"query_string\": \"query to return the results\"\n        },\n        \"tableResults\": [\n            {\n                \"rowId\": \"row name 1\",\n                \"columnId\": \"identifier of column 1\",\n                \"values\": [\n                    {\n                        \"field\": \"the item_type of the result\",\n                        \"values\": {\n                            \"area\": /* float value, SqKm of aoi /*,\n                            \"imagePercentage\": /* float value, percent of aoi covered by selected images /*,\n                            \"areaPercentage\": /* float value, percent of aoi covered by result vectors /*,\n                            \"count\": /* integer value, number of results returned /*,\n                            \"length\": /* double value, results that include linestring vectors, the total length of the linestrings /*\n                        }\n                    },\n                    {\n                        \"field\": ...,\n                    },\n                    ...\n                    {\n                        \"field\": ...,\n                    }\n                ]\n            }\n        ]\n    },\n    ...\n]","language":"text"}]},"results":{"codes":[{"status":200,"language":"json","code":"[\n    {\n        \"id\": \"0c7b5104-b4a6-4860-a293-81ff0a7d4eca\",\n        \"projectId\": \"9523b75c-41e9-4a26-b580-aae6260e988b\",\n        \"owner\": \"an...\",\n        \"accountId\": \"c8f...\",\n        \"recipeId\": \"query-lulc-protogen\",\n        \"recipeName\": \"Query LULC (Protogen)\",\n        \"rootRecipeId\": \"query-lulc-protogen\",\n        \"runDate\": 1508244213032,\n        \"completeDate\": 1508244213032,\n        \"processingId\": null,\n        \"status\": \"success\",\n        \"statusDescription\": null,\n        \"resultType\": \"vector-service\",\n        \"displayAs\": \"vector\",\n        \"resultDate\": [\n            1502014526134\n        ],\n        \"acquisitionIds\": [\n            \"103001006E26CD00\"\n        ],\n        \"idahoImages\": [\n            {\n                \"id\": \"81fc7bba-58a9-4bb8-9ecc-21597d80f959\",\n                \"bucket\": \"idaho-images\",\n                \"acquisitionId\": \"103001006E26CD00\",\n                \"catalogId\": \"103001006E26CD00\",\n                \"productOrderId\": null,\n                \"timestamp\": 1502014526134,\n                \"cloudCover\": null,\n                \"sensorName\": null,\n                \"bounds\": null\n            }\n        ],\n        \"geom\": {\n            \"type\": \"Polygon\",\n            \"coordinates\": [\n                [\n                    [\n                        12.208471,\n                        41.745829\n                    ],\n                    [\n                        12.208471,\n                        41.817385\n                    ],\n                    [\n                        12.290354,\n                        41.817385\n                    ],\n                    [\n                        12.290354,\n                        41.745829\n                    ],\n                    [\n                        12.208471,\n                        41.745829\n                    ]\n                ]\n            ]\n        },\n        \"properties\": {\n            \"query_index\": \"vector-workflow*,vector-protogen-lulc*\",\n            \"query_string\": \"(ingest_source:\\\\\\\"Protogen\\\\\\\") AND item_date:[2016-12-01T13:40:32.293Z TO 2017-10-17T12:41:32.293Z] AND ( attributes.cat_id_raw:103001006E26CD00 OR attributes.acquisition_id_raw:103001006E26CD00 OR attributes.acquisition_id_0_raw:103001006E26CD00 )\"\n        },\n        \"tableResults\": [\n            {\n                \"rowId\": \"AOI001\",\n                \"columnId\": \"0c7b5104-b4a6-4860-a293-81ff0a7d4eca\",\n                \"values\": [\n                    {\n                        \"field\": \"Soil\",\n                        \"values\": {\n                            \"area\": 0.43441868885728674,\n                            \"imagePercentage\": 1,\n                            \"areaPercentage\": 0.01361282666251095,\n                            \"count\": 195,\n                            \"length\": 0\n                        }\n                    },\n                    {\n                        \"field\": \"Water\",\n                        \"values\": {\n                            \"area\": 0.19642033168391648,\n                            \"imagePercentage\": 1,\n                            \"areaPercentage\": 0.006154974444675558,\n                            \"count\": 24,\n                            \"length\": 0\n                        }\n                    },\n                    {\n                        \"field\": \"BuiltUpArea\",\n                        \"values\": {\n                            \"area\": 3.6163624328466555,\n                            \"imagePercentage\": 1,\n                            \"areaPercentage\": 0.11332135612455287,\n                            \"count\": 18,\n                            \"length\": 0\n                        }\n                    },\n                    {\n                        \"field\": \"Vegetation\",\n                        \"values\": {\n                            \"area\": 0.0009595263034935165,\n                            \"imagePercentage\": 1,\n                            \"areaPercentage\": 0.000030067457000838514,\n                            \"count\": 2,\n                            \"length\": 0\n                        }\n                    },\n                    {\n                        \"field\": \"Total\",\n                        \"values\": {\n                            \"area\": 4.2481609796913515,\n                            \"imagePercentage\": 1,\n                            \"areaPercentage\": 0.1331192246887402,\n                            \"count\": 239,\n                            \"length\": 0\n                        }\n                    }\n                ]\n            }\n        ]\n    },\n    ...\n]","name":""}]},"settings":"56e2c4e50522b90e00d9a7b1","auth":"required","params":[{"_id":"59ea38011d044c00389c3f2c","ref":"","in":"query","required":false,"desc":"The account identifier.","default":"","type":"string","name":"accountId"},{"_id":"59ea38011d044c00389c3f2b","ref":"","in":"query","required":false,"desc":"The catalog ID.","default":"","type":"string","name":"acquisitionId"},{"_id":"59ea38011d044c00389c3f2a","ref":"","in":"query","required":false,"desc":"The column ID.","default":"","type":"string","name":"id"},{"_id":"59ea38011d044c00389c3f29","ref":"","in":"query","required":false,"desc":"The GBDX workflow ID.","default":"","type":"string","name":"processingId"},{"_id":"595cc5513d48460033328546","ref":"","in":"query","required":false,"desc":"The ID of the project.","default":"","type":"string","name":"projectId"},{"_id":"59ea38011d044c00389c3f28","ref":"","in":"query","required":false,"desc":"The ID of the recipe. For instance, extract-aircraft.","default":"","type":"string","name":"recipeId"},{"_id":"59ea38011d044c00389c3f27","ref":"","in":"query","required":false,"desc":"The ID of the root recipe. For instance, if recipeId is extract-aircraft-change, rootRecipeId would be extract-aircraft. If recipeId is extract-aircraft, the rootRecipeId would also be extract-aircraft.","default":"","type":"string","name":"rootRecipeId"},{"_id":"59ea38011d044c00389c3f26","ref":"","in":"query","required":false,"desc":"The status of the result; possible values: pending, submitted, running, success, failed.","default":"","type":"string","name":"status"},{"_id":"59ea38011d044c00389c3f25","ref":"","in":"query","required":false,"desc":"A comma delimited list of fields to return. By default, all fields are returned, but user may specify only certain fields.","default":"","type":"string","name":"fields"}],"url":"/answer-factory-recipe-service/api/result?"},"isReference":false,"order":37,"body":"**Without optional query parameters included, this endpoint queries and returns all results associated with the user's account. All query parameters can be used, separately or in combination, to filter the returns of this endpoint.**","excerpt":"","slug":"retrieve-results","type":"endpoint","title":"Retrieve Results"}

getRetrieve Results


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

accountId:
string
The account identifier.
acquisitionId:
string
The catalog ID.
id:
string
The column ID.
processingId:
string
The GBDX workflow ID.
projectId:
string
The ID of the project.
recipeId:
string
The ID of the recipe. For instance, extract-aircraft.
rootRecipeId:
string
The ID of the root recipe. For instance, if recipeId is extract-aircraft-change, rootRecipeId would be extract-aircraft. If recipeId is extract-aircraft, the rootRecipeId would also be extract-aircraft.
status:
string
The status of the result; possible values: pending, submitted, running, success, failed.
fields:
string
A comma delimited list of fields to return. By default, all fields are returned, but user may specify only certain fields.

Examples


Result Format


Documentation

**Without optional query parameters included, this endpoint queries and returns all results associated with the user's account. All query parameters can be used, separately or in combination, to filter the returns of this endpoint.**

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