@datafire/intellifi_nl v3.0.0

@datafire/intellifi_nl

Client library for Brain Web API

Installation and Usage

npm install --save @datafire/intellifi_nl

let intellifi_nl = require('@datafire/intellifi_nl').create({
  CookieSid: "",
  HeaderApiKey: "",
  QueryApiKey: ""
});

.then(data => {
  console.log(data);
});

Description

This document describes the Intellifi Brain Web API specification using the OpenAPI specification.

The Brain Web API is a RESTful API that allows you to interact with the Intellifi devices and services in a powerful and simple way. Our end-to-end solution allows you to localize your items/assets based on technologies such as RFID and Bluetooth.

Try it out!

The API can be tried out and tested using the 'api-doc/tryitout' endpoint on this site. This UI allows anyone to visualize and interact with the API’s resources without having any of the implementation logic in place. It’s automatically generated from this Specification, with the visual documentation making it easy for back end implementation and client side consumption.

Authentication

Applications are required to provide some form of authentication to the API for every secured endpoint. The Brain offers two forms of authentication.

• API key (Via an HTTP request header or URL parameter)
• Session cookie

See also

• About Intellifi and what we do: intellifi.nl
• Technical and background information: intellifi.zendesk.com

Actions

getAuthinfo

Authentication information

intellifi_nl.getAuthinfo(null, context)

Input

This action has no parameters

Output

• output object
  • api_key_id string: Reference to the static API key (/api/keys) used to authenticate this request (when auth_method=static_api_key)
  • auth_method string (values: user_session, internal, static_api_key): What kind of authentication was used
  • authenticated boolean: Whether or not you are authenticated
  • permissions object
    • mutate boolean: Whether or not this session can mutate resources
  • url Url
  • user_id string: Reference to the user account (/api/users) used to authenticate this request (when auth_method=user_session)

getBlobs

Get all binary large objects (blob)

intellifi_nl.getBlobs({}, context)

Input

• input object
  • after string: Limits on time_created, exclusive.
  • after_id string: Limits directly on id excludes the given id value, please note that id is chronological.
  • before string: Limits on time_created, exclusive.
  • before_id string: Limits directly on id excludes the given id value, please note that id is chronological.
  • from string: Limits on time_created, inclusive.
  • from_id string: Limits on id, includes the given id value.
  • id_only boolean: Removes url fields from output and shows _id instead of _url in references.
  • limit integer: Sets the maximum number of returned resources. You may increase this number to large values, keep in mind that query times could become large. We advise you to use the pagination feature whenever you can.
  • populate string: Expand a reference into the actual resource (lookup). You may add multiple fields by giving a comma separated value.
  • results_only boolean: Removes response envelope with information about query, only sends back a JSON array with the applicable resources.
  • sort string: Allows you to sort on on or more fields in the resource. You may append a minus sign (-) to request reverse order (new to old).
  • until string: Limits on time_created, inclusive.
  • until_id string: Limits on id, includes the given id value.
  • timeout_s number: Overrides the default query timeout (in seconds). A value of 0 means unlimited. IMPORTANT: using high timeouts in production code is strongly discouraged as it may lead to stability issues.
  • id string: unique identifier
  • time_created string: Filter on the time the resource was created.
  • time_updated string: Filter on the time the resource was last updated
  • hash string: Filter based on the hash of the blob.
  • blob_key string: Filter based on the unique blob_key
  • content_type string: Filter based on the content type of the blob.
  • filename string: Filter based on the filename of the blob.
  • time_last_accessed string: Filter based on the last time the blob was accessed

Output

• output
  • count integer: The maximum number of items in the response (as set in the query or by default).
  • count_current integer: The maximum number of items available to return.
  • is_limited boolean: Becomes false when the number of results is smaller than limit.
  • next_url string: URL to the next page of items. ( null if none)
  • query_duration_ms integer: Amount of time, in milliseconds, the request needed to complete.
  • url Url
  • results array
    • items Blob

addBlob

Create binary large object (blob) metadata

intellifi_nl.addBlob({
  "body": {}
}, context)

Input

• input object
  • body required Blob

Output

• output ResponseDefaultResource

deleteBlob

Delete binary large object (blob)

intellifi_nl.deleteBlob({
  "id": ""
}, context)

Input

• input object
  • id required string: Unique identifier

Output

• output ResponseDefaultResource

getBlobMetadataById

Get binary large object (blob)

intellifi_nl.getBlobMetadataById({
  "id": ""
}, context)

Input

• input object
  • id required string: Unique identifier

Output

• output Blob

getBlobById

Download a binary large object (blob)

intellifi_nl.getBlobById({
  "id": "",
  "filename": ""
}, context)

Input

• input object
  • id required string: Unique identifier
  • filename required string: Filename of the blob.

Output

• output string

uploadBlobById

Create binary large object (blob)

intellifi_nl.uploadBlobById({
  "id": ""
}, context)

Input

• input object
  • id required string: Unique identifier

Output

Output schema unknown

getEvents

Get all events

intellifi_nl.getEvents({}, context)

Input

• input object
  • after string: Limits on time_created, exclusive.
  • after_id string: Limits directly on id excludes the given id value, please note that id is chronological.
  • before string: Limits on time_created, exclusive.
  • before_id string: Limits directly on id excludes the given id value, please note that id is chronological.
  • from string: Limits on time_created, inclusive.
  • from_id string: Limits on id, includes the given id value.
  • id_only boolean: Removes url fields from output and shows _id instead of _url in references.
  • limit integer: Sets the maximum number of returned resources. You may increase this number to large values, keep in mind that query times could become large. We advise you to use the pagination feature whenever you can.
  • populate string: Expand a reference into the actual resource (lookup). You may add multiple fields by giving a comma separated value.
  • results_only boolean: Removes response envelope with information about query, only sends back a JSON array with the applicable resources.
  • sort string: Allows you to sort on on or more fields in the resource. You may append a minus sign (-) to request reverse order (new to old).
  • until string: Limits on time_created, inclusive.
  • until_id string: Limits on id, includes the given id value.
  • timeout_s number: Overrides the default query timeout (in seconds). A value of 0 means unlimited. IMPORTANT: using high timeouts in production code is strongly discouraged as it may lead to stability issues.
  • id string: unique identifier
  • time_created string: Filter on the time the resource was created.
  • topic.resource_type string (values: blobs, items, keys, kvpairs, locations, presences, services, spots, subscriptions, users): Filter on the topic resource type
  • topic.action string (values: created, updated, deleted, disappeared, connection-rssi-changed): Filter on the topic action
  • topic.resource string: Filter on the topic resource id
  • time_event string: Filter on the time the event was generated on the device.
  • time_expire string: Filter on the time the event will expire.

