Recipe Model and API
- Last UpdatedApr 19, 2017
- 1 minute read
These classes expose functionality to get and modify Recipes.
Recipe Model
|
Name |
Type |
Description |
|
Id |
Integer |
Gets the ID. |
|
Name |
String |
Gets or sets the Recipe name. |
|
Description |
String |
Gets or sets the Recipe description |
|
State |
ModelStates |
Gets the state. (See ModelStates) |
|
Version |
Integer |
Gets the version |
|
CheckedOut |
Boolean |
Gets a value that indicates the recipe is checked out. |
|
Upgradable |
Boolean |
Gets a value that indicates the recipe can be upgraded. |
Recipe API
|
Name |
Description |
|
GetOne(string) |
Returns the latest version of the recipe which matches the passed in name. Does not return obsoleted Recipe. |
|
GetAll() |
Returns the latest version of all Recipes. Does not return obsoleted Recipes. |
|
Add(string, string) |
Creates and returns a Recipe using the provided Recipe Template and Formula name. The name of the new Recipe is auto generated. |
|
Change(Recipe) |
The recipe passed in will be used to update the Recipe on the server. |
|
CheckOut(string) |
Checks out and return a Recipe. |
|
CheckIn(Recipe) |
Checks in the Recipe. |
|
UndoCheckOut(Recipe) |
The checked-out Recipe will be reverted to the previous checked in version. |
|
Upgrade(Recipe) |
Upgrades the Recipe. |
|
SetState(Recipe, ModelStates, string) |
Used to change the state of the Recipe. |