updateWorkflow

A Graze API POST request that updates an existing workflow in the Workflow Engine.

Back to Graze API EndPoint Reference.

Request arguments

Endpoint updateWorkflow takes the following request arguments:

Name

Type

Required

Description

auth_token

String

Yes

A valid auth_token returned from the authenticate request. Alternatively, basic authenticate headers can be used in place of this parameter. See the authenticate endpoint for more information and usage examples.

id

String

Yes

ID of the workflow that you want to update.

workflow_name

String

Name of the workflow.

active

Boolean

Determines whether the workflow is active or not. If true, the workflow is active.

description

String

Description of the workflow.

entry_filter

String

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.

sweep_up_filter

String

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.

first_match_only

Boolean

If enabled, events, alerts, and Situations only pass through actions on the first time they enter the Workflow Engine.

operations

JSON Array

List of properties relating to each operation:

Name	Type	Required	Description
type	String	Yes	Type of operation. Options are: 'action', 'decision' and 'delay'.
operation_name	String	Yes, for 'action' and 'decision' types.	Name of the operation.
function_name	String	Yes, for 'action' and 'decision' types.	Name of the function.
forwarding_behavior	String	No	Forwarding behavior for the function. One of: `always forward`: The function always forwards the object to the next workflow. `stop this workflow`: The function stops this workflow and the object moves to the next workflow. `stop all workflows`: The function stops all workflows for this object. Default is `always forward`. Only valid for 'action' and 'decision' types.
function_args	JSON Object	No	Arguments for the function.
duration	Integer	Yes, for 'delay' type.	Length of time before the message goes to the next operation.
reset	Boolean	Yes, for 'delay' type.	Determines whether the timer resets after each occurrence.

Response

Endpoint updateWorkflow returns the following response:

Type	Description
HTTP Code	HTTP status or error code indicating request success or failure. See HTTP status code definitions for more information.

Examples

The following examples demonstrate typical use of endpoint updateWorkflow:

Request examples

Example cURL request to deactivate workflow ID 14:

curl -X POST -u graze:graze -k \
-v "https://localhost/graze/v1/updateWorkflow" \
-H "Content-Type: application/json; charset=UTF-8" \
--data '{ "id" : 14,"active" :false }'

Example cURL request to rename workflow ID 14:

curl -X POST -u graze:graze -k \
-v "https://localhost/graze/v1/updateWorkflow" \
-H "Content-Type: application/json; charset=UTF-8" \
--data '{ "id" : 14, "workflow_name" : "Deactivated Example" }'

Example cURL request to update the entry filter and sweep-up filter for workflow ID 3:

curl -X POST -u graze:graze -k \
-v "https://localhost/graze/v1/updateWorkflow" \
-H "Content-Type: application/json; charset=UTF-8" \
--data '{ \
    "id" : 3, \
    "entry_filter": "state = 8", \
    "sweep_up_filter": "state = 8" 
 }'

Response example

In this section:

updateWorkflow

Request arguments

Response

Examples

Request examples

Response example

Search results