Flow

Operations for managing data flows

flowCreate

post

https://api.eu.navixy.com/v2https://api.us.navixy.com/v2

/iot/logic/flow/create

Create a new data flow.

Authorizations

api_key

AuthorizationstringRequired

Enter an API key with the "NVX: " prefix, e.g. "NVX 123456abcdefg"

Body

application/json

Responses

200

Successful creation response

application/json

default

Error response object

application/json

post

/iot/logic/flow/create

HTTPcURLJavaScriptPython

POST /v2/iot/logic/flow/create HTTP/1.1
Host: api.eu.navixy.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 240

{
  "flow": {
    "title": "Super flow",
    "enabled": true,
    "nodes": [
      {
        "id": 1,
        "type": "data_source",
        "data": {
          "title": "Standard Data Source",
          "source_ids": [
            123458,
            123459
          ]
        },
        "view": {
          "position": {
            "x": 25,
            "y": 25
          }
        }
      }
    ],
    "edges": [
      {
        "from": 1,
        "to": 2,
        "type": "simple_edge"
      }
    ]
  }
}

{
  "success": true,
  "id": 1723
}

flowRead

get

https://api.eu.navixy.com/v2https://api.us.navixy.com/v2

/iot/logic/flow/read

Read an existing flow details.

Authorizations

api_key

AuthorizationstringRequired

Enter an API key with the "NVX: " prefix, e.g. "NVX 123456abcdefg"

Query parameters

flow_idintegerRequired

Flow ID

Example: 12

Responses

200

Successful response to read a flow

application/json

default

Error response object

application/json

get

/iot/logic/flow/read

HTTPcURLJavaScriptPython

GET /v2/iot/logic/flow/read?flow_id=12 HTTP/1.1
Host: api.eu.navixy.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "value": {
    "id": 543,
    "title": "Super flow",
    "description": null,
    "enabled": true,
    "default_flow": false,
    "nodes": [
      {
        "id": 1,
        "type": "data_source",
        "data": {
          "title": "Standard Data Source",
          "source_ids": [
            123458,
            123459
          ]
        },
        "view": {
          "position": {
            "x": 25,
            "y": 25
          }
        }
      }
    ],
    "edges": [
      {
        "from": 1,
        "to": 2,
        "type": "simple_edge"
      }
    ]
  }
}

flowUpdate

post

https://api.eu.navixy.com/v2https://api.us.navixy.com/v2

/iot/logic/flow/update

Update details of an existing flow.

Authorizations

api_key

AuthorizationstringRequired

Enter an API key with the "NVX: " prefix, e.g. "NVX 123456abcdefg"

Body

application/json

flowall ofRequired

Flowchart object

Responses

200

Successful response

application/json

default

Error response object

application/json

post

/iot/logic/flow/update

HTTPcURLJavaScriptPython

POST /v2/iot/logic/flow/update HTTP/1.1
Host: api.eu.navixy.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 240

{
  "flow": {
    "title": "Super flow",
    "enabled": true,
    "nodes": [
      {
        "id": 1,
        "type": "data_source",
        "data": {
          "title": "Standard Data Source",
          "source_ids": [
            123458,
            123459
          ]
        },
        "view": {
          "position": {
            "x": 25,
            "y": 25
          }
        }
      }
    ],
    "edges": [
      {
        "from": 1,
        "to": 2,
        "type": "simple_edge"
      }
    ]
  }
}

{
  "success": true
}

flowDelete

post

https://api.eu.navixy.com/v2https://api.us.navixy.com/v2

/iot/logic/flow/delete

Delete a flow.

Authorizations

api_key

AuthorizationstringRequired

Enter an API key with the "NVX: " prefix, e.g. "NVX 123456abcdefg"

Body

application/json

flow_idintegerRequired

Flow ID

Example: 12

Responses

200

Successful response to delete a flow

application/json

default

Error response object

application/json

post

/iot/logic/flow/delete

HTTPcURLJavaScriptPython

POST /v2/iot/logic/flow/delete HTTP/1.1
Host: api.eu.navixy.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 14

{
  "flow_id": 12
}

{
  "success": true
}

flowList

get

https://api.eu.navixy.com/v2https://api.us.navixy.com/v2

/iot/logic/flow/list

Get list of flows existing in a user account.

Authorizations

api_key

AuthorizationstringRequired

Enter an API key with the "NVX: " prefix, e.g. "NVX 123456abcdefg"

Responses

200

Successful response to read a list of flows

application/json

default

Error response object

application/json

get

/iot/logic/flow/list

HTTPcURLJavaScriptPython

GET /v2/iot/logic/flow/list HTTP/1.1
Host: api.eu.navixy.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "list": [
    {
      "id": 1234,
      "title": "Super flow"
    }
  ]
}