Support
Blues.io
Notehub.io
Shop
Support
Blues.io
Notehub.io
Shop
×
HomeReference
Glossary
Notecard Walkthrough
Overview
Notecard Requests & Responses
JSON Fundamentals
Notecard Interfaces
Essential Requests
Time & Location Requests
Inbound Requests & Shared Data
Web Transactions
Low Power Design
Low Bandwidth Design
Host Firmware Update Requests
Advanced Notecard Configuration
Complete API Reference
Introduction
card Requests
dfu Requests
env Requests
file Requestsfile.changesfile.changes.pendingfile.deletefile.stats
hub Requests
note Requests
web Requests

file Requests

The file set of requests enable developers to work with all types of Notefiles.

file.changes

Used to perform queries on a single or multiple files to determine if new Notes are available to read, or if there are unsynced Notes in local Notefiles. Note: This request is a Notefile API request, only. .qo Notes in Notehub are automatically ingested and stored, or sent to applicable Routes.

Arguments

files

array of strings (optional)

One or more files to obtain change information from. Omit to return changes for all Notefiles.

tracker

string (optional)

ID of a change tracker to use to determine changes to Notefiles.

    Response Members

    total

    integer

    The total of local Notes across all Notefiles. This includes Inbound Notes that have not been deleted, as well as outbound Notes that have yet to sync.

    changes

    integer

    If a change tracker is used, the number of changes across all files.

    info

    JSON object

    An object with a key for each Notefile that matched the request parameters, and value object with the changes and total for each file.

    Example Response
    {
      "changes": 5,
      "total": 5,
      "info": {
        "my-settings.db": { "changes": 3, "total": 3 },
        "other-settings.db": { "changes": 2, "total": 2 }
      }
    }
    
    More information:
    • Retrieving Inbound Notes

    • Using a Change Tracker Across Notefiles

    file.changes.pending

    Returns info about file changes that are pending upload to Notehub or download to the Notecard.

    Arguments
    None
      Response Members

      total

      integer

      The total of unsynched notes across all Notefiles.

      changes

      integer

      The number of changes across all files.

      pending

      boolean

      true if there are pending changes.

      info

      JSON object

      An object with a key for each Notefile and value object with the changes and total for each file.

      Example Response
      {
        "total":   3,
        "changes": 3,
        "pending": true,
        "info":   {
          "sensors.qo": {"changes":3,"total":3}
        }
      }
      

      file.delete

      Deletes Notefiles and the Notes they contain.

      Arguments

      files

      array of strings

      One or more files to delete.

        Response Members
        None: an empty object {} means success.

        file.stats

        Gets resource statistics about local Notefiles.

        Arguments
        None
          Response Members

          total

          integer

          The total number of Notes across all Notefiles.

          changes

          integer

          The number of Notes across all Notefiles pending sync.

          sync

          boolean

          true if a sync is recommended based on the number of pending notes.

          Example Response
          {
            "total":   83,
            "changes": 78,
            "sync":    true
          }
          
          env Requestshub Requests
          Can we improve this page? Send us feedbackRate this page
          • ★
            ★
          • ★
            ★
          • ★
            ★
          • ★
            ★
          • ★
            ★
          © 2021 Blues Inc.Terms & ConditionsPrivacy
          blues.ioTwitterLinkedInGitHubHackster.io
          Disconnected
          Disconnected
          Having trouble connecting?

          Try changing your Micro USB cable as some cables do not support transferring data. If that does not solve your problem, contact us at support@blues.com and we will get you set up with another tool to communicate with the Notecard.

          Connect a NotecardClick 'Connect' and select a USB-connected Notecard to start issuing requests from the browser.