- IoT Overview
- 1. Getting Started
- 2. Creating an IoT Solution
- 2.1. Model the Device
- 2.2. Create an Instance of the Device from Template
- 2.3. Create Event Source and Threshold Policy for the Device
- 2.4. Create Event Stream for Device
- 2.5. Create Application
- 2.6. Create Event Stream for Application
- 2.7. Subscribe to Events
- 2.8. Configure the Device
- 2.9. Configure the Application
- 2.10. Send Event from Device
- 3. API Documentation
- Back to Learning Center
EventTemplate
A Device produces an “Event” when values of its attributes change. In order to scale models, connect many Devices, and avoid repetitious definition of the attributes for each new Device, a developer can streamline this process using Event Templates.
POST: CREATE EVENT TEMPLATE
Create a new event template.
URI: /eventTemplates
SAMPLE REQUEST
{
"name": "{{eventName}}",
"description": [
{
"lang": "en_US",
"text": "{{eventDescription}}"
}
],
"eventFields": [
{
"name": "{{eventFeild1Name}}",
"type": "decimal"
},
{
"name": "{{eventFeild2Name}}",
"type": "decimal"
}
],
"isActive": true,
"tags": [ "weather", "temp" ]
}
SAMPLE RESPONSE
{
"id": "8d6ff5b4-f2f7-473d-889a-0c9cf2064493",
"version": "g2wAAAABaAJtAAAADNYQX5sthJnpAABOyWEBag==",
"creation": 1441949748924,
"name": "{{eventName}}",
"description": [
{
"lang": "en_US",
"text": "{{eventDescription}}"
}
],
"eventFields": [
{
"name": "{{eventFeild1Name}}",
"type": "decimal"
},
{
"name": "{{eventFeild2Name}}",
"type": "decimal"
}
],
"isActive": false
}
GET: SEARCH EVENT TEMPLATE
This method is used search event templates based on the given filter parameters.
URI: /eventTemplates
SAMPLE REQUEST
Accept application/vnd.com.covisint.platform.eventTemplate.v1+json
Content-Type application/vnd.com.covisint.platform.eventTemplate.v1+json
Authorization Bearer 34jhbf9uinvun98v098eijre=
SAMPLE RESPONSE
[
{
"id": "8d6ff5b4-f2f7-473d-889a-0c9cf2064493",
"version": "g2wAAAACaAJtAAAADKEXbw0nGFeJAAAnxmECaAJtAAAADNYQX5sthJnpAABOyWEEag==",
"creation": 1441949748924,
"name": "{{eventName}}",
"description": [
{
"lang": "en_US",
"text": "{{eventDescription}}"
}
],
"eventFields": [
{
"name": "{{eventFeild1Name}}",
"type": "decimal",
"boundAttributeTypeId": "119b02b8-ddf1-4265-88ac-cdc746b5e283"
},
{
"name": "{{eventFeild2Name}}",
"type": "decimal"
}
],
"isActive": false
}
]
GET: GET EVENT TEMPLATE
This method is used to retrieve the requested event template.
URI: /eventTemplates/{eventTemplateId}
SAMPLE REQUEST
Accept application/vnd.com.covisint.platform.eventTemplate.v1+json
Content-Type application/vnd.com.covisint.platform.eventTemplate.v1+json
Authorization Bearer 34jhbf9uinvun98v098eijre=
SAMPLE RESPONSE
{
"id": "8d6ff5b4-f2f7-473d-889a-0c9cf2064493",
"version": "g2wAAAACaAJtAAAADKEXbw0nGFeJAAAnxmECaAJtAAAADNYQX5sthJnpAABOyWEEag==",
"creation": 1441949748924,
"name": "{{eventName}}",
"description": [
{
"lang": "en_US",
"text": "{{eventDescription}}"
}
],
"eventFields": [
{
"name": "{{eventFeild1Name}}",
"type": "decimal",
"boundAttributeTypeId": "119b02b8-ddf1-4265-88ac-cdc746b5e283"
},
{
"name": "{{eventFeild2Name}}",
"type": "decimal"
}
],
"isActive": false
}
PUT: TAG EVENT TEMPLATE
This method tags the specified event template.
URI: /eventTemplates/ {eventTemplateId}/tags/{tag}
DELETE: UNTAG EVENT TEMPLATE
Removes a tag from the event template.
URI: /eventTemplates/ {eventTemplateId}/tags/{tag}
POST: ACTIVATE EVENT TEMPLATE
Activates the event template. Invoking this on an active event template has no effect.
URI: /eventTemplates/ {eventTemplateId}/tasks/activate
POST: DEACTIVATE EVENT TEMPLATE
Deactivates the event template. Invoking this on an inactive event template has no effect.
URI: /eventTemplates/ {eventTemplateId}//tasks/deactivate