- 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
Routes
Routes connect source and destination topics.
POST: CREATE ROUTE
Create a new route.
URI: /routes
SAMPLE REQUEST
Accept: application/vnd.com.covisint.platform.messaging.route.v1+json
Content-type: application/vnd.com.covisint.platform.messaging.route.v1+json
x-Realm:
{
"routeType": "EVENT",
"streamId": "stream01",
"routeSourceId": "5acb7b8e017x",
"routingTopic": "RoutingTopic01",
"workflowId": "workflow_1",
"workflowTopic": "WorkflowTopic01",
"workflowTopology": "WorkflowTopology01"
}
SAMPLE RESPONSE
{
"id": "bf069bb8-c4cf-418f-814f-216b4aac7ec2",
"version": "g2wAAAABaAJtAAAADNYQX5stnA6MAAAEdGEBag==",
"creation": 1442389711913,
"routeId": "bf069bb8-c4cf-418f-814f-216b4aac7ec2",
"routeSourceId": "5acb7b8e017x",
"routeType": "EVENT",
"streamId": "stream01",
"workflowId": "workflow_1",
"workflowTopology": "WorkflowTopology01",
"workflowTopic": "WorkflowTopic01",
"routingTopic": "RoutingTopic01"
}
GET: LIST ROUTE
List of available routes.
URI: /routes
SAMPLE REQUEST
Accept: application/vnd.com.covisint.platform.messaging.route.v1+json
Authorization Bearer 34jhbf9uinvun98v098eijre
SAMPLE RESPONSE
[
{
"id": "bd8e0952-a7fa-4654-86b2-687e94a527e6",
"version": "g2wAAAABaAJtAAAADCDMPMOaSzKTAAE5fWEBag==",
"creation": 1441795645043,
"routeId": "bd8e0952-a7fa-4654-86b2-687e94a527e6",
"routeSourceId": "5acb7b8e017x",
"routeType": "EVENT",
"streamId": "stream01",
"workflowId": "workflow_1",
"workflowTopology": "WorkflowTopology01",
"workflowTopic": "WorkflowTopic01",
"routingTopic": "RoutingTopic01"
}
]
GET: GET ROUTE
This method is used to retrieve the requested route.
URI: /routes/{routeId}
SAMPLE REQUEST
Accept: application/vnd.com.covisint.platform.messaging.route.v1+json
Authorization Bearer 34jhbf9uinvun98v098eijre
SAMPLE RESPONSE
{
"id": "bd8e0952-a7fa-4654-86b2-687e94a527e6",
"version": "g2wAAAABaAJtAAAADCDMPMOaSzKTAAE5fWEBag==",
"creation": 1441795645043,
"routeId": "bd8e0952-a7fa-4654-86b2-687e94a527e6",
"routeSourceId": "5acb7b8e017x",
"routeType": "EVENT",
"streamId": "stream01",
"workflowId": "workflow_1",
"workflowTopology": "WorkflowTopology01",
"workflowTopic": "WorkflowTopic01",
"routingTopic": "RoutingTopic01"
}
PUT: UPDATE ROUTE
This method updates the route.
URI: /routes/{routeId}
SAMPLE REQUEST
Accept: application/vnd.com.covisint.platform.messaging.route.v1+json
Authorization Bearer 34jhbf9uinvun98v098eijre
{
"id": "bf069bb8-c4cf-418f-814f-216b4aac7ec2",
"version": "0",
"creation": 1442389711913,
"routeId": "bf069bb8-c4cf-418f-814f-216b4aac7ec2",
"routeSourceId": "5acb7b8e017x",
"routeType": "EVENT",
"streamId": "stream01",
"workflowId": "workflow_1",
"workflowTopology": "WorkflowTopology02",
"workflowTopic": "WorkflowTopic02",
"routingTopic": "RoutingTopic02"
}
SAMPLE RESPONSE
{
"id": "bf069bb8-c4cf-418f-814f-216b4aac7ec2",
"version": "g2wAAAACaAJtAAAADKEXbw0nF1JWAAAEfmEBaAJtAAAADNYQX5stnA6MAAAEdGEBag==",
"creation": 1442395373085,
"routeId": "bf069bb8-c4cf-418f-814f-216b4aac7ec2",
"routeSourceId": "5acb7b8e017x",
"routeType": "EVENT",
"streamId": "stream01",
"workflowId": "workflow_1",
"workflowTopology": "WorkflowTopology02",
"workflowTopic": "WorkflowTopic02",
"routingTopic": "RoutingTopic02"
}
DELETE: DELETE ROUTE
Deletes an existing route. Throws an error if {routeId} does not already exist.
URI: /routes/{routeId}
SAMPLE REQUEST
Accept: application/vnd.com.covisint.platform.messaging.route.v1+json
x-realm :