Click or drag to resize

UpdateRecipeRequest Class

[This is preliminary documentation and is subject to change.]

This message is used to send a named recipe to a process endpoint. The message includes details of the recipe, depending on the classification of the process. The response indicates whether the recipe has been received correctly or not.
Copy
{
  "Overwrite": true,
  "Recipe": {
    "Name": "RECIPE234324",
    "Revision": "C",
    "MimeType": "application/octet-stream",
    "RecipeData": "//w0"
  },
  "Reason": "NewRevision"
}
Inheritance Hierarchy
SystemObject
  CFXCFXMessage
    CFX.ProductionUpdateRecipeRequest

Namespace:  CFX.Production
Assembly:  CFXnet46 (in CFXnet46.dll) Version: 1.0.5
Syntax
Copy
public class UpdateRecipeRequest : CFXMessage

The UpdateRecipeRequest type exposes the following members.

Properties
  NameDescription
Public propertyOverwrite
If set to true, any existing Recipe at the Endpoint with the same name will be replaced by the Recipe provided in this request. If set to False, the update request will not succeed if a Recipe with the same name exists at the Endpoint.
Public propertyReason
The reason for the update
Public propertyRecipe
The new Recipe to be sent to the Endpoint.
Top
See Also