{"_id":"5851644bedfad12300710b60","user":"56267741db1eda0d001c3dbb","version":{"_id":"55faeacad0e22017005b8268","project":"55faeacad0e22017005b8265","__v":33,"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"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"v1","version_clean":"1.0.0","version":"1"},"__v":0,"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":14,"slug":"answerfactory-web-application","title":"AnswerFactory Application"},"parentDoc":null,"project":"55faeacad0e22017005b8265","updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-12-14T15:24:59.794Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":8,"body":"| Table of Contents |\n| --- |\n| [AnswerFactory Project JSON](#section-project-json) |\n| [AnswerFactory Project API Parameters](#section-api-parameters) |\n| [Associated API Calls for AnswerFactory Projects](#section-associated-api-calls-for-answerfactory-projects) |\n\n#Project JSON#\n\nAn AnswerFactory project consists of four main parts:\n\n* project metadata\n* a set of configurations for building \"answers\" for the project\n* a set of geometries defining the original base geometries for a project\n* a set of geometries defining a buffered area of interest (AOI) around those geometries\n\n##Error responses##\n\nFor all requests, if an error occurs, the response body will consist of JSON formatted like this:\n```json\n{ \"error\" : \"message\" }\n```\nThe HTTP response code will depend on the error.\n\n#API Parameters#\n| Parameter | Data Type | Parameter Type | Description | Required? |\n| --- | --- | --- | --- | --- |\n| accountId | String | Body | Identifier for account the owner of project belongs to; defaults to GBDX account the user making project creation request belongs to. | Optional |\n| acquisitionIds | String | Body | String of comma or whitespace delimited catalog IDs/acquisition IDs of images to run recipes on. | Optional |\n| aois | String | Body | Array of GeoJSON geometry with buffer applied. | Required |\n| continuouslyOrdered | Boolean | Body | Determines whether the project watches for new images that intersect the project aoi. If true the project's recipes will be run on every new valid image that intersects the project aoi. | Required |\n| createDate | ISO-8601 Formatted Date/Time String | Body | Timestamp when project was created in yyyy-MM-ddTHH:mm:ss.SSSZ format. | Required |\n| dateRange | String | Body | Contains sub-parts `startDate` and `endDate`, providing the date range to restrict images/vectors to. Note: acquisitionIds trumps dateRange when project is being processed. See [Date Range Sub-Part Parameters](#section-date-range-sub-part-parameters) for sub-part definitions. | Optional |\n| description | String | Body | User specified string; project description. | Optional |\n| enabled | Boolean | Body | Determines whether the project is visible to anyone; if false this project will be hidden. | Required |\n| id  | String | Body | Project's unique identifier; must not be specified when creating an object. | Required |\n| name | String | Body | User-specified project identifier. This is the human-readable project identifier; must be unique per account. | Required |\n| namedBuffers | String | Body | Contains sub-parts `name` and `buffer`, providing individual aoi specifics for the project. See [Named Buffers Sub-Part Parameters](#section-named-buffers-sub-part-parameters) for sub-part definitions. | Required |\n| notes | String | Body | User specified string; general notes for the project. | Optional |\n| originalGeometries | String | Body | Array of GeoJSON objects from the source; source may be shapefile or other. | Required |\n| owner | String | Body | Username of user who owns project; defaults to GBDX username of user making project creation request. | Optional |\n| recipeConfigs | String | Body | Contains sub-parts `recipeId`, `recipeName`, `configurationDate`, `startDate`, `endDate`, and `parameters`, providing project-specfic recipe information. See [Recipe Configs Sub-Part Parameters](#section-recipe-configs-sub-part-parameters) for sub-part definitions. | Required |\n| tags | String | Body | User specified string or array of strings providing tags to associate with the project for easier lookup of similar projects. Multiple projects can have the same tag or tags. Example: ```\"tags\": [ \"tag1\", \"tag-2\" ]``` | Optional |\n| updateDate | ISO-8601 Formatted Date/Time String | Body | Timestamp when project was last modified in yyyy-MM-ddTHH:mm:ss.SSSZ format. | Required |\n| visibility | String | Body | Determines whether the project is made public to GBDX users or kept private; set to `public` to allow users outside the owner's account to view the project; otherwise leave as an empty array. | Optional |\n\n\n##Date Range Sub-Part Parameters##\n| Parameter | Data Type | Parameter Type | Description | Required? |\n| --- | --- | --- | --- | --- |\n| endDate | ISO-8601 Formatted Date/Time String | Body | Sub-part of `dateRange`; latest timestamp in yyyy-MM-ddTHH:mm:ss.SSSZ format of input images/vectors to use when running all recipes. | Optional |\n| startDate | ISO-8601 Formatted Date/Time String | Body | Sub-part of `dateRange`; earliest timestamp in yyyy-MM-ddTHH:mm:ss.SSSZ format of input images/vectors to use when running all recipes. | Optional |\n\n##Named Buffers Sub-Part Parameters##\n| Parameter | Data Type | Parameter Type | Description | Required? |\n| --- | --- | --- | --- | --- |\n| buffer | String | Body | Sub-part of `namedBuffers`; GeoJSON geometry with buffer applied. | Required |\n| name | String | Body | Sub-part of `namedBuffers`; user-facing identifier for area of interest. | Required |\n\n##Recipe Configs Sub-Part Parameters##\n| Parameter | Data Type | Parameter Type | Description | Required? |\n| --- | --- | --- | --- | --- |\n| configurationDate | ISO-8601 Formatted Date/Time String | Body | Timestamp when recipe was added to project in yyyy-MM-ddTHH:mm:ss.SSSZ format. | Required |\n| endDate | ISO-8601 Formatted Date/Time String | Body | Latest timestamp in yyyy-MM-ddTHH:mm:ss.SSSZ format of input images/vectors to use when running this recipe. Note: This endDate will be recipe-specific inside of the project; other recipes will not be effected by this parameter. | Optional |\n| parameters | String | Body | Contains sub-parts such as `name`, `type`, and `value` that are recipe specific. See [AnswerFactory Recipe Reference Overview](doc:answerfactory-recipe-reference-overview) for more details on recipe parameters. | *Only required if recipe parameter is required for the given recipe*. |\n| recipeId | String | Body | Identifier of the recipe to run. Example: ```\"recipeId\": \"query-tweets\"``` | Required |\n| recipeName | String | Body | The name of the recipe to run. Example: ```\"recipeName\": \"Query Tweets\"``` | Required |\n| startDate | ISO-8601 Formatted Date/Time String | Body | Earliest timestamp in yyyy-MM-ddTHH:mm:ss.SSSZ format of input images/vectors to use when running this recipe. Note: This startDate will be recipe-specific inside of the project; other recipes will not be effected by this parameter. | Optional |\n\n#Associated API Calls for AnswerFactory Projects#\n[Check availability of AnswerFactory Project Endpoints](doc:check-availability-of-answerfactory-project-endpoints)\n[Check uniqueness of AnswerFactory Project Name](doc:check-uniqueness-of-answerfactory-project-name)\n[Create an AnswerFactory Project](doc:create-answerfactory-project)\n[Delete an AnswerFactory Project](doc:delete-answerfactory-project)\n[Retrieve an AnswerFactory Project](doc:retrieve-answerfactory-project)\n[Retrieve Listing of AnswerFactory Projects for Account](doc:retrieve-listing-of-answerfactory-projects-for-account)\n[Update an AnswerFactory Project](doc:update-answerfactory-project)","excerpt":"Overview of the AnswerFactory Project API","slug":"answerfactory-project-reference-overview","type":"basic","title":"AnswerFactory Project Reference Overview"}

