{"_id":"59e8a5e3319e18002eba4599","project":"55faeacad0e22017005b8265","version":{"_id":"55faeacad0e22017005b8268","project":"55faeacad0e22017005b8265","__v":37,"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","5b3f9b7267cbc90003d283a5"],"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":2,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-10-19T13:17:23.881Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"settings":"56e2c4e50522b90e00d9a7b1","results":{"codes":[{"name":"","code":"[\n    {\n        \"recipeId\": \"extract-protogen-lulc-change\",\n        \"recipeName\": \"Extract Protogen LULC Change\",\n        \"status\": \"success\",\n        \"successCount\": 1,\n        \"failedCount\": 0,\n        \"totalCount\": 1,\n        \"displayAs\": \"vector\",\n        \"resultStatuses\": [\n            {\n                \"resultId\": \"4f3939ba-5e64-4b12-b8e1-1a26e22c9bde\",\n                \"runDate\": 1507054966761,\n                \"processingId\": \"4700574668138406431\",\n                \"status\": \"success\",\n                \"statusDescription\": \"Workflow complete.\",\n                \"progressValue\": 3,\n                \"progressMax\": 3\n            }\n        ],\n        \"prereqAnswerStatuses\": [\n            {\n                \"recipeId\": \"extract-protogen-lulc\",\n                \"recipeName\": \"Extract Land Use Land Cover Protogen\",\n                \"status\": \"success\",\n                \"successCount\": 2,\n                \"failedCount\": 0,\n                \"totalCount\": 2,\n                \"displayAs\": \"vector\",\n                \"resultStatuses\": [\n                    {\n                        \"resultId\": \"2e28b9ca-68ec-4669-bee1-5ae358e3a780\",\n                        \"runDate\": 1507051459958,\n                        \"processingId\": \"4700545249742918459\",\n                        \"status\": \"success\",\n                        \"statusDescription\": \"Workflow complete.\",\n                        \"progressValue\": 9,\n                        \"progressMax\": 9\n                    },\n                    {\n                        \"resultId\": \"0c600871-15e6-4031-bbe9-5266363c3e34\",\n                        \"runDate\": 1507051458977,\n                        \"processingId\": \"4700545242188353270\",\n                        \"status\": \"success\",\n                        \"statusDescription\": \"Workflow complete.\",\n                        \"progressValue\": 9,\n                        \"progressMax\": 9\n                    }\n                ],\n                \"prereqAnswerStatuses\": null\n            }\n        ]\n    },\n    ...\n]","language":"json","status":200}]},"examples":{"codes":[{"code":"https://vector.geobigdata.io/answer-factory-recipe-service/api/recipe/status/v2/ec9a9f8e-23ae-435e-b7e3-1aa7767e9fdc","language":"json"},{"code":"Request:\nGET /answer-factory-recipe-service/api/recipe/status/v2/:projectId\n\nParams:\n  projectId: the ID of the project\n\nHeaders:\n  Authorization: Bearer {token}\n  Accept: application/json\n\n\nResponse (success):\n200 OK\n\nBody:\n  [\n    {\n      \"recipeId\": \"id of recipe 1\",\n      \"recipeName\": \"name of recipe 1\",\n      \"status\": \"state of entire answer; possible values: pending, submitted, running, success, failed\",\n      \"successCount\": \"integer number of recipe run over selected acquisitions successfully completed\",\n      \"failedCount\": \"integer number of recipe run over selected acquisitions that failed to complete successfully\",\n      \"totalCount\": \"integer number of selected acquisitions for recipe to run against\",\n      \"displayAs\": \"how this answer can be viewed; possible values: vector\",\n      \"resultStatuses\": [\n        {\n          \"resultId\": \"identifier of result 1\",\n          \"runDate\": /* timestamp in millis from epoch format when result when submitted */,\n          \"processingId\": \"GBDX workflow id\",\n          \"status\": \"state of this result; possible values: pending, submitted, running, success, failed\",\n          \"statusDescription\": \"recipe specific explanation of current state\",\n          \"progressValue\": /* optional integer of current progress */,\n          \"progressMax\": /* optional integer of maximum progress */\n        },\n        {\n          \"...\"\n        }\n      ],\n      \"prereqAnswerStatuses\": [\n        {\n          \"recipeId\": \"id of prerequisite recipe 1\",\n          \"recipeName\": \"name of prerequisite recipe 1\",\n          \"status\": \"tate of this prerequisite answer; possible values: pending, submitted, running, success, failed\",\n          \"successCount\": \"integer number of recipe run over selected acquisitions successfully completed\",\n          \"failedCount\": \"integer number of recipe run over selected acquisitions that failed to complete successfully\",\n          \"displayAs\": \"how this prerequisite answer can be viewed; possible values: vector\",\n          \"resultStatuses\": [\n            {\n              \"resultId\": \"identifier of prerequisite result 1\",\n              \"runDate\": /* timestamp in millis from epoch format when result when submitted */,\n              \"processingId\": \"GBDX workflow id\",\n              \"status\": \"state of this prerequisite result; possible values: pending, submitted, running, success, failed\",\n              \"statusDescription\": \"recipe specific explanation of current state\",\n              \"progressValue\": /* optional integer of current progress */,\n              \"progressMax\": /* optional integer of maximum progress */\n            },\n            {\n              ...\n            }\n          ],\n          \"prereqAnswerStatuses\": ...\n        },\n        {\n          ...\n        }\n      ]\n    },\n    {\n      ...\n    }\n  ]","language":"text"}]},"method":"get","auth":"required","params":[{"_id":"595cc5513d48460033328546","ref":"","in":"path","required":true,"desc":"The ID of the project.","default":"","type":"string","name":"projectId"}],"url":"/answer-factory-recipe-service/api/recipe/status/v2/:projectId"},"isReference":false,"order":34,"body":"Answer Status v2 includes useful additional information, such as the successCount, failedCount, and totalCount, to better track recipe and project progression.","excerpt":"","slug":"retrieve-answer-status-v2","type":"endpoint","title":"Retrieve Answer Status v2"}

getRetrieve Answer Status v2


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

projectId:
required
string
The ID of the project.

Examples


Result Format


Documentation

Answer Status v2 includes useful additional information, such as the successCount, failedCount, and totalCount, to better track recipe and project progression.

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