{"_id":"595cc30c9509ad0033f043db","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":9,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-07-05T10:44:28.575Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"method":"get","examples":{"codes":[{"language":"json","code":"https://vector.geobigdata.io/answer-factory-recipe-service/api/recipes?name=roads*"},{"code":"Request:\nGET /answer-factory-recipe-service/api/recipes\n\nHeaders:\n  Authorization: Bearer {token}\n  Accept: application/json\n\n\nResponse (success):\n200 OK\n\nBody:\n  [\n    {\n     ... recipe definition: see AnswerFactory Recipe Reference Overview, linked in the docs section below example and results ...\n    },\n    {\n     ... recipe definition: see AnswerFactory Recipe Reference Overview, linked in the docs section below example and results ...\n    },\n    ...\n  ]","language":"text"}]},"results":{"codes":[{"name":"","code":"[\n    {\n        \"id\": \"query-roads\",\n        \"version\": \"1.0.0\",\n        \"name\": \"Query Roads\",\n        ...\n    },\n    {\n        \"id\": \"road-tracker\",\n        \"version\": \"1.0.0\",\n        \"name\": \"Extract Roads\",\n        ...\n    }\n]","language":"json","status":200}]},"settings":"56e2c4e50522b90e00d9a7b1","auth":"required","params":[{"_id":"5a71c06f48d5d8003f23e501","ref":"","in":"query","required":false,"desc":"Identifier for account recipe is visible to; defaults to GBDX account the user making recipe creation request belongs to. An empty array means the recipe is public.","default":"","type":"string","name":"accountId"},{"_id":"5a71c06f48d5d8003f23e500","ref":"","in":"query","required":false,"desc":"Explanation of what the recipe does.","default":"","type":"string","name":"description"},{"_id":"5a71c06f48d5d8003f23e4ff","ref":"","in":"query","required":false,"desc":"Recipe's unique identifier.","default":"","type":"string","name":"id"},{"_id":"5a71c06f48d5d8003f23e4fe","ref":"","in":"query","required":false,"desc":"Name of the input to the recipe.","default":"","type":"string","name":"inputType"},{"_id":"5a71c06f48d5d8003f23e4fd","ref":"","in":"query","required":false,"desc":"The human-readable unique recipe identifier.","default":"","type":"string","name":"name"},{"_id":"5a71c06f48d5d8003f23e4fc","ref":"","in":"query","required":false,"desc":"Name of the output to the recipe; determines how the result of the recipe will be displayed.","default":"","type":"string","name":"outputType"},{"_id":"5a71c06f48d5d8003f23e4fb","ref":"","in":"query","required":false,"desc":"The username of the user who created recipe; defaults to GBDX username of user making recipe creation request.","default":"","type":"string","name":"owner"},{"_id":"5a71c06f48d5d8003f23e4fa","ref":"","in":"query","required":false,"desc":"","default":"","type":"string","name":"parameter"},{"_id":"5a71c06f48d5d8003f23e4f9","ref":"","in":"query","required":false,"desc":"The id of the recipe to inherit non-overridden fields from.","default":"","type":"string","name":"parentRecipeId"},{"_id":"5a71c06f48d5d8003f23e4f8","ref":"","in":"query","required":false,"desc":"Contains sub-parts that provide specifics on recipes that must run as precursors to this recipe.","default":"","type":"string","name":"prerequisite"},{"_id":"5a71c06f48d5d8003f23e4f7","ref":"","in":"query","required":false,"desc":"Corresponds to the actual property.key value.","default":"","type":"string","name":"propertyKey"},{"_id":"5a71c06f48d5d8003f23e4f6","ref":"","in":"query","required":false,"desc":"Corresponds to the actual porperty.key=value value.","default":"","type":"string","name":"propertyValue"},{"_id":"5a71c06f48d5d8003f23e4f5","ref":"","in":"query","required":false,"desc":"The type of recipe, ie `vector-query` or `workflow`.","default":"","type":"string","name":"recipeType"},{"_id":"5a71c06f48d5d8003f23e4f4","ref":"","in":"query","required":false,"desc":"Values may be `true`, `false`, or a number.","default":"","type":"string","name":"version"},{"_id":"5a71c06f48d5d8003f23e4f3","ref":"","in":"query","required":false,"desc":"Values may be `true` or `false`. If virtual is not set, it will default to `false`.","default":"","type":"string","name":"virtual"}],"url":"/answer-factory-recipe-service/api/recipes"},"isReference":false,"order":23,"body":"Link reference in Example: [AnswerFactory Recipe Reference Overview](doc:answerfactory-recipe-reference-overview)\n\nThe following Query Parameters may also be included to narrow down search results:\n\n| Parameter | Description | Accepts Wildcards? |\n| --- | --- | --- |\n| accountId | Identifier for account recipe is visible to; defaults to GBDX account the user making recipe creation request belongs to. An empty array means the recipe is public. | No |\n| description | Explanation of what the recipe does. | No |\n| id | Recipe's unique identifier. For example, `query-tweets`. | No |\n| inputType | Name of the input to the recipe. For example, `acquisition`. | No |\n| name | The human-readable unique recipe identifier. For example, `Query Tweets`. | Yes |\n| outputType | Name of the output to the recipe; determines how the result of the recipe will be displayed. For example, `vector-service`. | No |\n| owner | The username of the user who created recipe; defaults to GBDX username of user making recipe creation request. | No |\n| parameter | Currently only recipe parameter name is searchable. | No |\n| parentRecipeId | The id of the recipe to inherit non-overridden fields from. | No |\n| prerequisite | Contains sub-parts that provide specifics on recipes that must run as precursors to this recipe. Currently, only the prerequisite `id` is filterable. | No |\n| propertyKey | Corresponds to the actual property.key value. Example: `propertyKey=image_bands`. If only this is provided and not `propertyValue`, this will return recipes that have this property without caring about the property's value. | Yes |\n| propertyValue | Corresponds to the actual porperty.key=value value. Example: `propertyValue=Pan_MS1`. This can be used without also querying on `propertyKey`. | No, unless querying on the `name` propertyKey |\n| recipeType | The type of recipe, ie `vector-query`, `workflow`, etc. | No |\n| version | Values may be `true`, `false`, or a number. By default, version is set to false during querying. To see all versions of a recipe, set version to `true`. | No |\n| virtual | Values may be `true` or `false`. If virtual is not set, it will default to `false`. For example, if `id=extract-protogen-lulc` and `version=true`, you will get all versions of extract-protogen-lulc. | No |\n\nSome things to be aware of when referring to recipes by id: \n\nThe latest version of a recipe is associated with the \"base\" recipe id; that is, the recipe id with no version attached. An example base recipe id, referring to the latest version of the recipe, would be: `\"id\": \"example-recipe\"`. With the version attached: `\"id\": \"example-recipe:4.1.0\"`.\n\nEach time the recipe is updated, the base recipe id is also updated to refer to the newest version of the recipe. In addition, the recipe id is also updated with the latest version number. Previous versions of the recipe will still be available. To query on only a specific version of the recipe, use the recipe id with the specific version number appended. For example: `\"id\": \"example-recipe:2.0.0\"`.\n\nNote: The latest version of a recipe can also be called with its \"versioned\" recipe id. For example, if the recipe is on version 3.1.2: `\"id\": \"example-recipe\"` and `\"id\": \"example-recipe:3.1.2\"` will both refer to the same version, the latest version, of the recipe. However, to view only a past version of a recipe, the recipe must be referred to specifically with the versioned recipe id. For example: `\"id\": \"example-recipe:3.1.1\"`. To view all versions of a recipe, query on the base recipe id and query version: true.","excerpt":"Retrieve a listing of recipes available to the current users account","slug":"retrieve-listing-of-recipes-for-account","type":"endpoint","title":"Retrieve Listing of Recipes for Account"}