Output

• output
  • count integer: The maximum number of items in the response (as set in the query or by default).
  • count_current integer: The maximum number of items available to return.
  • is_limited boolean: Becomes false when the number of results is smaller than limit.
  • next_url string: URL to the next page of items. ( null if none)
  • query_duration_ms integer: Amount of time, in milliseconds, the request needed to complete.
  • url Url
  • results array
    • items Event

getEventById

Get event

intellifi_nl.getEventById({
  "id": ""
}, context)

Input

• input object
  • id required string: Unique identifier

Output

• output Event

getItems

Get all items

intellifi_nl.getItems({}, context)

Input

• input object
  • after string: Limits on time_created, exclusive.
  • after_id string: Limits directly on id excludes the given id value, please note that id is chronological.
  • after_code string: Limits directly on code_hex, sets the start of the range, use before_code to set the end, excludes the given code value.
  • before string: Limits on time_created, exclusive.
  • before_id string: Limits directly on id excludes the given id value, please note that id is chronological.
  • before_code string: Limits directly on code_hex, sets the end of the range, use after_code to set the start, excludes the given code value.
  • from string: Limits on time_created, inclusive.
  • from_id string: Limits on id, includes the given id value.
  • from_code string: Limits on code_hex, sets the start of the range, use until_code to set the end, includes the given code value.
  • id_only boolean: Removes url fields from output and shows _id instead of _url in references.
  • limit integer: Sets the maximum number of returned resources. You may increase this number to large values, keep in mind that query times could become large. We advise you to use the pagination feature whenever you can.
  • populate string: Expand a reference into the actual resource (lookup). You may add multiple fields by giving a comma separated value.
  • results_only boolean: Removes response envelope with information about query, only sends back a JSON array with the applicable resources.
  • sort string: Allows you to sort on on or more fields in the resource. You may append a minus sign (-) to request reverse order (new to old).
  • until string: Limits on time_created, inclusive.
  • until_id string: Limits on id, includes the given id value.
  • timeout_s number: Overrides the default query timeout (in seconds). A value of 0 means unlimited. IMPORTANT: using high timeouts in production code is strongly discouraged as it may lead to stability issues.
  • until_code string: Limits on code_hex, sets the end of the range, use from_code to set the start, includes the given code value.
  • id string: unique identifier
  • time_created string: Filter on the time the resource was created.
  • time_updated string: Filter on the time the resource was last updated
  • code_hex string: Filter based on the hexadecimal string representation of the item. Supports wildcards: *.
  • custom string: Filter based on the custom value. Supports wildcards: *
  • is_present boolean: Only show items which are present of not.
  • label string: Filter based on the label value. Supports wildcards: *
  • location string: Filter based on the location
  • metadata string: Filter based on metadata. Does a partial match on any value in the metadata object. It is also possible to do an exact/wildcard match on specific properties, e.g. metadata.foo=bar
  • move_count integer: Filter based on move count
  • protocol string (values: altbeacon, uniwear, nfc, generic, eddystone, epcgen2, ibeacon, nanoble): Filter based on the detected protocol of an item.
  • sets string: Filter based on the set the resource is in.
  • technology string (values: bluetooth, optical, rfid): Filter based on the detected technology of an item.
  • text string: Filter based on a full text search. Searched properties depend on the resource type. Matches on any of the given words. Supports quote (exact words) and minus (exclude) operators.
  • time_last_present string: Filter based on the time last present
  • time_moved string: Filter based on time last moved
  • type string (values: barcode, bluetitan, gbtag, relay, smarttag, tag): Filter based on the type of an item.

Output

• output
  • count integer: The maximum number of items in the response (as set in the query or by default).
  • count_current integer: The maximum number of items available to return.
  • is_limited boolean: Becomes false when the number of results is smaller than limit.
  • next_url string: URL to the next page of items. ( null if none)
  • query_duration_ms integer: Amount of time, in milliseconds, the request needed to complete.
  • url Url
  • results array
    • items Item

addItem

Create item

intellifi_nl.addItem({
  "body": null
}, context)

Input

• input object
  • body required Item

Output

• output ResponseDefaultResource

deleteItem

Delete item

intellifi_nl.deleteItem({
  "id": ""
}, context)

Input

• input object
  • id required string: Unique identifier

Output

• output ResponseDefaultResource

getItemById

Get item

intellifi_nl.getItemById({
  "id": ""
}, context)

Input

• input object
  • id required string: Unique identifier

Output

• output Item

updateItem

Update existing item

intellifi_nl.updateItem({
  "id": "",
  "body": {}
}, context)

Input

• input object
  • id required string: Unique identifier
  • body required ItemUpdate

Output

• output ResponseDefaultResource

getKeys

Can only be used by an administrative user.

intellifi_nl.getKeys({}, context)

Input

• input object
  • after string: Limits on time_created, exclusive.
  • after_id string: Limits directly on id excludes the given id value, please note that id is chronological.
  • before string: Limits on time_created, exclusive.
  • before_id string: Limits directly on id excludes the given id value, please note that id is chronological.
  • from string: Limits on time_created, inclusive.
  • from_id string: Limits on id, includes the given id value.
  • id_only boolean: Removes url fields from output and shows _id instead of _url in references.
  • limit integer: Sets the maximum number of returned resources. You may increase this number to large values, keep in mind that query times could become large. We advise you to use the pagination feature whenever you can.
  • populate string: Expand a reference into the actual resource (lookup). You may add multiple fields by giving a comma separated value.
  • results_only boolean: Removes response envelope with information about query, only sends back a JSON array with the applicable resources.
  • sort string: Allows you to sort on on or more fields in the resource. You may append a minus sign (-) to request reverse order (new to old).
  • until string: Limits on time_created, inclusive.
  • until_id string: Limits on id, includes the given id value.
  • timeout_s number: Overrides the default query timeout (in seconds). A value of 0 means unlimited. IMPORTANT: using high timeouts in production code is strongly discouraged as it may lead to stability issues.
  • id string: unique identifier
  • time_created string: Filter on the time the resource was created.
  • time_updated string: Filter on the time the resource was last updated
  • secret string: Filter on the secret token.
  • label string: Filter on the label.
  • is_read_only boolean: Filter on read only status.

