Route API

curl -X GET
    -L 'https://api.notefile.net/v1/projects/<projectUID>/routes'
    -H 'Authorization: Bearer <access_token>'

import * as NotehubJs from "@blues-inc/notehub-js";
let defaultClient = NotehubJs.ApiClient.instance;
// Configure API key authorization: api_key
let api_key = defaultClient.authentications["api_key"];
api_key.apiKey = "YOUR API KEY";

let apiInstance = new NotehubJs.RouteApi();
let projectUID = "app:2606f411-dea6-44a0-9743-1130f57d77d8"; // String |
apiInstance.getRoutes(projectUID).then(
  (data) => {
    console.log(
      "API called successfully. Returned data: " + JSON.stringify(data)
    );
  },
  (error) => {
    console.error(error);
  }
);

import notehub_py
from notehub_py.models.user_db_route import UserDbRoute
from notehub_py.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.notefile.net
configuration = notehub_py.Configuration(
    host = "https://api.notefile.net"
)

# Configure API key authorization: api_key
configuration.api_key["api_key"] = os.environ["API_KEY"]

# Enter a context with an instance of the API client
with notehub_py.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = notehub_py.RouteApi(api_client)
    project_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | 

    try:
        api_response = api_instance.get_routes(project_uid)
        print("The response of RouteApi->get_routes:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RouteApi->get_routes: %s\n" % e)

curl -X GET
    -L 'https://api.notefile.net/v1/projects/<projectUID>/routes/<routeUID>'
    -H 'Authorization: Bearer <access_token>'

import * as NotehubJs from "@blues-inc/notehub-js";
let defaultClient = NotehubJs.ApiClient.instance;
// Configure API key authorization: api_key
let api_key = defaultClient.authentications["api_key"];
api_key.apiKey = "YOUR API KEY";

let apiInstance = new NotehubJs.RouteApi();
let projectUID = "app:2606f411-dea6-44a0-9743-1130f57d77d8"; // String |
let routeUID = "route:cbd20093cba58392c9f9bbdd0cdeb1a0"; // String |
apiInstance.getRoute(projectUID, routeUID).then((data) => {
  console.log("API called successfully. Returned data: " + JSON.stringify(data));
}, (error) => {
  console.error(error);
});

import notehub_py
from notehub_py.models.notehub_route import NotehubRoute
from notehub_py.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.notefile.net
configuration = notehub_py.Configuration(
    host = "https://api.notefile.net"
)

# Configure API key authorization: api_key
configuration.api_key["api_key"] = os.environ["API_KEY"]

# Enter a context with an instance of the API client
with notehub_py.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = notehub_py.RouteApi(api_client)
    project_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | 
    route_uid = "route:cbd20093cba58392c9f9bbdd0cdeb1a0" # str | 

    try:
        api_response = api_instance.get_route(project_uid, route_uid)
        print("The response of RouteApi->get_route:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RouteApi->get_route: %s\n" % e)

curl -X GET
    -L 'https://api.notefile.net/v1/projects/<projectUID>/routes/<routeUID>/route-logs'
    -H 'Authorization: Bearer <access_token>'

import * as NotehubJs from "@blues-inc/notehub-js";
let defaultClient = NotehubJs.ApiClient.instance;
// Configure API key authorization: api_key
let api_key = defaultClient.authentications["api_key"];
api_key.apiKey = "YOUR API KEY";

let apiInstance = new NotehubJs.RouteApi();
let projectUID = "app:2606f411-dea6-44a0-9743-1130f57d77d8"; // String |
let routeUID = "route:cbd20093cba58392c9f9bbdd0cdeb1a0"; // String |
let opts = {
  pageSize: 50, // Number |
  pageNum: 1, // Number |
  deviceUID: ["null"], // [String] | A Device UID.
  sortBy: "captured", // String |
  sortOrder: "asc", // String |
  startDate: 1628631763, // Number | Unix timestamp
  endDate: 1657894210, // Number | Unix timestamp
  systemFilesOnly: true, // Boolean |
  files: "_health.qo, data.qo" // String |
};
apiInstance.getRouteLogsByRoute(projectUID, routeUID, opts).then((data) => {
  console.log("API called successfully. Returned data: " + JSON.stringify(data));
}, (error) => {
  console.error(error);
});

