Data contracts define complex data that can be exchanged with the service. Data contracts contain information required by the service to process the method invoked by the client.
Recipe Exchange Web Service includes the following data contracts.
This data contract is an enumeration used as input to recipeType member in the data contracts. The values in this enumeration set contains a subset of what is defined in the API to limit the choices to those valid as recipe types.
The following are the types valid as input to recipeType:
Recipe Exchange supports exporting of more than recipe types. This enumeration set lists all items that can be exported by Recipe Exchange that are valid as input to exportType:
AREA
AREAS
CONTROL_MODULE
CONTROL_MODULE_CLASS
CONTROL_MODULE_CLASSES
ENGINEERING_UNITS
ENUMSETS
EQUIPMENT_MODULE
EQUIPMENT_MODULE_CLASS
EQUIPMENT_MODULE_CLASSES
EQUIPMENT_TRAIN
EQUIPMENT_TRAIN_CLASS
EQUIPMENT_TRAIN_CLASSES
EQUIPMENT_TRAINS
FORMULA
NODE
NODES
NONE
OPERATION
OPERATIONS
PHASECLASS
PHASECLASSES
PROCEDURE
PROCEDURES
PROCESSCELL
PROCESSCELLCLASS
PROCESSCELLCLASSES
RECIPES
SYSTEM
UNIT_SELECTION_POLICIES
UNIT_SELECTION_POLICY
UNITCLASS
UNITCLASSES
UNITMODULE
UNITPROCEDURE
UNITPROCEDURES
RecipeInfo contains the basic information for recipe, recipe type and recipe name. This contract is used by methods requiring information about the recipe being processed.
Member |
Purpose |
Type |
Required Input From Client |
|---|---|---|---|
recipeType |
The type of the specified recipe to be assigned to the batch executives of the specified workstations. |
tagRecipeType |
Yes |
recipeName |
The name of the recipe assigned to the batch executives of the specified workstations. If the recipe is in a category, this name should include the category. For example, operationFolder1/op1 and procedure1/formula1. |
string |
Yes |
The Export method uses this contract as an input parameter. The contract contains the export type and export name of the items requested by the client.