Retrieve a node definition by name

GET 
/flow/:name

Retrieve a node definition by name

Request

Path Parameters

name stringrequired

Header Parameters

Authorization string
X-Forwarded-Proto string
X-Forwarded-Host string

Responses

default

default response

application/json

Schema

Schema

id string
type string

Possible values: [INPUT, PROCESSOR, OUTPUT, THEN]

name string

position

object

x float

y float

size

object

x float

y float

internals

object[]

Array [

name string

picker

object

type string

Possible values: [TEXT, MULTILINE, NUMBER, DROPDOWN, DOUBLE_DROPDOWN, CHECKBOX, ASSET_ATTRIBUTE, COLOR]

options

object[]

Array [

name string

value object

]

value object

]

inputs

object[]

Array [

id string

name string

type string

Possible values: [NUMBER, STRING, BOOLEAN, TRIGGER, COLOR, ANY]

nodeId string

index int32

]

outputs

object[]

Array [

id string

name string

type string

Possible values: [NUMBER, STRING, BOOLEAN, TRIGGER, COLOR, ANY]

nodeId string

index int32

]

displayCharacter string

Example (from schema)

{
  "id": "string",
  "type": "INPUT",
  "name": "string",
  "position": {
    "x": 0,
    "y": 0
  },
  "size": {
    "x": 0,
    "y": 0
  },
  "internals": [
    {
      "name": "string",
      "picker": {
        "type": "TEXT",
        "options": [
          {
            "name": "string",
            "value": {}
          }
        ]
      },
      "value": {}
    }
  ],
  "inputs": [
    {
      "id": "string",
      "name": "string",
      "type": "NUMBER",
      "nodeId": "string",
      "index": 0
    }
  ],
  "outputs": [
    {
      "id": "string",
      "name": "string",
      "type": "NUMBER",
      "nodeId": "string",
      "index": 0
    }
  ],
  "displayCharacter": "string"
}

Loading...