Output

• output
  • count integer: The maximum number of items in the response (as set in the query or by default).
  • count_current integer: The maximum number of items available to return.
  • is_limited boolean: Becomes false when the number of results is smaller than limit.
  • next_url string: URL to the next page of items. ( null if none)
  • query_duration_ms integer: Amount of time, in milliseconds, the request needed to complete.
  • url Url
  • results array
    • items Key

addKey

Can only be used by an administrative user.

intellifi_nl.addKey({
  "body": {}
}, context)

Input

• input object
  • body required Key

Output

• output ResponseDefaultResource

deleteKey

Can only be used by an administrative user.

intellifi_nl.deleteKey({
  "id": ""
}, context)

Input

• input object
  • id required string: Unique identifier

Output

• output ResponseDefaultResource

getKeyById

Can only be used by an administrative user.

intellifi_nl.getKeyById({
  "id": ""
}, context)

Input

• input object
  • id required string: Unique identifier

Output

• output Key

updateKey

Can only be used by an administrative user.

intellifi_nl.updateKey({
  "id": "",
  "body": {}
}, context)

Input

• input object
  • id required string: Unique identifier
  • body required Key

Output

• output ResponseDefaultResource

getKvPairs

Get all key-value pairs

intellifi_nl.getKvPairs({}, context)

Input

• input object
  • after string: Limits on time_created, exclusive.
  • after_id string: Limits directly on id excludes the given id value, please note that id is chronological.
  • before string: Limits on time_created, exclusive.
  • before_id string: Limits directly on id excludes the given id value, please note that id is chronological.
  • from string: Limits on time_created, inclusive.
  • from_id string: Limits on id, includes the given id value.
  • id_only boolean: Removes url fields from output and shows _id instead of _url in references.
  • limit integer: Sets the maximum number of returned resources. You may increase this number to large values, keep in mind that query times could become large. We advise you to use the pagination feature whenever you can.
  • populate string: Expand a reference into the actual resource (lookup). You may add multiple fields by giving a comma separated value.
  • results_only boolean: Removes response envelope with information about query, only sends back a JSON array with the applicable resources.
  • sort string: Allows you to sort on on or more fields in the resource. You may append a minus sign (-) to request reverse order (new to old).
  • until string: Limits on time_created, inclusive.
  • until_id string: Limits on id, includes the given id value.
  • timeout_s number: Overrides the default query timeout (in seconds). A value of 0 means unlimited. IMPORTANT: using high timeouts in production code is strongly discouraged as it may lead to stability issues.
  • id string: unique identifier
  • time_created string: Filter on the time the resource was created.
  • time_updated string: Filter on the time the resource was last updated
  • kv_key string: Filter on the key-value pair key value.

Output

• output
  • count integer: The maximum number of items in the response (as set in the query or by default).
  • count_current integer: The maximum number of items available to return.
  • is_limited boolean: Becomes false when the number of results is smaller than limit.
  • next_url string: URL to the next page of items. ( null if none)
  • query_duration_ms integer: Amount of time, in milliseconds, the request needed to complete.
  • url Url
  • results array
    • items KeyValuePair

addKvPairs

Create key-value pair

intellifi_nl.addKvPairs({
  "body": null
}, context)

Input

• input object
  • body required KeyValuePair

Output

• output ResponseDefaultResource

deleteKvPair

Delete key-value pair

intellifi_nl.deleteKvPair({
  "id": ""
}, context)

Input

• input object
  • id required string: Unique identifier

Output

• output ResponseDefaultResource

getKvPairsById

Get key-value pair

intellifi_nl.getKvPairsById({
  "id": ""
}, context)

Input

• input object
  • id required string: Unique identifier

Output

• output KeyValuePair

updateKvPair

Update existing Key-value pair

intellifi_nl.updateKvPair({
  "id": "",
  "body": {}
}, context)

Input

• input object
  • id required string: Unique identifier
  • body required KeyValuePairUpdate

Output

• output ResponseDefaultResource

getLocationRules

Get all location rules

intellifi_nl.getLocationRules({}, context)

Input

• input object
  • after string: Limits on time_created, exclusive.
  • after_id string: Limits directly on id excludes the given id value, please note that id is chronological.
  • before string: Limits on time_created, exclusive.
  • before_id string: Limits directly on id excludes the given id value, please note that id is chronological.
  • from string: Limits on time_created, inclusive.
  • from_id string: Limits on id, includes the given id value.
  • id_only boolean: Removes url fields from output and shows _id instead of _url in references.
  • limit integer: Sets the maximum number of returned resources. You may increase this number to large values, keep in mind that query times could become large. We advise you to use the pagination feature whenever you can.
  • populate string: Expand a reference into the actual resource (lookup). You may add multiple fields by giving a comma separated value.
  • results_only boolean: Removes response envelope with information about query, only sends back a JSON array with the applicable resources.
  • sort string: Allows you to sort on on or more fields in the resource. You may append a minus sign (-) to request reverse order (new to old).
  • until string: Limits on time_created, inclusive.
  • until_id string: Limits on id, includes the given id value.
  • timeout_s number: Overrides the default query timeout (in seconds). A value of 0 means unlimited. IMPORTANT: using high timeouts in production code is strongly discouraged as it may lead to stability issues.
  • id string: unique identifier
  • time_created string: Filter on the time the resource was created.
  • time_updated string: Filter on the time the resource was last updated
  • label string: Filter based on the label value. Supports wildcards: *
  • type string (values: allow, disallow, disappeared, debounce): Filter based on the type of location rule.
  • enabled boolean: Filter based on the enabled property.

Output