AnswerFactory Project Reference Overview

Overview of the AnswerFactory Project API

| Table of Contents | | --- | | [AnswerFactory Project JSON](#section-project-json) | | [AnswerFactory Project API Parameters](#section-api-parameters) | | [Associated API Calls for AnswerFactory Projects](#section-associated-api-calls-for-answerfactory-projects) | #Project JSON# An AnswerFactory project consists of four main parts: * project metadata * a set of configurations for building "answers" for the project * a set of geometries defining the original base geometries for a project * a set of geometries defining a buffered area of interest (AOI) around those geometries ##Error responses## For all requests, if an error occurs, the response body will consist of JSON formatted like this: ```json { "error" : "message" } ``` The HTTP response code will depend on the error. #API Parameters# | Parameter | Data Type | Parameter Type | Description | Required? | | --- | --- | --- | --- | --- | | accountId | String | Body | Identifier for account the owner of project belongs to; defaults to GBDX account the user making project creation request belongs to. | Optional | | acquisitionIds | String | Body | String of comma or whitespace delimited catalog IDs/acquisition IDs of images to run recipes on. | Optional | | aois | String | Body | Array of GeoJSON geometry with buffer applied. | Required | | continuouslyOrdered | Boolean | Body | Determines whether the project watches for new images that intersect the project aoi. If true the project's recipes will be run on every new valid image that intersects the project aoi. | Required | | createDate | ISO-8601 Formatted Date/Time String | Body | Timestamp when project was created in yyyy-MM-ddTHH:mm:ss.SSSZ format. | Required | | dateRange | String | Body | Contains sub-parts `startDate` and `endDate`, providing the date range to restrict images/vectors to. Note: acquisitionIds trumps dateRange when project is being processed. See [Date Range Sub-Part Parameters](#section-date-range-sub-part-parameters) for sub-part definitions. | Optional | | description | String | Body | User specified string; project description. | Optional | | enabled | Boolean | Body | Determines whether the project is visible to anyone; if false this project will be hidden. | Required | | id | String | Body | Project's unique identifier; must not be specified when creating an object. | Required | | name | String | Body | User-specified project identifier. This is the human-readable project identifier; must be unique per account. | Required | | namedBuffers | String | Body | Contains sub-parts `name` and `buffer`, providing individual aoi specifics for the project. See [Named Buffers Sub-Part Parameters](#section-named-buffers-sub-part-parameters) for sub-part definitions. | Required | | notes | String | Body | User specified string; general notes for the project. | Optional | | originalGeometries | String | Body | Array of GeoJSON objects from the source; source may be shapefile or other. | Required | | owner | String | Body | Username of user who owns project; defaults to GBDX username of user making project creation request. | Optional | | recipeConfigs | String | Body | Contains sub-parts `recipeId`, `recipeName`, `configurationDate`, `startDate`, `endDate`, and `parameters`, providing project-specfic recipe information. See [Recipe Configs Sub-Part Parameters](#section-recipe-configs-sub-part-parameters) for sub-part definitions. | Required | | tags | String | Body | User specified string or array of strings providing tags to associate with the project for easier lookup of similar projects. Multiple projects can have the same tag or tags. Example: ```"tags": [ "tag1", "tag-2" ]``` | Optional | | updateDate | ISO-8601 Formatted Date/Time String | Body | Timestamp when project was last modified in yyyy-MM-ddTHH:mm:ss.SSSZ format. | Required | | visibility | String | Body | Determines whether the project is made public to GBDX users or kept private; set to `public` to allow users outside the owner's account to view the project; otherwise leave as an empty array. | Optional | ##Date Range Sub-Part Parameters## | Parameter | Data Type | Parameter Type | Description | Required? | | --- | --- | --- | --- | --- | | endDate | ISO-8601 Formatted Date/Time String | Body | Sub-part of `dateRange`; latest timestamp in yyyy-MM-ddTHH:mm:ss.SSSZ format of input images/vectors to use when running all recipes. | Optional | | startDate | ISO-8601 Formatted Date/Time String | Body | Sub-part of `dateRange`; earliest timestamp in yyyy-MM-ddTHH:mm:ss.SSSZ format of input images/vectors to use when running all recipes. | Optional | ##Named Buffers Sub-Part Parameters## | Parameter | Data Type | Parameter Type | Description | Required? | | --- | --- | --- | --- | --- | | buffer | String | Body | Sub-part of `namedBuffers`; GeoJSON geometry with buffer applied. | Required | | name | String | Body | Sub-part of `namedBuffers`; user-facing identifier for area of interest. | Required | ##Recipe Configs Sub-Part Parameters## | Parameter | Data Type | Parameter Type | Description | Required? | | --- | --- | --- | --- | --- | | configurationDate | ISO-8601 Formatted Date/Time String | Body | Timestamp when recipe was added to project in yyyy-MM-ddTHH:mm:ss.SSSZ format. | Required | | endDate | ISO-8601 Formatted Date/Time String | Body | Latest timestamp in yyyy-MM-ddTHH:mm:ss.SSSZ format of input images/vectors to use when running this recipe. Note: This endDate will be recipe-specific inside of the project; other recipes will not be effected by this parameter. | Optional | | parameters | String | Body | Contains sub-parts such as `name`, `type`, and `value` that are recipe specific. See [AnswerFactory Recipe Reference Overview](doc:answerfactory-recipe-reference-overview) for more details on recipe parameters. | *Only required if recipe parameter is required for the given recipe*. | | recipeId | String | Body | Identifier of the recipe to run. Example: ```"recipeId": "query-tweets"``` | Required | | recipeName | String | Body | The name of the recipe to run. Example: ```"recipeName": "Query Tweets"``` | Required | | startDate | ISO-8601 Formatted Date/Time String | Body | Earliest timestamp in yyyy-MM-ddTHH:mm:ss.SSSZ format of input images/vectors to use when running this recipe. Note: This startDate will be recipe-specific inside of the project; other recipes will not be effected by this parameter. | Optional | #Associated API Calls for AnswerFactory Projects# [Check availability of AnswerFactory Project Endpoints](doc:check-availability-of-answerfactory-project-endpoints) [Check uniqueness of AnswerFactory Project Name](doc:check-uniqueness-of-answerfactory-project-name) [Create an AnswerFactory Project](doc:create-answerfactory-project) [Delete an AnswerFactory Project](doc:delete-answerfactory-project) [Retrieve an AnswerFactory Project](doc:retrieve-answerfactory-project) [Retrieve Listing of AnswerFactory Projects for Account](doc:retrieve-listing-of-answerfactory-projects-for-account) [Update an AnswerFactory Project](doc:update-answerfactory-project)