Recipe schema methods and events

Methods and events in the Recipe schema, including their parameters and results.

Methods

The following tables describe methods and related parameters:

Method available from the IDE and through C# API
Method	Input arguments	Output arguments
CreateRecipe Creates a new recipe in the store.	RecipeId [RecipeId]	Result [CreateRecipeResultCode] Success: the recipe has been created successfully MissingRecipeId: the method was called with an empty RecipeId RecipeAlreadyExist: a recipe with the same name and version already exists StoreError: an error occurred while accessing the store Error: an error occurred
DuplicateRecipe Duplicates an existing recipe with a new identifier.	RecipeId [RecipeId] NewRecipeId [RecipeId]	Result [DuplicateRecipeResultCode] Success: the recipe has been duplicated successfully GenericError: a general error occurred during recipe duplication StoreError: an error occurred while accessing the store (e.g., database error) UnexpectedSourceEmptyRecipeName: the source recipe name provided is empty or null UnexpectedTargetEmptyRecipeName: the target recipe name provided is empty or null SourceRecipeDoesNotExist: the source recipe was not found in the store TargetRecipeAlreadyExist: a recipe with the target name already exists TargetNotFound: the target node for recipe duplication was not found
RenameRecipe Renames an existing recipe.	RecipeId [RecipeId] NewName [String]	Result [RenameRecipeResultCode] Success: the recipe has been renamed successfully GenericError: a general error occurred during recipe renaming StoreError: an error occurred while accessing the store (e.g., database error) UnexpectedEmptyRecipeName: the recipe name provided is empty or null SourceRecipeDoesNotExist: the source recipe was not found in the store TargetRecipeAlreadyExist: a recipe with the target name already exists
DeleteRecipe Deletes an existing recipe from the store.	RecipeId [RecipeId]	Result [DeleteRecipeResultCode] Success: the recipe has been deleted successfully GenericError: a general error occurred during recipe deletion StoreError: an error occurred while accessing the store (e.g., database error) UnexpectedEmptyRecipeName: the recipe name provided is empty or null RecipeDoesNotExist: the specified recipe was not found in the store
Refactor Performs a refactor operation asynchronously.	None	None. This is the only async method. When the operation is completed, an event (RefactorCompleted) is dispatched.
GetDataItems Retrieves data items associated with a recipe.	RecipeId [RecipeId]	Result [GetDataItemsResultCode] Success: the data items have been retrieved successfully RecipeNotFound: the specified recipe was not found in the store StoreError: an error occurred while accessing the store (e.g., database error) GenericError: a general error occurred while retrieving the data items
SetRecipeDataItemValue Sets the value of a specific data item in a recipe.	RecipeId [RecipeId] ItemRelativeBrowsePath [String] DataItemRelativeBrowsePath [String] ElementAccess [ElementAccess] Value [BaseDataType]	Result [SetRecipeDataItemValueResultCode] Success: the recipe data item value has been set successfully GenericError: a general error occurred while setting the data item value StoreError: an error occurred while accessing the store (e.g., database error) DataItemNotFound: the specified data item was not found in the recipe UnexpectedEmptyRecipeName: the recipe name provided is empty or null RecipeNotFound: the specified recipe was not found in the store
SetRecipeMetadataValue Sets the value of a specific metadata field in a recipe.	RecipeId [RecipeId] MetadataName [String] Value [BaseDataType]	Result [SetRecipeMetadataValueResultCode] Success: the recipe metadata value has been set successfully GenericError: a general error occurred while setting the metadata value StoreError: an error occurred while accessing the store (e.g., database error) UnexpectedEmptyRecipeName: the recipe name provided is empty or null RecipeNotFound: the specified recipe was not found in the store MetadataNotFound: the specified metadata field was not found in the recipe
TransferFromEditModelToStore Transfers a recipe from the edit model to the store.	RequesterNodeId [NodeId] RecipeId [RecipeId]	Result [TransferFromEditModelToStoreResultCode] SuccessRecipeCreated: the recipe has been successfully created and transferred from edit model to store SuccessRecipeUpdated: the recipe has been successfully updated and transferred from edit model to store GenericError: a general error occurred during the transfer from edit model to store StoreError: an error occurred while accessing the store (e.g., database error) RequesterNodeNotFound: the requester node was not found UnexpectedEmptyRecipeName: the recipe name provided is empty or null TargetNotFound: the target node for the transfer was not found EditModelNodeNotFound: the edit model node was not found
TransferFromEditModelToTarget Transfers a recipe from the edit model to a target node.	RequesterNodeId [NodeId] TargetNodeId [NodeId] ErrorPolicy [ErrorPolicyDataType]	Result [TransferFromEditModelToTargetResultCode] Success: the recipe has been transferred from edit model to target successfully GenericError: a general error occurred during the transfer from edit model to target StoreError: an error occurred while accessing the store (e.g., database error) RequesterNodeNotFound: the requester node was not found TargetNotFound: the target node for the transfer was not found EditModelNodeNotFound: the edit model node was not found DataMismatch: there is a mismatch between the edit model data and target structure
TransferFromStoreToEditModel Transfers a recipe from the store to the edit model.	RequesterNodeId [NodeId] RecipeId [RecipeId]	Result [TransferFromEditModelToTargetResultCode] Success: the recipe has been transferred from edit model to target successfully GenericError: a general error occurred during the transfer from edit model to target StoreError: an error occurred while accessing the store (e.g., database error) RequesterNodeNotFound: the requester node was not found TargetNotFound: the target node for the transfer was not found EditModelNodeNotFound: the edit model node was not found DataMismatch: there is a mismatch between the edit model data and target structure
TransferFromStoreToTarget Transfers a recipe from the store to a target node.	RecipeId [RecipeId] TargetNodeId [NodeId] ErrorPolicy [ErrorPolicyDataType]	Result [TransferFromStoreToTargetResultCode] Success: the recipe has been transferred from store to target successfully GenericError: a general error occurred during the transfer from store to target StoreError: an error occurred while accessing the store (e.g., database error) UnexpectedEmptyRecipeName: the recipe name provided is empty or null RecipeNotFound: the specified recipe was not found in the store TargetNotFound: the target node for the transfer was not found DataMismatch: there is a mismatch between the recipe data and target structure
TransferFromTargetToEditModel Transfers a recipe from a target node to the edit model.	RequesterNodeId [NodeId] TargetNodeId [NodeId] ErrorPolicy [ErrorPolicyDataType]	Result [TransferFromTargetToEditModelResultCode] Success: the recipe has been transferred from target to edit model successfully GenericError: a general error occurred during the transfer from target to edit model StoreError: an error occurred while accessing the store (e.g., database error) RequesterNodeNotFound: the requester node was not found TargetNotFound: the target node for the transfer was not found EditModelNodeNotFound: the edit model node was not found DataMismatch: there is a mismatch between the target data and edit model structure
TransferFromTargetToStore Transfers a recipe from a target node to the store.	RecipeId [RecipeId] TargetNodeId [NodeId] Overwrite [Bool] ErrorPolicy [ErrorPolicyDataType]	Result [TransferFromTargetToStoreResultCode] SuccessRecipeCreated: the recipe has been successfully created and transferred from target to store SuccessRecipeUpdated: the recipe has been successfully updated and transferred from target to store GenericError: a general error occurred during the transfer from target to store StoreError: an error occurred while accessing the store (e.g., database error) UnexpectedEmptyRecipeName: the recipe name provided is empty or null RecipeAlreadyExists: a recipe with the same name already exists in the store TargetNotFound: the target node for the transfer was not found DataMismatch: there is a mismatch between the target data and store structure

