Template DataStreams

Template datastream management

Get template datastreams

get

Retrieve all datastreams defined in a template.

Required permissions, when user-scoped authentication is used: PRODUCT_VIEW.

Authorizations

bearerAuth

AuthorizationstringRequired

OAuth2 Bearer token obtained from authentication endpoint

Query parameters

templateIdinteger · int32Required

Template ID

Responses

200

List of datastreams

application/json

idinteger · int32Required

DataStream ID

Example: 1

labelstringRequired

DataStream label

Example: Temperature_Sensor

aliasstringRequired

DataStream alias

Example: Temperature Sensor

unitsstring · enumOptional

DataStream units

Example: CelsiusPossible values:

typestring · enumRequired

DataStream value type

Possible values:

defaultValueone ofOptional

stringOptional

String datastream value

Example: Some DataStream Value

or

number · doubleOptional

Double, integer or enum datastream value

Example: 22.2

or

number · double[] · min: 2 · max: 2Optional

Location datastream value. Represented as an array of two elements, where the first is longitude, and the second is latitude.

Example: [13.38886,52.517037]

pininteger · int32Required

Virtual pin number

Example: 5

pinTypestring · enumRequired

Pin type

Possible values:

pinModestring · enumOptional

Pin mode

Possible values:

isAnalogPinbooleanRequired

Whether the pin is an analog pin

isRawbooleanRequired

Whether the datastream value should be stored as raw value without parsing

isHistorybooleanRequired

Whether the datastream should be stored in the aggregated format

isForServicebooleanRequired

Whether the datastream should be displayed in the service chart widget

isForReportsbooleanRequired

Whether the datastream is used for reporting purposes

isForActionsbooleanRequired

Whether the datastream can be used in the automation actions

isForConditionsbooleanRequired

Whether the datastream can be used in the automation conditions

isSyncbooleanRequired

Whether the datastream value should be synced on the hardware request

400

Bad request

application/json

403

Forbidden

404

Template not found or access denied

application/json

429

Too many requests

500

Internal server error

application/json

get

/api/v1/organization/template/datastreams

HTTPcURLJavaScriptPython

GET /api/v1/organization/template/datastreams?templateId=1 HTTP/1.1
Host: blynk.cloud
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "id": 1,
    "label": "Temperature_Sensor",
    "alias": "Temperature Sensor",
    "units": "Celsius",
    "type": "STRING",
    "defaultValue": "Some DataStream Value",
    "pin": 5,
    "pinType": "VIRTUAL",
    "pinMode": "INPUT",
    "isAnalogPin": true,
    "isRaw": true,
    "isHistory": true,
    "isForService": true,
    "isForReports": true,
    "isForActions": true,
    "isForConditions": true,
    "isSync": true
  }
]

Create template datastream

post

Add a new datastream to a template.

Only the original (root) template can be edited (the one with parentId = null). Sub-organizations cannot modify templates that were created by a parent organization. Pin numbers must be unique within the template.

Required permissions, when user-scoped authentication is used: PRODUCT_EDIT. Also, when the user-scoped authentication is used, user should have developer mode enabled.

Authorizations

bearerAuth

AuthorizationstringRequired

OAuth2 Bearer token obtained from authentication endpoint

Body

application/json

productIdinteger · int32Required

Template ID

Example: 101

labelstring · min: 1 · max: 128Required

Datastream label. Can only contain letters, digits, spaces and underscores.

Example: Temperature_Sensor

aliasstring · max: 200Required

Datastream label. Can only contain letters, digits and spaces.

unitsstring · enumOptional

DataStream units

Example: CelsiusPossible values:

typeone ofRequiredExample: {"type":"DOUBLE","defaultValue":30.1,"min":1.1,"max":100.1,"decimalsFormat":"FRACTION_5"}

or

or

or

or

pininteger · int32Required

Pin number

Example: 5

pinTypestring · enumRequired

Pin type

Possible values:

pinModestring · enumOptional

Pin mode

Possible values:

isAnalogPinbooleanOptional

Whether the pin is analog

isRawbooleanOptional

Whether Blynk should store raw values sent from the device

isHistorybooleanOptional

Whether Blynk should store aggregated values sent from the device

isForServicebooleanOptional

Whether the datastream should be displayed in the service chart widget

isForReportsbooleanOptional

Whether the datastream values should be included to reports

isForActionsbooleanOptional

Whether the datastream can be used in automation actions

isForConditionsbooleanOptional

Whether the datastream can be used in automation conditions

isSyncbooleanOptional

Whether the datastream should be synced with the device upon request

Responses

201

Datastream created successfully

application/json

400

Bad request

application/json

403

Forbidden

application/json

404

Template not found or access denied

application/json

429

Too many requests

500

Internal server error

application/json

post

/api/v1/organization/template/datastream/create

HTTPcURLJavaScriptPython

POST /api/v1/organization/template/datastream/create HTTP/1.1
Host: blynk.cloud
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 368