import notehub_py
from notehub_py.models.get_route_logs_by_route200_response_inner import GetRouteLogsByRoute200ResponseInner
from notehub_py.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.notefile.net
configuration = notehub_py.Configuration(
    host = "https://api.notefile.net"
)

# Configure API key authorization: api_key
configuration.api_key["api_key"] = os.environ["API_KEY"]

# Enter a context with an instance of the API client
with notehub_py.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = notehub_py.RouteApi(api_client)
    project_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | 
    route_uid = "route:cbd20093cba58392c9f9bbdd0cdeb1a0" # str | 
    page_size = 50 # int |  (optional) (default to 50)
    page_num = 1 # int |  (optional) (default to 1)
    device_uid = ["device_uid_example"] # List[str] | A Device UID. (optional)
    sort_by = "captured" # str |  (optional) (default to "captured")
    sort_order = "asc" # str |  (optional) (default to "asc")
    start_date = 1628631763 # int | Unix timestamp (optional)
    end_date = 1657894210 # int | Unix timestamp (optional)
    system_files_only = True # bool |  (optional)
    files = "_health.qo, data.qo" # str |  (optional)

    try:
        api_response = api_instance.get_route_logs_by_route(project_uid, route_uid, page_size=page_size, page_num=page_num, device_uid=device_uid, sort_by=sort_by, sort_order=sort_order, start_date=start_date, end_date=end_date, system_files_only=system_files_only, files=files)
        print("The response of RouteApi->get_route_logs_by_route:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RouteApi->get_route_logs_by_route: %s\n" % e)

curl -X GET
     -L 'https://api.notefile.net/v1/projects/<projectUID>/routes/<routeUID>/route-logs?pageSize=<pageSize>&pageNum=<pageNum>&deviceUID=<deviceUID>&sortBy=<sortBy>&sortOrder=<sortOrder>&startDate=<startDate>&endDate=<endDate>&systemFilesOnly=<systemFilesOnly>&files=<files>'
     -H 'Authorization: Bearer <access_token>'

curl -X POST
    -L 'https://api.notefile.net/v1/projects/<projectUID>/routes'
    -H 'Authorization: Bearer <access_token>'
    -d '{
            "label":"<label>",
            "type":"<type>",
            "<schema>":{
              "url":"<url>"
            }
        }'

import * as NotehubJs from "@blues-inc/notehub-js";
let defaultClient = NotehubJs.ApiClient.instance;
// Configure API key authorization: api_key
let api_key = defaultClient.authentications["api_key"];
api_key.apiKey = "YOUR API KEY";

let apiInstance = new NotehubJs.RouteApi();
let projectUID = "app:2606f411-dea6-44a0-9743-1130f57d77d8"; // String |
let notehubRoute = {
  label: "Route Label",
  type: "http",
  http: {
    fleets: ["fleet:1042ddc5-3b2c-4cec-b1fb-d3040538094d"],
    throttle_ms: 100,
    url: "http://route.url",
  },
}; // NotehubRoute | Route to be Created
apiInstance.createRoute(projectUID, notehubRoute).then(
  (data) => {
    console.log(
      "API called successfully. Returned data: " + JSON.stringify(data)
    );
  },
  (error) => {
    console.error(error);
  }
);

import notehub_py
from notehub_py.models.notehub_route import NotehubRoute
from notehub_py.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.notefile.net
configuration = notehub_py.Configuration(
    host = "https://api.notefile.net"
)

# Configure API key authorization: api_key
configuration.api_key["api_key"] = os.environ["API_KEY"]

# Enter a context with an instance of the API client
with notehub_py.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = notehub_py.RouteApi(api_client)
    project_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | 
    notehub_route = {
        "label": "Route Label",
        "type":"http",
        "http": {
            "fleets": ["fleet:1042ddc5-3b2c-4cec-b1fb-d3040538094d"],
            "throttle_ms": 100,
            "url": "http://route.url"
        }
    }
    # NotehubRoute | Route to be Created
    try:
        api_response = api_instance.create_route(project_uid, notehub_route)
        print("The response of RouteApi->create_route:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RouteApi->create_route: %s\n" % e)

