Subscription API

Overview

Subscribe to events produced throughout the platform. Subscribable events currently only includes events produced by IoT devices and Timeseries sample posting.

IMS Scopes

  • subscription_write – Grants access to modify subscription to device

Version information

Version : v3.0

NOTE: Version can be specified in this service with the query parameter ‘v=3.0’. If this parameter is not defined, the API will default to using the latest version.

License information

Terms of service : (C) 2008, 2010-2018 Johnson Controls International Plc. All rights reserved. This software constitutes the trade secrets and confidential and proprietary information of Johnson Controls International Plc. It is intended solely for use by Johnson Controls International Plc. This code may not be copied or redistributed to third parties without prior written authorization from Johnson Controls International Plc.

Definitions

Subscription

Name Schema
id
Generated by service. Ignored if submitted on POST		 string
subscriber
required		 string
source
required		 SubscriptionSource

SubscriptionSource

Name Schema
type
required		 string
id
required		 string

SubscriptionConnection

Name Schema
id
Generated by service. Ignored if submitted on POST		 string
subscriber
required		 string
connection
required		 Connection

Connection

Name Schema
type
required Must be one of the supported connection types		 string
config
required Connection params specific to the connection type		 Dictionary<string,string>

SubscriptionTopic

Name Schema
id
required		 string

SubscriptionType

Name Schema
id
required		 string

Connection Types Currently Supported

  • AzureEventHubSend