Retrieving all recipes
Retrieve all recipes for a particular tenant.
Procedure
- In a REST client platform, add the authentication details of the tenant from where you
want to retrieve recipes.
//In case of Instance API key Headers: { "x-instance-api-key": "instance_api_key" } // In case of MCSP or ISV token Headers: { "Authorization": "mcsp_or_isv_token" } - Make a GET request at the URL of the project.
URL syntax:
<domain>/apis/v1/rest/recipesYou can control and filter the output response by using the URL query parameters. In this URL request:
- If you want to skip a certain number of pages at the beginning of the collection in the response, append the query parameter ?skip=n to the URL request, where n is the number of pages you want to skip.
- If you want to define the maximum page size starting from the n-th one, append ?limit=m to the URL request, where m is the total number of records you want to include in the response.
- If you want to retrieve details of all unpublished recipes from a particular tenant, append ?my_recipe=true to the URL request.
Method: GET
If the request is successful, you receive the response code for success.
{ output: { "count":<total_recipe_count>, "objects": [ { "uid": <recipe_uid> "name": "<recipe_name>", "description": "<description>", "download": "<recipe_download_count>" } ] } }