Template Meta Fields

Template metadata field management

Get template metadata fields

get

Retrieve all metadata fields defined in a template.

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

Authorizations

AuthorizationstringRequired

OAuth2 Bearer token obtained from authentication endpoint

Query parameters

templateIdinteger · int32Required

Template ID

Responses

200

List of metadata fields

application/json

idinteger · int32Required

MetaField ID

Example: 1

namestringRequired

MetaField name

Example: Serial Number

typestring · enumRequired

MetaField type

Possible values:

descriptionstringOptional

MetaField description

Example: Device serial number

hintstringOptional

MetaField hint for the provisioning form

Example: You can find the serial number on the device label

iconstringOptional

MetaField icon

Example: 

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/metafields

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

[
  {
    "id": 1,
    "name": "Serial Number",
    "type": "MultiText",
    "description": "Device serial number",
    "hint": "You can find the serial number on the device label",
    "icon": ""
  }
]

PreviousTemplate Events

NextTags

Last updated 10 days ago

Was this helpful?