getRetrieve Listing of Recipes for Account

Retrieve a listing of recipes available to the current users account

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

accountId:
string
Identifier for account recipe is visible to; defaults to GBDX account the user making recipe creation request belongs to. An empty array means the recipe is public.
description:
string
Explanation of what the recipe does.
id:
string
Recipe's unique identifier.
inputType:
string
Name of the input to the recipe.
name:
string
The human-readable unique recipe identifier.
outputType:
string
Name of the output to the recipe; determines how the result of the recipe will be displayed.
owner:
string
The username of the user who created recipe; defaults to GBDX username of user making recipe creation request.
parameter:
string
parentRecipeId:
string
The id of the recipe to inherit non-overridden fields from.
prerequisite:
string
Contains sub-parts that provide specifics on recipes that must run as precursors to this recipe.
propertyKey:
string
Corresponds to the actual property.key value.
propertyValue:
string
Corresponds to the actual porperty.key=value value.
recipeType:
string
The type of recipe, ie `vector-query` or `workflow`.
version:
string
Values may be `true`, `false`, or a number.
virtual:
string
Values may be `true` or `false`. If virtual is not set, it will default to `false`.

Examples


Result Format


Documentation

Link reference in Example: [AnswerFactory Recipe Reference Overview](doc:answerfactory-recipe-reference-overview) The following Query Parameters may also be included to narrow down search results: | Parameter | Description | Accepts Wildcards? | | --- | --- | --- | | accountId | Identifier for account recipe is visible to; defaults to GBDX account the user making recipe creation request belongs to. An empty array means the recipe is public. | No | | description | Explanation of what the recipe does. | No | | id | Recipe's unique identifier. For example, `query-tweets`. | No | | inputType | Name of the input to the recipe. For example, `acquisition`. | No | | name | The human-readable unique recipe identifier. For example, `Query Tweets`. | Yes | | outputType | Name of the output to the recipe; determines how the result of the recipe will be displayed. For example, `vector-service`. | No | | owner | The username of the user who created recipe; defaults to GBDX username of user making recipe creation request. | No | | parameter | Currently only recipe parameter name is searchable. | No | | parentRecipeId | The id of the recipe to inherit non-overridden fields from. | No | | prerequisite | Contains sub-parts that provide specifics on recipes that must run as precursors to this recipe. Currently, only the prerequisite `id` is filterable. | No | | propertyKey | Corresponds to the actual property.key value. Example: `propertyKey=image_bands`. If only this is provided and not `propertyValue`, this will return recipes that have this property without caring about the property's value. | Yes | | propertyValue | Corresponds to the actual porperty.key=value value. Example: `propertyValue=Pan_MS1`. This can be used without also querying on `propertyKey`. | No, unless querying on the `name` propertyKey | | recipeType | The type of recipe, ie `vector-query`, `workflow`, etc. | No | | version | Values may be `true`, `false`, or a number. By default, version is set to false during querying. To see all versions of a recipe, set version to `true`. | No | | virtual | Values may be `true` or `false`. If virtual is not set, it will default to `false`. For example, if `id=extract-protogen-lulc` and `version=true`, you will get all versions of extract-protogen-lulc. | No | Some things to be aware of when referring to recipes by id: The latest version of a recipe is associated with the "base" recipe id; that is, the recipe id with no version attached. An example base recipe id, referring to the latest version of the recipe, would be: `"id": "example-recipe"`. With the version attached: `"id": "example-recipe:4.1.0"`. Each time the recipe is updated, the base recipe id is also updated to refer to the newest version of the recipe. In addition, the recipe id is also updated with the latest version number. Previous versions of the recipe will still be available. To query on only a specific version of the recipe, use the recipe id with the specific version number appended. For example: `"id": "example-recipe:2.0.0"`. Note: The latest version of a recipe can also be called with its "versioned" recipe id. For example, if the recipe is on version 3.1.2: `"id": "example-recipe"` and `"id": "example-recipe:3.1.2"` will both refer to the same version, the latest version, of the recipe. However, to view only a past version of a recipe, the recipe must be referred to specifically with the versioned recipe id. For example: `"id": "example-recipe:3.1.1"`. To view all versions of a recipe, query on the base recipe id and query version: true.

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