Sign in
Flows

Update a complete namespace from yaml source

Changed on

All flow will be created / updated for this namespace. Flow that already created but not in flows will be deleted if the query delete is true

post/api/v1/{tenant}/flows/{namespace}

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/v1/{tenant}/flows/{namespace}
  • Auth: one of:
    • HTTP bearer
    • HTTP basic

Path parameters

namespacestring required

The flow namespace

tenantstring required

Query parameters

deleteboolean required

If missing flow should be deleted

overrideboolean required

If namespace of all provided flows should be overridden

Response

updateFlowsInNamespace 200 response

idstring
namespacestring
revisioninteger
tenantIdstring
deletedboolean
descriptionstring
disabledboolean
variablesobject
sourcestring

Example response

[
  {
    "outputs": [
      {
        "displayName": "displayName",
        "description": "description",
        "id": "id",
        "type": "STRING",
        "value": "{}",
        "required": true
      },
      {
        "displayName": "displayName",
        "description": "description",
        "id": "id",
        "type": "STRING",
        "value": "{}",
        "required": true
      }
    ],
    "variables": {
      "key": "{}"
    },
    "inputs": [
      {
        "dependsOn": "",
        "defaults": "",
        "displayName": "displayName",
        "prefill": "",
        "description": "description",
        "id": "id",
        "type": "",
        "required": true
      },
      {
        "dependsOn": "",
        "defaults": "",
        "displayName": "displayName",
        "prefill": "",
        "description": "description",
        "id": "id",
        "type": "",
        "required": true
      }
    ],
    "description": "description",
    "sla": [
      {
        "id": "id",
        "type": "MAX_DURATION",
        "behavior": "FAIL",
        "labels": [
          "SLA_labels",
          "SLA_labels"
        ]
      },
      {
        "id": "id",
        "type": "MAX_DURATION",
        "behavior": "FAIL",
        "labels": [
          "SLA_labels",
          "SLA_labels"
        ]
      }
    ],
    "source": "source",
    "revision": 0,
    "labels": [
      {
        "value": "value",
        "key": "key"
      },
      {
        "value": "value",
        "key": "key"
      }
    ],
    "concurrency": {
      "limit": 1,
      "behavior": "QUEUE"
    },
    "deleted": true,
    "namespace": "namespace",
    "tenantId": "tenantId",
    "disabled": true,
    "id": "id",
    "workerGroup": {
      "fallback": "FAIL",
      "key": "key"
    }
  }
]

Changes

  • b6097dbc46aeRevision changes
    • info

      added to the response property allOf list for the response status

    • info

      removed from the response property allOf list for the response status

  • f5eab92a5b09Revision changes
    • breaking

      added the new required query request parameter override