• output
  • count integer: The maximum number of items in the response (as set in the query or by default).
  • count_current integer: The maximum number of items available to return.
  • is_limited boolean: Becomes false when the number of results is smaller than limit.
  • next_url string: URL to the next page of items. ( null if none)
  • query_duration_ms integer: Amount of time, in milliseconds, the request needed to complete.
  • url Url
  • results array
    • items LocationRule

addLocationRule

Create location rule

intellifi_nl.addLocationRule({
  "body": {}
}, context)

Input

• input object
  • body required LocationRuleUpdate

Output

• output ResponseDefaultResource

deleteLocationRule

Delete location rule

intellifi_nl.deleteLocationRule({
  "id": ""
}, context)

Input

• input object
  • id required string: Unique identifier

Output

• output ResponseDefaultResource

getLocationRuleById

Get location rule

intellifi_nl.getLocationRuleById({
  "id": ""
}, context)

Input

• input object
  • id required string: Unique identifier

Output

• output LocationRule

updateLocationRule

Update existing location rule

intellifi_nl.updateLocationRule({
  "id": "",
  "body": {}
}, context)

Input

• input object
  • id required string: Unique identifier
  • body required LocationRuleUpdate

Output

• output ResponseDefaultResource

getLocations

Get all locations

intellifi_nl.getLocations({}, context)

Input

• input object
  • after string: Limits on time_created, exclusive.
  • after_id string: Limits directly on id excludes the given id value, please note that id is chronological.
  • before string: Limits on time_created, exclusive.
  • before_id string: Limits directly on id excludes the given id value, please note that id is chronological.
  • from string: Limits on time_created, inclusive.
  • from_id string: Limits on id, includes the given id value.
  • id_only boolean: Removes url fields from output and shows _id instead of _url in references.
  • limit integer: Sets the maximum number of returned resources. You may increase this number to large values, keep in mind that query times could become large. We advise you to use the pagination feature whenever you can.
  • populate string: Expand a reference into the actual resource (lookup). You may add multiple fields by giving a comma separated value.
  • results_only boolean: Removes response envelope with information about query, only sends back a JSON array with the applicable resources.
  • sort string: Allows you to sort on on or more fields in the resource. You may append a minus sign (-) to request reverse order (new to old).
  • until string: Limits on time_created, inclusive.
  • until_id string: Limits on id, includes the given id value.
  • timeout_s number: Overrides the default query timeout (in seconds). A value of 0 means unlimited. IMPORTANT: using high timeouts in production code is strongly discouraged as it may lead to stability issues.
  • id string: unique identifier
  • time_created string: Filter on the time the resource was created.
  • time_updated string: Filter on the time the resource was last updated
  • custom string: Filter based on the custom value. Supports wildcards: *
  • label string: Filter based on the label value. Supports wildcards: *
  • metadata string: Filter based on metadata. Does a partial match on any value in the metadata object. It is also possible to do an exact/wildcard match on specific properties, e.g. metadata.foo=bar
  • text string: Filter based on a full text search. Searched properties depend on the resource type. Matches on any of the given words. Supports quote (exact words) and minus (exclude) operators.

Output

• output
  • count integer: The maximum number of items in the response (as set in the query or by default).
  • count_current integer: The maximum number of items available to return.
  • is_limited boolean: Becomes false when the number of results is smaller than limit.
  • next_url string: URL to the next page of items. ( null if none)
  • query_duration_ms integer: Amount of time, in milliseconds, the request needed to complete.
  • url Url
  • results array
    • items Location

addLocation

Create location

intellifi_nl.addLocation({
  "body": {}
}, context)

Input

• input object
  • body required Location

Output

• output ResponseDefaultResource

deleteLocation

Delete location

intellifi_nl.deleteLocation({
  "id": ""
}, context)

Input

• input object
  • id required string: Unique identifier

Output

• output ResponseDefaultResource

getLocationById

Get location

intellifi_nl.getLocationById({
  "id": ""
}, context)

Input

• input object
  • id required string: Unique identifier

Output

• output Location

updateLocation

Update existing location

intellifi_nl.updateLocation({
  "id": "",
  "body": {}
}, context)

Input

• input object
  • id required string: Unique identifier
  • body required Location

Output

• output ResponseDefaultResource

getPresences

Get all presences

intellifi_nl.getPresences({}, context)

Input

• input object
  • after string: Limits on time_created, exclusive.
  • after_id string: Limits directly on id excludes the given id value, please note that id is chronological.
  • before string: Limits on time_created, exclusive.
  • before_id string: Limits directly on id excludes the given id value, please note that id is chronological.
  • from string: Limits on time_created, inclusive.
  • from_id string: Limits on id, includes the given id value.
  • id_only boolean: Removes url fields from output and shows _id instead of _url in references.
  • limit integer: Sets the maximum number of returned resources. You may increase this number to large values, keep in mind that query times could become large. We advise you to use the pagination feature whenever you can.
  • populate string: Expand a reference into the actual resource (lookup). You may add multiple fields by giving a comma separated value.
  • results_only boolean: Removes response envelope with information about query, only sends back a JSON array with the applicable resources.
  • sort string: Allows you to sort on on or more fields in the resource. You may append a minus sign (-) to request reverse order (new to old).
  • until string: Limits on time_created, inclusive.
  • until_id string: Limits on id, includes the given id value.
  • timeout_s number: Overrides the default query timeout (in seconds). A value of 0 means unlimited. IMPORTANT: using high timeouts in production code is strongly discouraged as it may lead to stability issues.
  • id string: unique identifier
  • time_created string: Filter on the time the resource was created.
  • time_updated string: Filter on the time the resource was last updated
  • item string: Filter based on the item
  • location string: Filter based on the location
  • proximity string (values: far, near, immediate): Filter based on the proximity.
  • technology string (values: bluetooth, optical, rfid): Filter based on the detected technology of an item.

Output

• output
  • count integer: The maximum number of items in the response (as set in the query or by default).
  • count_current integer: The maximum number of items available to return.
  • is_limited boolean: Becomes false when the number of results is smaller than limit.
  • next_url string: URL to the next page of items. ( null if none)
  • query_duration_ms integer: Amount of time, in milliseconds, the request needed to complete.
  • url Url
  • results array
    • items Presence

getPresenceById

Get presence

intellifi_nl.getPresenceById({
  "id": ""
}, context)

Input