{
  "productId": 101,
  "label": "Temperature_Sensor",
  "alias": "text",
  "units": "Celsius",
  "type": {
    "type": "DOUBLE",
    "defaultValue": 30.1,
    "min": 1.1,
    "max": 100.1,
    "decimalsFormat": "FRACTION_5"
  },
  "pin": 5,
  "pinType": "VIRTUAL",
  "pinMode": "INPUT",
  "isAnalogPin": true,
  "isRaw": true,
  "isHistory": true,
  "isForService": true,
  "isForReports": true,
  "isForActions": true,
  "isForConditions": true,
  "isSync": true
}

{
  "id": 1,
  "label": "Temperature_Sensor",
  "alias": "Temperature Sensor",
  "units": "Celsius",
  "type": "STRING",
  "defaultValue": "Some DataStream Value",
  "pin": 5,
  "pinType": "VIRTUAL",
  "pinMode": "INPUT",
  "isAnalogPin": true,
  "isRaw": true,
  "isHistory": true,
  "isForService": true,
  "isForReports": true,
  "isForActions": true,
  "isForConditions": true,
  "isSync": true
}

Update template datastream

put

Update a datastream in a template.

Only the original (root) template can be edited (the one with parentId = null). Sub-organizations cannot modify templates that were created by a parent organization.

Required permissions, when user-scoped authentication is used: PRODUCT_EDIT. Also, when the user-scoped authentication is used, user should have developer mode enabled.

Authorizations

bearerAuth

AuthorizationstringRequired

OAuth2 Bearer token obtained from authentication endpoint

Body

application/json

productIdinteger · int32Required

Template ID

Example: 101

idinteger · int32Optional

Datastream ID, that should be updated

Example: 1

labelstring · min: 1 · max: 128Required

Datastream label. Can only contain letters, digits, spaces and underscores.

Example: Temperature_Sensor

aliasstring · max: 200Required

Datastream label. Can only contain letters, digits and spaces.

unitsstring · enumOptional

DataStream units

Example: CelsiusPossible values:

typeone ofRequiredExample: {"type":"DOUBLE","defaultValue":30.1,"min":1.1,"max":100.1,"decimalsFormat":"FRACTION_5"}

or

or

or

or

pininteger · int32Required

Pin number

Example: 5

pinTypestring · enumRequired

Pin type

Possible values:

pinModestring · enumOptional

Pin mode

Possible values:

isAnalogPinbooleanOptional

Whether the pin is analog

isRawbooleanOptional

Whether Blynk should store raw values sent from the device

isHistorybooleanOptional

Whether Blynk should store aggregated values sent from the device

isForServicebooleanOptional

Whether the datastream should be displayed in the service chart widget

isForReportsbooleanOptional

Whether the datastream values should be included to reports

isForActionsbooleanOptional

Whether the datastream can be used in automation actions

isForConditionsbooleanOptional

Whether the datastream can be used in automation conditions

isSyncbooleanOptional

Whether the datastream should be synced with the device upon request

Responses

201

Datastream updated successfully

application/json

400

Bad request

application/json

403

Forbidden

application/json

404

Template/datastream not found or access denied

application/json

429

Too many requests

500

Internal server error

application/json

put

/api/v1/organization/template/datastream

HTTPcURLJavaScriptPython

PUT /api/v1/organization/template/datastream HTTP/1.1
Host: blynk.cloud
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 375

{
  "productId": 101,
  "id": 1,
  "label": "Temperature_Sensor",
  "alias": "text",
  "units": "Celsius",
  "type": {
    "type": "DOUBLE",
    "defaultValue": 30.1,
    "min": 1.1,
    "max": 100.1,
    "decimalsFormat": "FRACTION_5"
  },
  "pin": 5,
  "pinType": "VIRTUAL",
  "pinMode": "INPUT",
  "isAnalogPin": true,
  "isRaw": true,
  "isHistory": true,
  "isForService": true,
  "isForReports": true,
  "isForActions": true,
  "isForConditions": true,
  "isSync": true
}

{
  "id": 1,
  "label": "Temperature_Sensor",
  "alias": "Temperature Sensor",
  "units": "Celsius",
  "type": "STRING",
  "defaultValue": "Some DataStream Value",
  "pin": 5,
  "pinType": "VIRTUAL",
  "pinMode": "INPUT",
  "isAnalogPin": true,
  "isRaw": true,
  "isHistory": true,
  "isForService": true,
  "isForReports": true,
  "isForActions": true,
  "isForConditions": true,
  "isSync": true
}

Delete template datastream

delete

Remove a datastream from a template.

Only the original (root) template can be edited (the one with parentId = null). Sub-organizations cannot modify templates that were created by a parent organization.

Required permissions, when user-scoped authentication is used: PRODUCT_EDIT. Also, when the user-scoped authentication is used, user should have developer mode enabled.

Authorizations

bearerAuth

AuthorizationstringRequired

OAuth2 Bearer token obtained from authentication endpoint

Query parameters

templateIdinteger · int32Required

Template ID

dataStreamIdinteger · int32Required

DataStream ID

Responses

204

Datastream deleted successfully

400

Bad request

application/json

403

Forbidden

application/json

404

Template/datastream not found or access denied

application/json

429

Too many requests

500

Internal server error

application/json

delete

/api/v1/organization/template/datastream

HTTPcURLJavaScriptPython

DELETE /api/v1/organization/template/datastream?templateId=1&dataStreamId=1 HTTP/1.1
Host: blynk.cloud
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content