Methods available only through C# API
Method	Input arguments	Output arguments
GetRecipes Retrieves a list of all recipes in the store.	No input arguments	Result [GetRecipesResult] (Array) Success: the recipes have been retrieved successfully StoreError: an error occurred while accessing the store GenericError: a general error occurred while retrieving the recipes
GetRecipeMetadataValue Retrieves the value of a specific metadata field in a recipe.	RecipeId [RecipeId] MetadataName [String]	Result [GetRecipeMetadataValueResult] Success: the recipe metadata value has been retrieved successfully GenericError: a general error occurred while retrieving the metadata value StoreError: an error occurred while accessing the store UnexpectedEmptyRecipeName: the recipe name provided is empty or null RecipeNotFound: the specified recipe was not found in the store MetadataNotFound: the specified metadata field was not found in the recipe
GetRecipeMetadataValues Retrieves all metadata values associated with a recipe.	RecipeId [RecipeId]	Result [GetRecipeMetadataValuesResult] Success: the recipe metadata values have been retrieved successfully GenericError: a general error occurred while retrieving the metadata values StoreError: an error occurred while accessing the store UnexpectedEmptyRecipeName: the recipe name provided is empty or null RecipeNotFound: the specified recipe was not found in the store
GetRecipeDataItemValue Retrieves the value of a specific data item in a recipe.	RecipeId [RecipeId] ItemRelativeBrowsePath [String] (Array) DataItemRelativeBrowsePath [String] (Array) ElementAccess [ElementAccess]	Result [GetRecipeDataItemValueResult] Success: the recipe data item value has been retrieved successfully GenericError: a general error occurred while retrieving the data item value StoreError: an error occurred while accessing the store DataItemNotFound: the specified data item was not found in the recipe UnexpectedEmptyRecipeName: the recipe name provided is empty or null RecipeNotFound: the specified recipe was not found in the store
CreateEditModel Creates an edit model for a recipe.	ParentNodeId [NodeId] RequesterNodeId [NodeId] TargetNodeId [NodeId] RecipeId [RecipeId]	Result [CreateEditModelResultCode] Success: the edit model has been created successfully GenericError: a general error occurred while creating the edit model StoreError: an error occurred while accessing the store ParentNodeNotFound: the parent node for the edit model was not found RequesterNodeNotFound: the requester node was not found
TransferFromStores Transfers a recipe from the store to a target node.	RecipeId [RecipeId]	Result [TransferFromStoreResultCode] Success: the recipe has been transferred from store successfully GenericError: a general error occurred during the transfer from store StoreError: an error occurred while accessing the store RecipeNotFound: the specified recipe was not found in the store TargetNotFound: the target node for the transfer was not found
TransferToStore Transfers a recipe to the store.	RecipeId [RecipeId]	Result [TransferToStoreResultCode] Success: the recipe has been transferred to store successfully GenericError: a general error occurred during the transfer to store StoreError: an error occurred while accessing the store
TransferToTarget Transfers a recipe to a target node.	TargetNodeId [NodeId] ErrorPolicy [ErrorPolicy]	Result [TransferToTargetResultCode] Success: the recipe has been transferred to target successfully GenericError: a general error occurred during the transfer to target StoreError: an error occurred while accessing the store TargetNotFound: the target node for the transfer was not found DataMismatch: there is a mismatch between the recipe data and target structure
TransferFromTarget Transfers a recipe from a target node to the store.	TargetNodeId [NodeId] ErrorPolicy [ErrorPolicy]	Result [TransferFromTargetResultCode] Success: the recipe has been transferred from target successfully GenericError: a general error occurred during the transfer from target StoreError: an error occurred while accessing the store TargetNotFound: the target node for the transfer was not found DataMismatch: there is a mismatch between the target data and recipe structure
SetDataItemValue Sets the value of a specific data item.	ItemId [NodeId] DataItemRelativeBrowsePath [String] (Array) ElementAccess [ElementAccess] DataTypeId [NodeId] Value [BaseDataType]	Result [SetDataItemValueResultCode] Success: the data item value has been set successfully GenericError: a general error occurred while setting the data item value StoreError: an error occurred while accessing the store DataItemNotFound: the specified data item was not found

Events

The Recipe schema includes the following events:

RefactorCompleted: Fired when the method Refactor is completed.
RecipeApplicationEvent: Fired when TransferFromStoreToTarget or TransferEditModelToTarget are completed.

Recipe schemas

Provide Feedback

Have questions or feedback about this documentation? Please submit your feedback here.