Retrieve a node definition by name

GET 
https://demo.openremote.io/api/master/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

idstring
typestring

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

priorityint32
namestring

position

object

xfloat

yfloat

size

object

xfloat

yfloat

internals

object[]

Array [

namestring

picker

object

typestring

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

options

object[]

Array [

namestring

valueobject

]

valueobject

breakTypestring

Possible values: [NEW_LINE, SPACER]

]

inputs

object[]

Array [

idstring

namestring

typestring

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

nodeIdstring

indexint32

]

outputs

object[]

Array [

idstring

namestring

typestring

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

nodeIdstring

indexint32

]

displayCharacterstring

Example (from schema)

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

Authorization: oauth2

name: openidtype: oauth2flows: {
  "clientCredentials": {
    "tokenUrl": "/auth/realms/master/protocol/openid-connect/token",
    "refreshUrl": "/auth/realms/master/protocol/openid-connect/token",
    "scopes": {
      "profile": "profile"
    }
  },
  "authorizationCode": {
    "authorizationUrl": "/auth/realms/master/protocol/openid-connect/auth",
    "tokenUrl": "/auth/realms/master/protocol/openid-connect/token",
    "refreshUrl": "/auth/realms/master/protocol/openid-connect/token",
    "scopes": {
      "profile": "profile"
    }
  }
}

• curl
• nodejs
• java
• python
• ruby
• csharp
• go
• php
• powershell

• CURL

curl -L 'https://demo.openremote.io/api/master/flow/:name' \
-H 'Authorization: Bearer <token>'

Request Collapse all

Base URL

https://demo.openremote.io/api/master

Auth

Bearer Token

Parameters

name — pathrequired

Authorization — header

X-Forwarded-Proto — header

X-Forwarded-Host — header

ResponseClear

Click the Send API Request button above and see the response here!