Workflows

Update a Workflow

PATCH
/v2/workflows/{workflowName}
x-api-key<token>

Authenticate using API Key in request header

In: header

Path Parameters

workflowNamestring
name?string

Name of workflow. Can be updated to rename the workflow. Must be unique within the environment and match the pattern ^[a-zA-Z0-9_-]{1,128}$.

Match^[a-zA-Z0-9_-]{1,128}$
Length1 <= length <= 128
displayName?string

Display name of workflow.

tags?array<string>

Array of tags to categorize and organize workflows.

mainFunction?FunctionIdentifier
relationships?array<WorkflowRequestRelationship>

Response Body

curl -X PATCH "https://api.bem.ai/v2/workflows/string" \  -H "Content-Type: application/json" \  -d '{}'
{
  "workflow": {
    "id": "string",
    "name": "string",
    "versionNum": 0,
    "displayName": "string",
    "emailAddress": "string",
    "tags": [
      "billing",
      "finance",
      "automated"
    ],
    "mainFunction": {
      "id": "string",
      "name": "string",
      "versionNum": 0
    },
    "relationships": [
      {
        "sourceFunction": {
          "id": "string",
          "name": "string",
          "versionNum": 0
        },
        "destinationName": "string",
        "destinationFunction": {
          "id": "string",
          "name": "string",
          "versionNum": 0
        }
      }
    ],
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
  },
  "error": "string"
}