Servitly API Client

To interact with the Servitly backend API, you can leverage the ServitlyClient object, which is available in the JavaScript context.
It provides methods to retrieve, create, update, and delete data related to customers, locations, things, metrics, and more.

servitlyClient.getMeThings({}, function(things){
   // do stuff with the retreived things
}, function(error){
   console.error("Error retrieving things", error);
});

Filter Parameter

All methods accessing collections of objects, e.g. getMeThings(filter,....), require a parameter which is used to pass the conditions for filtering the requested objects.
Filter is a JSON object which can contain any of the following fields:

• thingId: the identifier of the thing.

• locationId: the identifier of the location.

• customerId: the identifier of the customer.

• parenThingId: the identifier of the parent thing.

• query: the array of property-based conditions.
  [{"property": "name", "predicate": "eq", "value": "test"}, {...}]
  PREDICATES beginsWith, eq, neq, gt, gte, lt, lte, like, notLike, isEmpty, isNotEmpty.

• limit: the maximum number of element to retrieve.

• startDate: the start-date in milliseconds used to filter result elements by creation timestamp.

• endDate: the end-date in milliseconds used to filter result elements by creation timestamp.

• aggregation: the aggregation function and time frame to retrieve aggregated metric values (e.g. AVG_DAY_1).

Here is an example of filter parameter to retrieve things of a customer.

{
	"customerId": "1234567",
	"query": [
		{
			"property": "name",
			"predicate": "like",
			"value": "*XYZ*"
		}
	]
}

Callback Parameters

• success: the callback called when the method successfully completes.
  This function receives the response object (e.g. thing JSON).

• error: the callback called when the method invocation fails.
  This function receives the error details object.

In case you are using the ServitlyClient into a Promise, you can directly pass the resolve and reject callbacks.

new Promise(function (resolve, reject) {
     servitlyClient.getMeThings({}, resolve, reject); 
});

General Methods

With the following methods you can invoke any of the  Servitly backend API.  

In addition to these methods, the ServitlyClient class provides more specific methods to interact with the main object types.

Thing Methods

Customer and Location Methods

Metric Data Methods

Statistics Methods

Event and Work Session Methods