• Authentication
• tag
  • getGet the list of all tags
• monitor
  • getGet monitoring tag values
• access
  • getDirect read method by tag
  • putDirect write method by tag
• virtual
  • postCreate an user-defined virtual tag
  • putUpdate an user-defined virtual tag
  • delDelete an user-defined virtual tag

Documentation Powered by Redocly

Tag APIs (2.0.0)

Download OpenAPI specification:Download

TagService and TagHub API

Authentication

bearerAuth

Security Scheme Type	HTTP
HTTP Authorization Scheme	bearer
Bearer format	"JWT"

tag

Get the list of all tags

Authorizations:

bearerAuth

query Parameters

provider

string

Responses

http://127.0.0.1/api/v1/tags/list

Response samples

• 200

Content type

application/json

Example

modbusmastersystemmodbusmaster

{

• "data": [

  • {

    • "prvdName": "modbus_tcp_master",
    • "srcName": "ioLogik",
    • "tagName": "di0",
    • "dataType": "raw",
    • "dataSize": 20,
    • "dataUnit": "mA",
    • "access": "r"

    }

  ]

}

monitor

Get monitoring tag values

Returns value of tags in taghub which queried by different sources and time

Authorizations:

bearerAuth

path Parameters

provider required	string Provider Name - (system, module name, app name)
source required	string Source Name - (device name, function name)

query Parameters

tags	string Tag Name - format (tags=name1,name2,name3)
ms	integer history data search in milliseconds
streamInterval	integer create a http streaming connection and response data by milliseconds time interval
compute	string Value: "diff" apply a compute method during streaming
onChanged	boolean create a http streaming connection and response data on tag value changed

Responses

http://127.0.0.1/api/v1/tags/monitor/{provider}/{source}

Response samples

• 200

Content type

application/json

{

• "data": {

  • "prvdName": "modbus_tcp_master",
  • "srcName": "ioLogik-E1210",
  • "tagName": "di0",
  • "dataType": "uint16",
  • "dataValue": 1,
  • "dataUnit": "mA",
  • "ts": 1541409957933

  }

}

access

Direct read method by tag

Only 'r', 'rw' access type can work.

Authorizations:

bearerAuth

path Parameters

provider required	string
source required	string
tag required	string

Responses

http://127.0.0.1/api/v1/tags/access/{provider}/{source}/{tag}

Response samples

• 200
• 400

Content type

application/json

{

• "prvdName": "modbus_tcp_master",
• "srcName": "ioLogik",
• "tagName": "di0",
• "timestamp": "1560322153374",
• "dataType": "uint16",
• "dataValue": 1

}

Direct write method by tag

Only 'w', 'rw' access type can work.

Authorizations:

bearerAuth

path Parameters

provider required	string
source required	string
tag required	string

Request Body schema: application/json

dataType	string Enum: "uint8" "uint16" "uint32" "uint64" "int8" "int16" "int32" "int64" "float" "double" "string" "boolean" "raw"
dataValue	object

Responses

http://127.0.0.1/api/v1/tags/access/{provider}/{source}/{tag}

Request samples

• Payload

Content type

application/json

{

• "dataType": "int16",
• "dataValue": 1

}

Response samples

• 400

Content type

application/json

{

• "message": "string"

}

virtual

Create an user-defined virtual tag

Authorizations:

bearerAuth

Request Body schema: application/json

prvdName required	string <= 1024
srcName required	string <= 1024
tagName required	string <= 1024
dataType required	string Enum: "uint8" "uint16" "uint32" "uint64" "int8" "int16" "int32" "int64" "float" "double" "string" "boolean" "raw"
dataSize	integer <uint32> [ 0 .. 4294967295 ] The field is used to specify the size of byte-array, raw, and string. It's useless for others types.
dataUnit	string [ 0 .. 16 ]
access required	string Enum: "r" "w" "rw"

Responses

http://127.0.0.1/api/v1/tags/virtual

Request samples

• Payload

Content type

application/json

Example

intuintfloatdoublestringwriteread-writeint

{

• "prvdName": "virtual",
• "srcName": "user",
• "tagName": "int64_t",
• "dataType": "int64",
• "dataUnit": "unit",
• "access": "r"

}

Response samples

• 200

Content type

application/json

{

• "data": {

  • "prvdName": "virtual",
  • "srcName": "user",
  • "tagName": "int64_t",
  • "dataType": "int64",
  • "dataUnit": "unit",
  • "access": "r"

  }

}

Update an user-defined virtual tag

Authorizations:

bearerAuth

Request Body schema: application/json

prvdName required	string <= 1024
srcName required	string <= 1024
tagName required	string <= 1024
dataType required	string Enum: "uint8" "uint16" "uint32" "uint64" "int8" "int16" "int32" "int64" "float" "double" "string" "boolean" "raw"
dataSize	integer <uint32> [ 0 .. 4294967295 ] The field is used to specify the size of byte-array, raw, and string. It's useless for others types.
dataUnit	string [ 0 .. 16 ]
access required	string Enum: "r" "w" "rw"

Responses

http://127.0.0.1/api/v1/tags/virtual

Request samples

• Payload

Content type

application/json

Example

intuintfloatdoublestringrawwriteread-writeint

{

• "prvdName": "virtual",
• "srcName": "user",
• "tagName": "int64_t",
• "dataType": "int64",
• "dataUnit": "unit",
• "access": "r"

}

Response samples

• 200

Content type

application/json

{

• "data": {

  • "prvdName": "virtual",
  • "srcName": "user",
  • "tagName": "int64_t",
  • "dataType": "int64",
  • "dataUnit": "unit",
  • "access": "r"

  }

}

Delete an user-defined virtual tag

Authorizations:

bearerAuth

Request Body schema: application/json

prvdName required	string
srcName required	string
tagName required	string

Responses

http://127.0.0.1/api/v1/tags/virtual

Request samples

• Payload

Content type

application/json

{

• "prvdName": "virtual",
• "srcName": "user",
• "tagName": "defined"

}

Response samples

• 200

Content type

application/json

{

• "data": [

  • {

    • "prvdName": "user",
    • "srcName": "define",
    • "tagName": "tag",
    • "dataType": "int32",
    • "dataUnit": "%",
    • "access": "r"

    }

  ]

}