• input object
  • id required string: Unique identifier

Output

• output Presence

getServices

Get all services

intellifi_nl.getServices({}, context)

Input

• input object
  • after string: Limits on time_created, exclusive.
  • after_id string: Limits directly on id excludes the given id value, please note that id is chronological.
  • before string: Limits on time_created, exclusive.
  • before_id string: Limits directly on id excludes the given id value, please note that id is chronological.
  • from string: Limits on time_created, inclusive.
  • from_id string: Limits on id, includes the given id value.
  • id_only boolean: Removes url fields from output and shows _id instead of _url in references.
  • limit integer: Sets the maximum number of returned resources. You may increase this number to large values, keep in mind that query times could become large. We advise you to use the pagination feature whenever you can.
  • populate string: Expand a reference into the actual resource (lookup). You may add multiple fields by giving a comma separated value.
  • results_only boolean: Removes response envelope with information about query, only sends back a JSON array with the applicable resources.
  • sort string: Allows you to sort on on or more fields in the resource. You may append a minus sign (-) to request reverse order (new to old).
  • until string: Limits on time_created, inclusive.
  • until_id string: Limits on id, includes the given id value.
  • timeout_s number: Overrides the default query timeout (in seconds). A value of 0 means unlimited. IMPORTANT: using high timeouts in production code is strongly discouraged as it may lead to stability issues.
  • id string: unique identifier
  • time_created string: Filter on the time the resource was created.
  • time_updated string: Filter on the time the resource was last updated
  • name string: Filter based on the name of the resource. Supports wildcards: *

Output

• output
  • count integer: The maximum number of items in the response (as set in the query or by default).
  • count_current integer: The maximum number of items available to return.
  • is_limited boolean: Becomes false when the number of results is smaller than limit.
  • next_url string: URL to the next page of items. ( null if none)
  • query_duration_ms integer: Amount of time, in milliseconds, the request needed to complete.
  • url Url
  • results array
    • items Service

getServiceById

Get service

intellifi_nl.getServiceById({
  "id": ""
}, context)

Input

• input object
  • id required string: Unique identifier

Output

• output Service

updateService

Update existing service

intellifi_nl.updateService({
  "id": "",
  "body": {}
}, context)

Input

• input object
  • id required string: Unique identifier
  • body required Service

Output

• output ResponseDefaultResource

getItemLists

Get all item lists

intellifi_nl.getItemLists({}, context)

Input

• input object
  • after string: Limits on time_created, exclusive.
  • after_id string: Limits directly on id excludes the given id value, please note that id is chronological.
  • before string: Limits on time_created, exclusive.
  • before_id string: Limits directly on id excludes the given id value, please note that id is chronological.
  • from string: Limits on time_created, inclusive.
  • from_id string: Limits on id, includes the given id value.
  • id_only boolean: Removes url fields from output and shows _id instead of _url in references.
  • limit integer: Sets the maximum number of returned resources. You may increase this number to large values, keep in mind that query times could become large. We advise you to use the pagination feature whenever you can.
  • populate string: Expand a reference into the actual resource (lookup). You may add multiple fields by giving a comma separated value.
  • results_only boolean: Removes response envelope with information about query, only sends back a JSON array with the applicable resources.
  • sort string: Allows you to sort on on or more fields in the resource. You may append a minus sign (-) to request reverse order (new to old).
  • until string: Limits on time_created, inclusive.
  • until_id string: Limits on id, includes the given id value.
  • timeout_s number: Overrides the default query timeout (in seconds). A value of 0 means unlimited. IMPORTANT: using high timeouts in production code is strongly discouraged as it may lead to stability issues.
  • id string: unique identifier
  • time_created string: Filter on the time the resource was created.
  • time_updated string: Filter on the time the resource was last updated
  • custom string: Filter based on the custom value. Supports wildcards: *
  • label string: Filter based on the label value. Supports wildcards: *
  • metadata string: Filter based on metadata. Does a partial match on any value in the metadata object. It is also possible to do an exact/wildcard match on specific properties, e.g. metadata.foo=bar
  • text string: Filter based on a full text search. Searched properties depend on the resource type. Matches on any of the given words. Supports quote (exact words) and minus (exclude) operators.
  • total integer: Filter based on the total amount of items in the list
  • sha1 string: The sha1 checksum of the list. This will change when the list is mutated.

Output

• output
  • count integer: The maximum number of items in the response (as set in the query or by default).
  • count_current integer: The maximum number of items available to return.
  • is_limited boolean: Becomes false when the number of results is smaller than limit.
  • next_url string: URL to the next page of items. ( null if none)
  • query_duration_ms integer: Amount of time, in milliseconds, the request needed to complete.
  • url Url
  • results array
    • items ItemList

addItemList

Create item list

intellifi_nl.addItemList({
  "body": {}
}, context)

Input

• input object
  • body required ItemList

Output

• output ResponseDefaultResource

deleteItemSet

Delete item list

intellifi_nl.deleteItemSet({
  "id": ""
}, context)

Input

• input object
  • id required string: Unique identifier

Output

• output ResponseDefaultResource

getItemListById

Get item list

intellifi_nl.getItemListById({
  "id": ""
}, context)

Input

• input object
  • id required string: Unique identifier

Output

• output ItemList

updateItemList

Update existing item list

intellifi_nl.updateItemList({
  "id": "",
  "body": {}
}, context)

Input

• input object
  • id required string: Unique identifier
  • body required ItemList

Output

• output ResponseDefaultResource

getItemListIdsById

Get item ids for this list

intellifi_nl.getItemListIdsById({
  "id": ""
}, context)

Input

• input object
  • id required string: Unique identifier

Output

• output ListOfItemIds

addItemIdsList

Add items to an existing list

intellifi_nl.addItemIdsList({
  "id": "",
  "body": []
}, context)

Input

• input object
  • id required string: Unique identifier
  • body required ListOfItemIds

Output

• output ResponseListResource

deleteItemIdFromItemList

Delete item from list

intellifi_nl.deleteItemIdFromItemList({
  "id": "",
  "itemId": ""
}, context)

Input

• input object
  • id required string: Unique identifier
  • itemId required string: Item ID.

Output

• output ResponseListResource

getSpotLists

Get all spot lists