curl -X DELETE
     -L 'https://api.notefile.net/v1/projects/<projectUID>/routes/<routeUID>'
     -H 'Authorization: Bearer <access_token>'

import * as NotehubJs from "@blues-inc/notehub-js";
let defaultClient = NotehubJs.ApiClient.instance;
// Configure API key authorization: api_key
let api_key = defaultClient.authentications["api_key"];
api_key.apiKey = "YOUR API KEY";

let apiInstance = new NotehubJs.RouteApi();
let projectUID = "app:2606f411-dea6-44a0-9743-1130f57d77d8"; // String |
let routeUID = "route:cbd20093cba58392c9f9bbdd0cdeb1a0"; // String |
apiInstance.deleteRoute(projectUID, routeUID).then((data) => {
  console.log("API called successfully. Returned data: " + JSON.stringify(data));
}, (error) => {
  console.error(error);
});

import notehub_py
from notehub_py.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.notefile.net
configuration = notehub_py.Configuration(
    host = "https://api.notefile.net"
)

# Configure API key authorization: api_key
configuration.api_key["api_key"] = os.environ["API_KEY"]

# Enter a context with an instance of the API client
with notehub_py.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = notehub_py.RouteApi(api_client)
    project_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | 
    route_uid = "route:cbd20093cba58392c9f9bbdd0cdeb1a0" # str | 

    try:
        api_response = api_instance.delete_route(project_uid, route_uid)
        print("The response of RouteApi->delete_route:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RouteApi->delete_route: %s\n" % e)

curl -X PUT
    -L 'https://api.notefile.net/v1/projects/<projectUID>/routes/<routeUID>'
    -H 'Authorization: Bearer <access_token>'
    -d '{
            "label":"<label>",
            "type":"<type>",
            "<schema>":{
              "url":"<url>"
            }
        }'

import * as NotehubJs from "@blues-inc/notehub-js";
let defaultClient = NotehubJs.ApiClient.instance;
// Configure API key authorization: api_key
let api_key = defaultClient.authentications["api_key"];
api_key.apiKey = "YOUR API KEY";

let apiInstance = new NotehubJs.RouteApi();
let projectUID = "app:2606f411-dea6-44a0-9743-1130f57d77d8"; // String |
let routeUID = "route:cbd20093cba58392c9f9bbdd0cdeb1a0"; // String |
let notehubRoute = {
  http: {
    filter: { 
      type: "include",
      system_notefiles: true,
      files: ["somefile.qo"]
    },
    throttle_ms: 50,
    url: "http://new-route.url",
  },
}; // NotehubRoute | Route settings to be updated
apiInstance.updateRoute(projectUID, routeUID, notehubRoute).then(
  (data) => {
    console.log(
      "API called successfully. Returned data: " + JSON.stringify(data)
    );
  },
  (error) => {
    console.error(error);
  }
);

import notehub_py
from notehub_py.models.notehub_route import NotehubRoute
from notehub_py.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.notefile.net
configuration = notehub_py.Configuration(
    host = "https://api.notefile.net"
)

# Configure API key authorization: api_key
configuration.api_key["api_key"] = os.environ["API_KEY"]

# Enter a context with an instance of the API client
with notehub_py.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = notehub_py.RouteApi(api_client)
    project_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | 
    route_uid = "route:cbd20093cba58392c9f9bbdd0cdeb1a0" # str | 
    notehub_route = {
        "http" {
            "filter": {
            "type": "include",
            "system_notefiles": true,
            "files": ["somefile.qo"],
            },
            "throttle_ms": 50,
            "url": "http://new-route.url",
        },
    }
    # NotehubRoute | Route settings to be updated
    try:
        api_response = api_instance.update_route(project_uid, route_uid, notehub_route)
        print("The response of RouteApi->update_route:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RouteApi->update_route: %s\n" % e)