Version: v5.0

Telemetry Configs

Note: The nsfilter (namespace filter) query parameter is mandatory for every request. It sets the context, helping you look up resources within that namespace. Example: GET /itemsvc/api/v1/telemetryconfigs?nsfilter=proj_DrZrSNrW

Create Telemetry Config#

Creates a telemetry configuration for IoT integration.

Endpoints#

POST /itemsvc/api/v1/telemetryconfigs

Request#

Query parameters#

Parameter	Type	Description	Required
`nsfilter`	String	namespace context	Required

Request body parameters#

Property	Type	Description	Required
`_name`	String	Name your telemetry configuration in long form with a maximum of 100 characters.	Required
`_userType`	String	Enter a new or shared custom type with a maximum of 100 characters.	Required
`_configData`	Object	Pass an object with your config data.	Required
`_configData._bindings`	Array of Object	Pass an array that contains your bindings objects.	Optional
`_configData._bindings[n].collectionDesc`	Object	Enter a valid simple query to run on your collections list. The collections lookup filters by the user’s namespaces.	Required
`_configData._bindings[n].query`	Object	Add criteria to filter the related items in the collection you selected in the collectionDesc query.	Optional
`_configData._normalizationScript`	Object	Pass an object with a `"_userType"` property.	Required
`_configData._normalizationScript._userType`	String	Enter your normalization script's _userType value.	Required
`_namespaces`	Array of String	Enter the namespace that you want to own the telemetry configuration.	Required
`_shortName`	String	Give your telemetry configuration an abbreviated name with a maximum of 22 characters.	Required
`_description`	String	Enter a description for the telemetry configuration	Optional

Request body example#

{  "_name": "Telemetry Config - 1",  "_userType": "telemetry_config",  "_configData": {    "_bindings": [      {        "collectionDesc": {          "_userItemId": "tempsensor_gBDjAv6dl4"        },        "query": {            "deviceType": "temp-10"        }      }    ],    "_normalizationScript":{      "_userType":"telemetry_parser_script"    }  },  "_namespaces": [    "automation_3E4tpXPu"  ],  "_shortName": "telconfig",  "_description": "Telemetry Config for project A"}

Response#

Response codes#

Code	Description
`202`	Accepted
`400`	Bad Request

Response header#

Header	Description
`Location`	Contains the URL for the Telemetry Config Status API.

Example#

https://xxxxxx.com/itemsvc/api/v1/telemetry_async_tasks/7d6bdcbf-67ab-44f5-8634-dd6dfa48f6c4

Get All Telemetry Configs#

Gets all telemetry configurations.

Endpoints#

GET /itemsvc/api/v1/telemetryconfigs

Request#

Query parameters#

Parameter	Type	Description	Required
`nsfilter`	String	Filter the telemetry configs by namespace.	Optional

Response#

Response codes#

Code	Description
`200`	Success

Response body example#

{  "_pageSize": 1,  "_list": [    {      "_uri": "/telemetryconfigs/64c7c8c6b77e3b2ff378e449",      "_namespaces": [        "automation_3E4tpXPu"      ],      "_name": "Telemetry Config - 1",      "_shortName": "telconfig",      "_userType": "telemetry_config",      "_irn": "itemsvc:telemetryconfig:64c7c8c6b77e3b2ff378e449",      "_id": "64c7c8c6b77e3b2ff378e449",      "_description": "Telemetry Config for project A",      "_metadata": {        "_updatedById": "c9b79905-2106-4d21-8ec1-4a58b7143e9f",        "_createdAt": 1690814662033,        "_createdById": "c9b79905-2106-4d21-8ec1-4a58b7143e9f",        "_updatedAt": 1690814662033      },      "_configData": {        "_normalizationScript": {          "_userType": "telemetry_parser_script"        },        "_bindings": [          {            "collectionDesc": {              "_userItemId": "tempsensor_gBDjAv6dl4"            }          }        ],        "_sources": [          {            "_connector": "jms",            "_channel": "activemq"          }        ]      }    }  ],  "_offset": 0,  "_total": 1}

Get Telemetry Configs By Id#

Endpoints#

GET /itemsvc/api/v1/telemetryconfigs/{id}

Request#

Path parameters#