intellifi_nl.getSpotLists({}, context)

Input

• input object
  • after string: Limits on time_created, exclusive.
  • after_id string: Limits directly on id excludes the given id value, please note that id is chronological.
  • before string: Limits on time_created, exclusive.
  • before_id string: Limits directly on id excludes the given id value, please note that id is chronological.
  • from string: Limits on time_created, inclusive.
  • from_id string: Limits on id, includes the given id value.
  • id_only boolean: Removes url fields from output and shows _id instead of _url in references.
  • limit integer: Sets the maximum number of returned resources. You may increase this number to large values, keep in mind that query times could become large. We advise you to use the pagination feature whenever you can.
  • populate string: Expand a reference into the actual resource (lookup). You may add multiple fields by giving a comma separated value.
  • results_only boolean: Removes response envelope with information about query, only sends back a JSON array with the applicable resources.
  • sort string: Allows you to sort on on or more fields in the resource. You may append a minus sign (-) to request reverse order (new to old).
  • until string: Limits on time_created, inclusive.
  • until_id string: Limits on id, includes the given id value.
  • timeout_s number: Overrides the default query timeout (in seconds). A value of 0 means unlimited. IMPORTANT: using high timeouts in production code is strongly discouraged as it may lead to stability issues.
  • id string: unique identifier
  • time_created string: Filter on the time the resource was created.
  • time_updated string: Filter on the time the resource was last updated
  • custom string: Filter based on the custom value. Supports wildcards: *
  • label string: Filter based on the label value. Supports wildcards: *
  • metadata string: Filter based on metadata. Does a partial match on any value in the metadata object. It is also possible to do an exact/wildcard match on specific properties, e.g. metadata.foo=bar
  • text string: Filter based on a full text search. Searched properties depend on the resource type. Matches on any of the given words. Supports quote (exact words) and minus (exclude) operators.
  • total integer: Filter based on the total amount of spots in the list

Output

• output
  • count integer: The maximum number of items in the response (as set in the query or by default).
  • count_current integer: The maximum number of items available to return.
  • is_limited boolean: Becomes false when the number of results is smaller than limit.
  • next_url string: URL to the next page of items. ( null if none)
  • query_duration_ms integer: Amount of time, in milliseconds, the request needed to complete.
  • url Url
  • results array
    • items SpotList

addSpotList

Create spot list

intellifi_nl.addSpotList({
  "body": {}
}, context)

Input

• input object
  • body required ItemList

Output

• output ResponseDefaultResource

deleteSpotList

Delete spot list

intellifi_nl.deleteSpotList({
  "id": ""
}, context)

Input

• input object
  • id required string: Unique identifier

Output

• output ResponseDefaultResource

getSpotListById

Info for a specific spot list

intellifi_nl.getSpotListById({
  "id": ""
}, context)

Input

• input object
  • id required string: Unique identifier

Output

• output SpotList

updateSpotList

Update existing spot list

intellifi_nl.updateSpotList({
  "id": "",
  "body": {}
}, context)

Input

• input object
  • id required string: Unique identifier
  • body required SpotList

Output

• output ResponseDefaultResource

getSpotListIdsById

Get spot ids for this list

intellifi_nl.getSpotListIdsById({
  "id": ""
}, context)

Input

• input object
  • id required string: Unique identifier

Output

• output ListOfItemIds

addItemIdsSpotList

Add spots to an existing list

intellifi_nl.addItemIdsSpotList({
  "id": "",
  "body": []
}, context)

Input

• input object
  • id required string: Unique identifier
  • body required ListOfItemIds

Output

• output ResponseListResource

deleteItemIdFromSpotList

Delete spot from list

intellifi_nl.deleteItemIdFromSpotList({
  "id": "",
  "itemId": ""
}, context)

Input

• input object
  • id required string: Unique identifier
  • itemId required string: Item ID.

Output

• output ResponseListResource

getSpots

Get all spots

intellifi_nl.getSpots({}, context)

Input

• input object
  • after string: Limits on time_created, exclusive.
  • after_id string: Limits directly on id excludes the given id value, please note that id is chronological.
  • before string: Limits on time_created, exclusive.
  • before_id string: Limits directly on id excludes the given id value, please note that id is chronological.
  • from string: Limits on time_created, inclusive.
  • from_id string: Limits on id, includes the given id value.
  • id_only boolean: Removes url fields from output and shows _id instead of _url in references.
  • limit integer: Sets the maximum number of returned resources. You may increase this number to large values, keep in mind that query times could become large. We advise you to use the pagination feature whenever you can.
  • populate string: Expand a reference into the actual resource (lookup). You may add multiple fields by giving a comma separated value.
  • results_only boolean: Removes response envelope with information about query, only sends back a JSON array with the applicable resources.
  • sort string: Allows you to sort on on or more fields in the resource. You may append a minus sign (-) to request reverse order (new to old).
  • until string: Limits on time_created, inclusive.
  • until_id string: Limits on id, includes the given id value.
  • timeout_s number: Overrides the default query timeout (in seconds). A value of 0 means unlimited. IMPORTANT: using high timeouts in production code is strongly discouraged as it may lead to stability issues.
  • id string: unique identifier
  • time_created string: Filter on the time the resource was created.
  • time_updated string: Filter on the time the resource was last updated
  • is_online boolean: Filter based on the online status.
  • request_counter integer: Filter based on the amount of request made
  • serial_number integer: Filter based on the serial number.

Output

• output
  • count integer: The maximum number of items in the response (as set in the query or by default).
  • count_current integer: The maximum number of items available to return.
  • is_limited boolean: Becomes false when the number of results is smaller than limit.
  • next_url string: URL to the next page of items. ( null if none)
  • query_duration_ms integer: Amount of time, in milliseconds, the request needed to complete.
  • url Url
  • results array
    • items SpotGet

getSpotSetById

Get spotset

intellifi_nl.getSpotSetById({
  "setId": ""
}, context)

Input

• input object
  • setId required string: Unique spot set identifier

Output

• output SpotSet

getSpotById

Get spot

intellifi_nl.getSpotById({
  "id": ""
}, context)

Input

• input object
  • id required string: Unique identifier

Output

• output SpotGet

updateSpot

Update existing spot

