Find Flow by ID

Returns a single Flow by its ID, if the user is authorized to see it. This requires the 'flows.read' permission

Responses

🟢200OK

application/json

Returns the flow

Body

data

object (Flow)

optional

name

string

required

Example:

SnazzyToCodeComponent

description

string

optional

Example:

This flow polls for persons and posts them on webhoo.site.

tenant

string

optional

graph

object

FlowGraph

required

type

enum<string>

required

Flow type

Allowed values:

ordinaryrealtime

Example:

ordinary

cron

string

optional

A cron string describing the interval at which this flow is run. If unset, the flow uses webhooks instead

Example:

* /2 * * * *

owners

array[object (Owner) {2}]

optional

string

required

status

enum<string>

optional

Flow status, set automatically in response to start/stop commands

Allowed values:

activeinactivestartingstopping

Example:

inactive

createdAt

string <date-time>

required

Timestamp of flow creation

Example:

2019-07-30T12:52:45.957Z

updatedAt

string <date-time>

required

Timestamp of most recent flow update

Example:

2019-07-30T12:52:45.957Z

meta

object

optional

Example

{
    "data": {
        "name": "SnazzyToCodeComponent",
        "description": "This flow polls for persons and posts them on webhoo.site.",
        "tenant": "string",
        "graph": {
            "nodes": [
                [
                    {
                        "id": "step_1",
                        "componentId": "string",
                        "name": "snazzy adapter for oih",
                        "function": "getPersonsPolling",
                        "description": "New description in progress"
                    },
                    {
                        "id": "step_2",
                        "componentId": "string",
                        "name": "code_component",
                        "function": "execute",
                        "description": "",
                        "fields": {
                            "code": "function* run() {console.log('Calling external URL');yield request.post({uri: 'http://webhook.site/debc8244-3ca0-4449-af2b-e346c4f57b85', body: msg.body, json: true});}"
                        }
                    }
                ]
            ],
            "edges": [
                {
                    "id": "string",
                    "config": {
                        "condition": "string",
                        "mapper": {}
                    },
                    "source": "step_1",
                    "target": "step_2"
                }
            ]
        },
        "type": "ordinary",
        "cron": "* /2 * * * *",
        "owners": [
            {
                "id": "string",
                "type": "string"
            }
        ],
        "id": "string",
        "status": "active",
        "createdAt": "2019-07-30T12:52:45.957Z",
        "updatedAt": "2019-07-30T12:52:45.957Z"
    },
    "meta": {}
}

🟠404Record Not Found

Request

Request samples

Responses