Parameter	Type	Description	Required
`id`	String	The telemetry config's id	Required

Query parameters#

Parameter	Type	Description	Required
`nsfilter`	String	Filter the telemetry configs by namespace.	Required

Response#

Response codes#

Code	Description
`200`	Success
`404`	Resource Not Found

Response body example#

{  "_updateLogs": [    {      "_updatedBy": "c9b79905-2106-4d21-8ec1-4a58b7143e9f",      "_updatedAt": 1690814662033    }  ],  "_uri": "/telemetryconfigs/64c7c8c6b77e3b2ff378e449",  "_namespaces": [    "automation_3E4tpXPu"  ],  "_name": "Telemetry Config - 1",  "_shortName": "telconfig",  "_userType": "telemetry_config",  "_irn": "itemsvc:telemetryconfig:64c7c8c6b77e3b2ff378e449",  "_id": "64c7c8c6b77e3b2ff378e449",  "_description": "Telemetry Config for project A",  "_metadata": {    "_updatedById": "c9b79905-2106-4d21-8ec1-4a58b7143e9f",    "_createdAt": 1690814662033,    "_createdById": "c9b79905-2106-4d21-8ec1-4a58b7143e9f",    "_updatedAt": 1690814662033  },  "_configData": {    "_normalizationScript": {      "_userType": "telemetry_parser_script"    },    "_bindings": [      {        "collectionDesc": {          "_userItemId": "tempsensor_gBDjAv6dl4"        }      }    ],    "_sources": [      {        "_connector": "jms",        "_channel": "activemq"      }    ]  }}

Delete Telemetry Configs By Id#

Endpoints#

DELETE /itemsvc/api/v1/telemetryconfigs/{id}

Request#

Path parameters#

Parameter	Type	Description	Required
`id`	String	The telemetry config's id you want to delete	Required

Query parameters#

Parameter	Type	Description	Required
`nsfilter`	String	Filter by namespace	Optional

Response#

Response codes#

Code	Description
`202`	Accepted
`404`	Resource Not Found

Response header#

Header	Description
`Location`	Contains the URL for the Telemetry Config Status API.

Example#

https://xxxxxx.com/itemsvc/api/v1/telemetry_async_tasks/7d6bdcbf-67ab-44f5-8634-dd6dfa48f6c4

Update Telemetry Configs By Id#

Endpoints#

PUT /itemsvc/api/v1/telemetryconfigs/{id}

Request#

Path parameters#

Parameter	Type	Description	Required
`id`	String	The id of the telemetry config you want to update	Required

Query parameters#

Parameter	Type	Description	Required
`nsfilter`	String	Filter the telemetry configs by namespace	Required

Body parameters#

Parameter	Type	Description	Required
`_name`	String	Name your telemetry configuration in long form with a maximum of 100 characters.	Required
`_shortName`	String	Give your telemetry configuration an abbreviated name with a maximum of 22 characters.	Required
`_description`	Enter a description for the telemetry configuration	Description of the Config	Optional
`_namespaces`	Array of String	The namespaces you want to add the created configuration to.	Required
`_userType`	String	Enter a new or shared custom type with a maximum of 100 characters.	Required
`_configData`	Object	Pass your telemetry configuration data as an object./Config Data for the Telemetry Config	Required

Request body example#

{  "_name": "Telemetry Config - 1",  "_userType": "telemetry_config",  "_configData": {    "_sources": [      {        "_connector": "jms",        "_channel": "activemq"      }    ],    "_bindings": [      {        "collectionDesc": {          "_userItemId": "tempsensor_gBDjAv6dl4"        },        "query": {            "deviceType": "temp-10"        }      }    ],    "_normalizationScript":{      "_userType":"telemetry_parser_script"    }  },  "_namespaces": [    "automation_3E4tpXPu"  ],  "_shortName": "telconfig",  "_description": "Telemetry Config for project A"}

Response#

Response codes#

Code	Description
`202`	Accepted
`404`	Resource Not Found

Response header#

Header	Description
`Location`	Contains the URL for the Telemetry Config Status API.

Example#

https://xxxxxx.com/itemsvc/api/v1/telemetry_async_tasks/7d6bdcbf-67ab-44f5-8634-dd6dfa48f6c4