intellifi_nl.updateSpot({
  "id": "",
  "body": null
}, context)

Input

• input object
  • id required string: Unique identifier
  • body required SpotUpdate

Output

• output ResponseDefaultResource

getSpotSetsById

Get spotset

intellifi_nl.getSpotSetsById({
  "id": ""
}, context)

Input

• input object
  • id required string: Unique identifier

Output

• output SpotSet

addSpotSet

Create spotset

intellifi_nl.addSpotSet({
  "id": "",
  "body": null
}, context)

Input

• input object
  • id required string: Unique identifier
  • body required SpotSetCreate

Output

• output ResponseDefaultResource

updateSpotSet

Update existing spotset

intellifi_nl.updateSpotSet({
  "id": "",
  "setId": "",
  "body": {}
}, context)

Input

• input object
  • id required string: Unique identifier
  • setId required string: Unique spot set identifier
  • body required SpotSetUpdate

Output

• output ResponseDefaultResource

getSubscriptions

Get all subscriptions

intellifi_nl.getSubscriptions({}, context)

Input

• input object
  • after string: Limits on time_created, exclusive.
  • after_id string: Limits directly on id excludes the given id value, please note that id is chronological.
  • before string: Limits on time_created, exclusive.
  • before_id string: Limits directly on id excludes the given id value, please note that id is chronological.
  • from string: Limits on time_created, inclusive.
  • from_id string: Limits on id, includes the given id value.
  • id_only boolean: Removes url fields from output and shows _id instead of _url in references.
  • limit integer: Sets the maximum number of returned resources. You may increase this number to large values, keep in mind that query times could become large. We advise you to use the pagination feature whenever you can.
  • populate string: Expand a reference into the actual resource (lookup). You may add multiple fields by giving a comma separated value.
  • results_only boolean: Removes response envelope with information about query, only sends back a JSON array with the applicable resources.
  • sort string: Allows you to sort on on or more fields in the resource. You may append a minus sign (-) to request reverse order (new to old).
  • until string: Limits on time_created, inclusive.
  • until_id string: Limits on id, includes the given id value.
  • timeout_s number: Overrides the default query timeout (in seconds). A value of 0 means unlimited. IMPORTANT: using high timeouts in production code is strongly discouraged as it may lead to stability issues.
  • id string: unique identifier
  • time_created string: Filter on the time the resource was created.
  • time_updated string: Filter on the time the resource was last updated
  • custom string: Filter based on the custom value. Supports wildcards: *
  • topic_filter string: Filter on the topic filter. Make sure to use percent-encoding in the query parameter.
  • description string: Filter based on the description.
  • database_hold_time_h integer: Filter based on the number of hours events are retained in the database.
  • populate_events boolean: Filter based on subscriptions that populate the events
  • verify_target_certificate boolean: Filter on the verification of the target certificate.

Output

• output
  • count integer: The maximum number of items in the response (as set in the query or by default).
  • count_current integer: The maximum number of items available to return.
  • is_limited boolean: Becomes false when the number of results is smaller than limit.
  • next_url string: URL to the next page of items. ( null if none)
  • query_duration_ms integer: Amount of time, in milliseconds, the request needed to complete.
  • url Url
  • results array
    • items Subscription

addSubscription

Create subscription

intellifi_nl.addSubscription({
  "body": {}
}, context)

Input

• input object
  • body required Subscription

Output

• output ResponseDefaultResource

deleteSubscription

Delete subscription

intellifi_nl.deleteSubscription({
  "id": ""
}, context)

Input

• input object
  • id required string: Unique identifier

Output

• output ResponseDefaultResource

getSubscriptionById

Get subscription

intellifi_nl.getSubscriptionById({
  "id": ""
}, context)

Input

• input object
  • id required string: Unique identifier

Output

• output Subscription

updateSubscription

Update existing subscription

intellifi_nl.updateSubscription({
  "id": "",
  "body": {}
}, context)

Input

• input object
  • id required string: Unique identifier
  • body required Subscription

Output

• output ResponseDefaultResource

getEventsForSubscriptionById

Get subscription events

intellifi_nl.getEventsForSubscriptionById({
  "id": ""
}, context)

Input

• input object
  • id required string: Unique identifier
  • after string: Limits on time_created, exclusive.
  • after_id string: Limits directly on id excludes the given id value, please note that id is chronological.
  • before string: Limits on time_created, exclusive.
  • before_id string: Limits directly on id excludes the given id value, please note that id is chronological.
  • from string: Limits on time_created, inclusive.
  • from_id string: Limits on id, includes the given id value.
  • id_only boolean: Removes url fields from output and shows _id instead of _url in references.
  • limit integer: Sets the maximum number of returned resources. You may increase this number to large values, keep in mind that query times could become large. We advise you to use the pagination feature whenever you can.
  • populate string: Expand a reference into the actual resource (lookup). You may add multiple fields by giving a comma separated value.
  • results_only boolean: Removes response envelope with information about query, only sends back a JSON array with the applicable resources.
  • sort string: Allows you to sort on on or more fields in the resource. You may append a minus sign (-) to request reverse order (new to old).
  • until string: Limits on time_created, inclusive.
  • until_id string: Limits on id, includes the given id value.
  • timeout_s number: Overrides the default query timeout (in seconds). A value of 0 means unlimited. IMPORTANT: using high timeouts in production code is strongly discouraged as it may lead to stability issues.
  • id_query string: unique identifier
  • time_created string: Filter on the time the resource was created.
  • topic.resource_type string (values: blobs, items, keys, kvpairs, locations, presences, services, spots, subscriptions, users): Filter on the topic resource type
  • topic.action string (values: created, updated, deleted, disappeared, connection-rssi-changed): Filter on the topic action
  • topic.resource string: Filter on the topic resource id
  • time_event string: Filter on the time the event was generated on the device.
  • time_expire string: Filter on the time the event will expire.

Output

• output
  • count integer: The maximum number of items in the response (as set in the query or by default).
  • count_current integer: The maximum number of items available to return.
  • is_limited boolean: Becomes false when the number of results is smaller than limit.
  • next_url string: URL to the next page of items. ( null if none)
  • query_duration_ms integer: Amount of time, in milliseconds, the request needed to complete.
  • url Url
  • results array
    • items Event

