NOnotefile
route

GET /v1/projects/{projectOrProductUID}/routes/{routeUID}

Changed on

Get single route within a project

Request

  • Base URL
    https://api.notefile.net
  • URL
    https://api.notefile.net/v1/projects/{projectOrProductUID}/routes/{routeUID}
  • Auth
    HTTP bearer

Path parameters

projectOrProductUIDstring required
routeUIDstring required

Response

Successful operation

disabledboolean
labelstring
modifiedstring date-time
notesstring

Optional free-form text for annotating the route.

typestring

Mirrors hublib.RouteType.

uidstring

Example response

{
  "aws": {
    "filter": {
      "files": [
        "env.qo",
        "motion.qo"
      ],
      "type": "inclusion"
    },
    "transform": {
      "format": "json",
      "jsonata": "$.body.data",
      "jsonata_in": "$.body.data"
    }
  },
  "azure": {
    "filter": {
      "files": [
        "env.qo",
        "motion.qo"
      ],
      "type": "inclusion"
    },
    "transform": {
      "format": "json",
      "jsonata": "$.body.data",
      "jsonata_in": "$.body.data"
    }
  },
  "blynk": {
    "filter": {
      "files": [
        "env.qo",
        "motion.qo"
      ],
      "type": "inclusion"
    },
    "transform": {
      "format": "json",
      "jsonata": "$.body.data",
      "jsonata_in": "$.body.data"
    }
  },
  "datacake": {
    "filter": {
      "files": [
        "env.qo",
        "motion.qo"
      ],
      "type": "inclusion"
    },
    "transform": {
      "format": "json",
      "jsonata": "$.body.data",
      "jsonata_in": "$.body.data"
    }
  },
  "google": {
    "filter": {
      "files": [
        "env.qo",
        "motion.qo"
      ],
      "type": "inclusion"
    },
    "transform": {
      "format": "json",
      "jsonata": "$.body.data",
      "jsonata_in": "$.body.data"
    }
  },
  "http": {
    "filter": {
      "files": [
        "env.qo",
        "motion.qo"
      ],
      "type": "inclusion"
    },
    "transform": {
      "format": "json",
      "jsonata": "$.body.data",
      "jsonata_in": "$.body.data"
    }
  },
  "mqtt": {
    "filter": {
      "files": [
        "env.qo",
        "motion.qo"
      ],
      "type": "inclusion"
    },
    "transform": {
      "format": "json",
      "jsonata": "$.body.data",
      "jsonata_in": "$.body.data"
    }
  },
  "proxy": {
    "transform": {
      "format": "json",
      "jsonata": "$.body.data",
      "jsonata_in": "$.body.data"
    }
  },
  "qubitro": {
    "filter": {
      "files": [
        "env.qo",
        "motion.qo"
      ],
      "type": "inclusion"
    },
    "transform": {
      "format": "json",
      "jsonata": "$.body.data",
      "jsonata_in": "$.body.data"
    }
  },
  "s3archive": {
    "filter": {
      "files": [
        "env.qo",
        "motion.qo"
      ],
      "type": "inclusion"
    },
    "transform": {
      "format": "json",
      "jsonata": "$.body.data",
      "jsonata_in": "$.body.data"
    }
  },
  "slack": {
    "filter": {
      "files": [
        "env.qo",
        "motion.qo"
      ],
      "type": "inclusion"
    },
    "transform": {
      "format": "json",
      "jsonata": "$.body.data",
      "jsonata_in": "$.body.data"
    }
  },
  "snowflake": {
    "filter": {
      "files": [
        "env.qo",
        "motion.qo"
      ],
      "type": "inclusion"
    },
    "transform": {
      "format": "json",
      "jsonata": "$.body.data",
      "jsonata_in": "$.body.data"
    }
  },
  "snowpipe_streaming": {
    "filter": {
      "files": [
        "env.qo",
        "motion.qo"
      ],
      "type": "inclusion"
    },
    "transform": {
      "format": "json",
      "jsonata": "$.body.data",
      "jsonata_in": "$.body.data"
    }
  },
  "thingworx": {
    "filter": {
      "files": [
        "env.qo",
        "motion.qo"
      ],
      "type": "inclusion"
    },
    "transform": {
      "format": "json",
      "jsonata": "$.body.data",
      "jsonata_in": "$.body.data"
    }
  },
  "twilio": {
    "filter": {
      "files": [
        "env.qo",
        "motion.qo"
      ],
      "type": "inclusion"
    }
  }
}

Changes

  • 1887e880199aRevision changes
    • breaking

      the response's body type changed from no type to object for status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • 51c5a4cd5212Revision changes
    • info

      added the optional property / to the response with the status