updateWorkflow
A MoogDb v2 method that updates an existing workflow in the Workflow Engine.
Back to MoogDb V2 API Method Reference.
Request arguments
Method updateWorkflow takes the following request arguments:
Name | Type | Required | Description |
|---|---|---|---|
| Integer | Yes | ID of the workflow you want to update. |
| JSON Object | Yes | A JSON object containing the details of the workflow(s) to be updated. |
The object details contains the following information:
Name | Type | Required | Description | ||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| String | Yes | Name of the workflow. | ||||||||||||||||||||||||||||||||
| Boolean | No | Determines whether the workflow is active or not. If | ||||||||||||||||||||||||||||||||
| String | No | Description of the workflow. | ||||||||||||||||||||||||||||||||
| String | No | An SQL-like filter to determine which events, alerts or Situations can enter the workflow. If empty, the workflow accepts all events, alerts or Situations. See Filter Search Data for more information on creating SQL-like filters. | ||||||||||||||||||||||||||||||||
| String | No | An SQL-like filter to intake any additional events, alerts or Situations from the database. See Filter Search Data for more information on creating SQL-like filters. | ||||||||||||||||||||||||||||||||
| Boolean | No | Determines whether to perform workflow operations only once on each object. | ||||||||||||||||||||||||||||||||
| JSON Array | No | List of properties relating to each operation:
| ||||||||||||||||||||||||||||||||
| Boolean | No | Mandatory for 'delay' type. |
Response
Method updateWorkflow returns the following response:
Examples
The following examples demonstrate typical use of method updateWorkflow:
Request example
Example request to update workflow ID 1 with a new workflow name:
moogdb.updateWorkflow(1, {workflow_name: “new name”});