getUsers

Can only be used by an administrative user.

intellifi_nl.getUsers({}, context)

Input

• input object
  • after string: Limits on time_created, exclusive.
  • after_id string: Limits directly on id excludes the given id value, please note that id is chronological.
  • before string: Limits on time_created, exclusive.
  • before_id string: Limits directly on id excludes the given id value, please note that id is chronological.
  • from string: Limits on time_created, inclusive.
  • from_id string: Limits on id, includes the given id value.
  • id_only boolean: Removes url fields from output and shows _id instead of _url in references.
  • limit integer: Sets the maximum number of returned resources. You may increase this number to large values, keep in mind that query times could become large. We advise you to use the pagination feature whenever you can.
  • populate string: Expand a reference into the actual resource (lookup). You may add multiple fields by giving a comma separated value.
  • results_only boolean: Removes response envelope with information about query, only sends back a JSON array with the applicable resources.
  • sort string: Allows you to sort on on or more fields in the resource. You may append a minus sign (-) to request reverse order (new to old).
  • until string: Limits on time_created, inclusive.
  • until_id string: Limits on id, includes the given id value.
  • timeout_s number: Overrides the default query timeout (in seconds). A value of 0 means unlimited. IMPORTANT: using high timeouts in production code is strongly discouraged as it may lead to stability issues.
  • id string: unique identifier
  • time_created string: Filter on the time the resource was created.
  • time_updated string: Filter on the time the resource was last updated
  • email string: Filter on the email address.
  • first_name string: Filter on the first name.
  • last_name string: Filter on the last name.
  • is_admin boolean: Filter on the administrator status.
  • is_locked boolean: Filter on the locked status.

Output

• output
  • count integer: The maximum number of items in the response (as set in the query or by default).
  • count_current integer: The maximum number of items available to return.
  • is_limited boolean: Becomes false when the number of results is smaller than limit.
  • next_url string: URL to the next page of items. ( null if none)
  • query_duration_ms integer: Amount of time, in milliseconds, the request needed to complete.
  • url Url
  • results array
    • items User

addUser

Can only be used by an administrative user.

intellifi_nl.addUser({
  "body": {}
}, context)

Input

• input object
  • body required User

Output

• output ResponseDefaultResource

deleteUser

Can only be used by an administrative user.

intellifi_nl.deleteUser({
  "id": ""
}, context)

Input

• input object
  • id required string: Unique identifier

Output

• output ResponseDefaultResource

getUserById

Can only be used by an administrative user.

intellifi_nl.getUserById({
  "id": ""
}, context)

Input

• input object
  • id required string: Unique identifier

Output

• output User

updateUser

Can only be used by an administrative user.

intellifi_nl.updateUser({
  "id": "",
  "body": {}
}, context)

Input

• input object
  • id required string: Unique identifier
  • body required User

Output

• output ResponseDefaultResource

Definitions

Blob

• Blob object
  • blob_key string: Unique key to the blob
  • content_type string: Media type of the resource. Automatically detected when not given in a POST.
  • download_url Url
  • filename string: Filename of the blob
  • hash string: Hash of the blob
  • id IdReadOnly
  • time_created TimeCreated
  • time_last_accessed TimeLastAccessed
  • time_updated TimeUpdated
  • upload_url Url
  • url Url

BootCount

• BootCount integer: Is increased with 1 when the service starts. Is never cleared (unless the database is adjusted).

CodeHex

• CodeHex string: String representation of the unique code that this item transmits. By default this is a hexadecimal representation. This number could be so long (> 40 bytes!) that a decimal representation would be useless to generate.

Config

• Config object: JSON object with possible settings. Refer to individual service documentation for a good overview.

ConfigRequest

• ConfigRequest object: Object containing the new configuration. This will be applied automatically when the values are valid.

Custom

Event

• Event object
  • id IdReadOnly
  • time_created TimeCreated
  • time_event TimeEvent
  • time_expire TimeExpire
  • topic object
    • action EventTopicAction
    • arguments EventTopicArgument
    • resource_id IdReadOnly
    • resource_type EventTopicResourceType
    • resource_url Url
  • url Url

EventTopicAction

• EventTopicAction string (values: created, updated, deleted, disappeared, connection-rssi-changed): Indicates the kind of event that was executed. In most cases it's a verb. I.e. 'connected', 'created' etc...

EventTopicArgument

EventTopicResourceType

• EventTopicResourceType string (values: blobs, items, keys, kvpairs, locations, presences, services, spots, subscriptions, users): The The available event topic resources types on the API. Is written in its plural form.

GeoCoords

• GeoCoords object: Last known geolocation estimate of this object. Not guaranteed to be included in response.
  • lat number: Latitude angle in degrees
  • lng number: Longitude angle in degrees
  • time_updated TimeUpdated

GeoCoordsReadOnly

• GeoCoordsReadOnly object: Last known geolocation estimate of this object. Not guaranteed to be included in response.
  • lat number: Latitude angle in degrees
  • lng number: Longitude angle in degrees
  • time_updated TimeUpdated

Id

• Id string: Unique identifier for resource.

IdReadOnly

• IdReadOnly string: Unique identifier for resource.

IsOnline

• IsOnline boolean: Whether or not this resource is actively connected to the Brain.

Item

• Item
  • config_request ConfigRequest
  • custom Custom
  • label Label
  • location_request LocationRequest
  • metadata Metadata
  • code_hex CodeHex
  • geo_coords GeoCoordsReadOnly
  • id IdReadOnly
  • is_present boolean: Is this item actively detected in one of the zones at this moment? True when it is, false if it's not.
  • move_count MoveCount
  • protocol ItemProtocol
  • sets ListOfSetIds
  • technology Technology
  • time_created TimeCreated
  • time_last_present string: Last time the item was present.
  • time_moved TimeMoved
  • time_updated TimeUpdated
  • type ItemType
  • url Url

ItemList

• ItemList object
  • custom Custom
  • id IdReadOnly
  • label Label
  • list Url
  • metadata Metadata
  • sha1 string: The sha1 checksum of the list. This will change when the list is mutated.
  • time_created TimeCreated
  • time_updated TimeUpdated
  • total integer: Total amount of items in this set

ItemProtocol

• ItemProtocol string (values