Rest API Methods
- Last UpdatedNov 21, 2018
- 2 minute read
The following are the methods of the REST API class.
-
GetMany
-
Put
GetMany
Returns a list of valid items that can be assigned to the Equipment.
Syntax
string GetMany(string url);
Parameters
url
Passed in URL value.
Return Value
A text representation of the value.
|
Examples |
Description |
|---|---|
|
"api/Formulas/?EquipmentName=" |
Returns a list of valid Formulas that can be assigned to the Equipment. |
|
"api/Recipes/?EquipmentName=" |
Returns a list of valid Recipes that can be assigned to the Equipment. |
|
"api/RecipeParameterMaps/?EquipmentName=" |
Returns a list of RecipeParameterMaps that can be used to update Equipment Parameter target values. By default, only Frequently Used parameters are returned. To get all parameters, add "&showAllRuntimeParametersFilter=true" to the URL. |
|
"api/FormulaParameters/?EquipmentName=" |
Returns a list of FormulaParameters that can be used to update Formula Parameter target values. To get all parameters, add "&showAllRuntimeParametersFilter=true" to the URL. |
Put
Updates the inner text value of a specified item.
Syntax
string Put(string url)
Parameters
url
The passed in url on the model.
Value
The value you want to update.
NOTE: If you configure the Done By/ Check By Settings for the Change Runtime Parameter Values action, these APIs will return an error.
|
Examples |
Description |
|---|---|
|
“api/RecipeParameterMaps/” |
Allows for the updating of a single Equipment Parameter. Pass a single RecipeParameterMap instance. This can be used for Recipes and Formula Downloads. |
|
“api/RecipeParameterMaps/BulkChange” |
Allows for updating of many Equipment Parameters in one transaction. Pass the original RecipeParameterMap collection. This can be used for Recipes and Formula Downloads. |
|
"api/FormulaParameters/?EquipmentName=” |
Allows for the updating of a single FormulaParameter for the specified Equipment. Pass a single FormulaParameter instance. This call only applies to Recipes. Formula Downloads do not have their own copy of the Formula at runtime, so the Formula cannot be changed. |