Recipe Exchange API

DownloadRecipeToAllBatchExecutives

This method downloads a recipe to all batch executives it is assigned to. The method returns a string that is included in the batch log. The method signature is:

string DownloadRecipeToAllBatchExecutives(
   RecipeInfo recipeInfo,
   bool bPermitDownloadOfCheckedoutItems,
   bool bPermitDownloadOfUnauthorizedItems,
   bool bIncludeSubRecipes
);

Method Parameters

Parameters for this method are shown in the following table.

Parameter

Description

Type

Valid Input

recipeInfo

Instance of RecipeInfo data contract

RecipeInfo

RecipeInfo instance

bPermitDownloadOfCheckedoutItems

Permission to download checked-out recipes.

Boolean

True = allow download

False = do not allow download

bPermitDownloadOfUnauthorizedItems

Permission to download unauthorized recipes.

Boolean

True = allow download

False = do not allow download

bIncludeSubRecipes

Include contained recipes in download

Boolean

True = include recipes

False = do not include recipes