---
schema_version: "1"
id: f2f2527e990c9ea8d113e36b4a3688265aa53120abf943d00ee5a3ebd8821e20
title: Recipe Resource
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/salesforce_recipes_api/sforce_recipes_api_resources_recipes_id.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_resources_recipes_id.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: 87e4e2d28d64ab19a9cabdcf78c8d8d005243f40ac2fecf52afb8f7fcb724397
description: Returns, updates, or deletes a Data Prep recipe.
---
# Recipe Resource

Returns, updates, or deletes a Data Prep recipe.

## Resource URL

/wave/recipes/<id>

## Formats

JSON

## Available Version

38.0

## Available in Postman

To view and test a working example of this resource, see [getRecipe](https://www.postman.com/salesforce-developers/workspace/salesforce-developers/request/12721794-51418077-f2ba-4cfc-ba89-67003b67327e?action=share&source=copy-link&creator=26106753 "HTML (New Window)") in Postman. For information about how to authenticate your org with Postman, see the [CRM Analytics Rest API Quickstart](https://developer.salesforce.com/docs/atlas.en-us.264.0.bi_dev_guide_rest.meta/bi_dev_guide_rest/crma_rest_api_quick_start.htm "HTML (New Window)").

## Available Components

- LWC — [lightning/analyticsWaveApi deleteRecipe()](https://developer.salesforce.com/docs/platform/lwc/guide/reference-analytics-delete-recipe.html)
- LWC — [lightning/analyticsWaveApi getRecipe()](https://developer.salesforce.com/docs/platform/lwc/guide/reference-wire-adapters-get-recipe.html)
- LWC — [lightning/analyticsWaveApi updateRecipe()](https://developer.salesforce.com/docs/platform/lwc/guide/reference-analytics-update-recipe.html)

## HTTP Methods

DELETE GET PATCH PUT

## Run a Recipe

To run a Data Prep recipe, use the [Dataflow Jobs Resource](https://developer.salesforce.com/docs/atlas.en-us.264.0.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dataflowjobs.htm) API. For examples of how to start and stop recipes, see [Start and Stop a Dataflow Job or Recipe](https://developer.salesforce.com/docs/atlas.en-us.264.0.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_run_schedule_sync_data.htm#start_stop_dataflows).

## Schedule a Recipe

To schedule a recipe, use the [Schedule Resource](https://developer.salesforce.com/docs/atlas.en-us.264.0.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_schedule.htm) API. For examples of how to schedule recipes, see [Schedule Dataflows, Recipes, and Data Syncs](https://developer.salesforce.com/docs/atlas.en-us.264.0.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_run_schedule_sync_data.htm#schedule_data_assets).

## Request Parameters for GET

<table class="featureTable sort_table" summary="">





          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader vertical-align-top " id="d73635e179">Parameter Name</th>

              <th class="featureTableHeader vertical-align-top " id="d73635e182">Type</th>

              <th class="featureTableHeader vertical-align-top " id="d73635e185">Description</th>

              <th class="featureTableHeader vertical-align-top " id="d73635e188">Required or Optional</th>

              <th class="featureTableHeader vertical-align-top " id="d73635e191">Available Version</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d73635e179" data-title="Parameter Name"><samp class="codeph nolang">format</samp></td>

              <td class="entry" headers="d73635e182" data-title="Type">Connect​Recipe​Format​Type​Enum</td>

              <td class="entry" headers="d73635e185" data-title="Description">Specifies the format of the returned recipe. Valid values are: <ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">R2</samp> (Data Prep Classic)
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">R3</samp> (Data Prep)
                  </li>

                </ul>
              </td>

              <td class="entry" headers="d73635e188" data-title="Required or Optional">Required for Data Prep recipes, Optional for Data Prep Classic
                recipes.</td>

              <td class="entry" headers="d73635e191" data-title="Available Version">49.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d73635e179" data-title="Parameter Name"><samp class="codeph nolang">history​Id</samp></td>

              <td class="entry" headers="d73635e182" data-title="Type">Id</td>

              <td class="entry" headers="d73635e185" data-title="Description">Use the history ID to request a specific recipe version.</td>

              <td class="entry" headers="d73635e188" data-title="Required or Optional">Optional</td>

              <td class="entry" headers="d73635e191" data-title="Available Version">51.0</td>

            </tr>

          </tbody>

        </table>

The following REST URL shows how to use the format request parameter to return a Data Prep recipe via the GET request.

/wave/recipes/<05vS7000000xxxxxxx>?format=R3

![Note](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/images/icon_note.png)

#### Note

With API version 49.0 and higher, the format request parameter is required for recipes created in the Data Prep format. For recipes created in the Data Prep Classic format, the format request parameter isn’t needed. If you want to up-convert the Data Prep Classic recipe format to the Data Prep recipe format, use the format request parameter set to R3.

## Response Body for GET, PATCH, and PUT

[Recipe](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_recipe.htm "A data prep recipe.")

## Request Body for PATCH

<table class="featureTable sort_table" summary="">





          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader vertical-align-top " id="d73635e316">Property Name</th>

              <th class="featureTableHeader vertical-align-top " id="d73635e319">Type</th>

              <th class="featureTableHeader vertical-align-top " id="d73635e322">Description</th>

              <th class="featureTableHeader vertical-align-top " id="d73635e325">Required or Optional</th>

              <th class="featureTableHeader vertical-align-top " id="d73635e328">Available Version</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d73635e316" data-title="Property Name"><samp class="codeph nolang">enable​Editor​Validation</samp></td>

              <td class="entry" headers="d73635e319" data-title="Type">Boolean</td>

              <td class="entry" headers="d73635e322" data-title="Description">Indicates whether editor validation for the recipe is enabled (<samp class="codeph nolang">true</samp>) or not (
                <samp class="codeph nolang">false</samp>).
              </td>

              <td class="entry" headers="d73635e325" data-title="Required or Optional">Required</td>

              <td class="entry" headers="d73635e328" data-title="Available Version">53.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d73635e316" data-title="Property Name"><samp class="codeph nolang">recipe​File</samp></td>

              <td class="entry" headers="d73635e319" data-title="Type">Binary</td>

              <td class="entry" headers="d73635e322" data-title="Description">The recipe file.</td>

              <td class="entry" headers="d73635e325" data-title="Required or Optional">Required</td>

              <td class="entry" headers="d73635e328" data-title="Available Version">38.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d73635e316" data-title="Property Name"><samp class="codeph nolang">recipe​Object</samp></td>

              <td class="entry" headers="d73635e319" data-title="Type">
                <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_recipe_input.htm" title="A data prep recipe.">Recipe​Input</a>[]
              </td>

              <td class="entry" headers="d73635e322" data-title="Description">The recipe definition.</td>

              <td class="entry" headers="d73635e325" data-title="Required or Optional">Required</td>

              <td class="entry" headers="d73635e328" data-title="Available Version">38.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d73635e316" data-title="Property Name"><samp class="codeph nolang">validation​Context</samp></td>

              <td class="entry" headers="d73635e319" data-title="Type">Connect​Recipe​Validation​Context​Enum</td>

              <td class="entry" headers="d73635e322" data-title="Description">The recipe validation context. Valid values are: <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Default</samp></li>

                  <li class="li"><samp class="codeph nolang">Editor</samp></li>

                </ul>
              </td>

              <td class="entry" headers="d73635e325" data-title="Required or Optional">Required</td>

              <td class="entry" headers="d73635e328" data-title="Available Version">53.0</td>

            </tr>

          </tbody>

        </table>

The following JSON shows how to update a recipe, specifically the license type for the recipe.

{
  "recipeObject" : {
     "licenseAttributes": { "type": "Sonic" }
  } 
}

![Note](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/images/icon_note.png)

#### Note

If the recipe was created in the Data Prep Classic format, then is retrieved in the Data Prep format, a PATCH request with the Data Prep format up-converts the recipe permanently to the Data Prep format.

## Request Body for PUT

Use the PUT API request to revert to a previous historical version. [Asset Revert History Input](https://developer.salesforce.com/docs/atlas.en-us.264.0.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_asset_revert_history_input.htm) The following JSON shows the revert request for a recipe version.

{
    "historyId" : "0RmRM000000xxxxxxx"
}