Streamdata.io API Gallery - Things (Report Issue)

Organization(s):

AWS Internet of Things Create Thing

Creates a thing record in the thing registry.

AWS Internet of Things Delete Thing

Deletes the specified thing.

AWS Internet of Things Describe Thing

Gets information about the specified thing.

AWS Internet of Things List Principal Things

Lists the things associated with the specified principal.

AWS Internet of Things Update Thing

Updates the data for a thing.

IBM Watson List device types

Sorting can be performed on any of the following properties (sort order can be reversed by prefixing the property name with '-'): - id - description - deviceInfo.description - deviceInfo.descriptiveLocation - deviceInfo.serialNumber - deviceInfo.d...

IBM Watson Perform an operation against a device type

Performs the specified operation against the device type. The following values can be specified for the operation property: - deactivate-configuration The **deactivate-configuration** operation will remove any activate configuration that is cu...

IBM Watson Get the state for the device with the specified id

Retrieve the current state of the device with the specified id.

IBM Watson Perform an operation against the device state for a logical interface

Performs the specified operation against the device state for a logical interface. The following values can be specified for the operation property: - reset-state The **reset-state** operation will reset the state of the specified device to th...

IBM Watson Get the list of active logical interfaces associated with the device type

Retrieve the list of active logical interfaces that have been associated with the device type. At least one logical interface must be associated with the device type before any mappings can be defined that will generate state for the device.

IBM Watson Get the list of active property mappings for the device type

Retrieve the list of active property mappings for the specified device type. A property mapping defines how properties from inbound events are mapped to properties defined on an logical interface associated with the device type.

IBM Watson Get the active property mappings for a specific logical interface for a device type.

Retrieves the active property mappings for a specific logical interface for the device type.

IBM Watson Get the active physical interface associated with the device type

Retrieve the active physical interface that has been associated with the device type. At least one active physical interface must be associated with the device type before any mappings can be defined that will generate state for the device.

IBM Watson List device types associated with an logical or physical interface

Retrieves the list of device types that are associated with the logical interface and/or physical interface with the ids specified using the corresponding query parameters. Note that at least one of the following query parameters must be specifie...

IBM Watson Perform an operation against a draft device type

Performs the specified operation against the draft device type. The following values can be specified for the operation property: - validate-configuration - activate-configuration - list-differences The **validate-configuration** operation...

IBM Watson Get the list of draft logical interfaces associated with the device type

Retrieve the list of draft logical interfaces that have been associated with the device type. At least one active logical interface must be associated with the device type before any mappings can be defined that will generate state for the device.

IBM Watson Associate a draft logical interface with the device type

Associates a draft logical interface with the specified device type. The draft logical interface must already exist within the organization in the Watson IoT Platform.

IBM Watson Disassociate a draft logical interface from the device type

Disassociates the draft logical interface with the specified id from the device type. Please note the the delete will fail if the draft logical interface being removed from the device type is referenced in the property mappings for the device type.

IBM Watson Get the list of draft property mappings for the device type

Retrieve the list of draft property mappings for the specified device type. A property mapping defines how properties from inbound events are mapped to properties defined on an logical interface associated with the device type.

IBM Watson Create the draft property mappings for a logical interface for the device type

Creates the draft property mappings for an logical interface for the device type. The mapping object must specify: - The id for for the logical interface that the mappings are for - The mappings that define how to map from properties on the inbou...

IBM Watson Delete the draft property mappings for a specific logical interface for the device type.

Deletes the draft property mappings for a specific logical interface for the device type.

IBM Watson Get the draft property mappings for a specific logical interface for a device type.

Retrieves the draft property mappings for a specific logical interface for the device type.

IBM Watson Update the draft property mappings for a specific logical interface for the device type.

Updates the draft property mappings for a specific logical interface for the device type.

IBM Watson Disassociate the draft physical interface from the device type

Disassociates the draft physical interface from the device type.

IBM Watson Get the draft physical interface associated with the device type

Retrieve the draft physical interface that has been associated with the device type. At least one active physical interface must be associated with the device type before any mappings can be defined that will generate state for the device.

IBM Watson Associate a draft physical interface with the device type

Associates a draft physical interface with the specified device type. The draft physical interface must already exist within the organization in the Watson IoT Platform. If a draft physical interface is already associated with the device type it w...

IBM Watson Query draft event types

Event types are used to model the events that are published to the Watson IoT Platform. An event type must be created in an organization before more complex processing can be performed on the native event. The **/draft/event/types** endpoint ret...

IBM Watson Create a draft event type

Creates a new draft event type for the organization in the Watson IoT Platform. The draft event type must reference the schema definition that defines the structure of the inbound MQTT event.

IBM Watson Delete a draft event type

Deletes the draft event type with the specified id from the organization in the Watson IoT Platform. Please note the the delete will fail if the draft event type is being referenced by a physical interface.

IBM Watson Get a draft event type

Retrieve the draft event type with the specified id.

IBM Watson Update a draft event type

Updates the draft event type with the specified id. The following properties can be updated: - name - description - schemaId Note that if the description field is omitted from the body of the update, then any existing description will be r...

IBM Watson Query draft logical interfaces

Logical interfaces are used to model the interfaces exposed by a device or thing in the Watson IoT Platform. A logical interface must reference a schema definition that defines the structure of the state that will be stored for the device or thing...

IBM Watson Create a draft logical interface

Creates a new draft logical interface for the organization in the Watson IoT Platform. The logical interface must reference a schema definition that defines the structure of the state that will be stored for the device or thing.

IBM Watson Delete a draft logical interface

Deletes the draft logical interface with the specified id from the organization in the Watson IoT Platform. Please note the the delete will fail if the draft logical interface is being referenced by a device type.

IBM Watson Get a draft logical interface

Retrieve the draft logical interface with the specified id.

IBM Watson Perform an operation against a draft logical interface

Performs the specified operation against the draft logical interface. The following values can be specified for the operation property: - validate-configuration - activate-configuration - list-differences The **validate-configuration** ope...

IBM Watson Update a draft logical interface

Updates the draft logical interface with the specified id. The following properties can be updated: - name - description - schemaId Note that if the description field is omitted from the body of the update, then any existing description w...

IBM Watson Query draft rules

Rules allow you to specify conditions that can be used to trigger actions. For example, you might create a rule that sends an email if the temperature of a device exceeds a certain value. Rules are defined against a specific logical interface sch...

IBM Watson Create a draft rule

Creates a new draft rule that is associated with the logical interface for the organization in the Watson IoT Platform.

IBM Watson Delete a draft rule

Deletes the draft rule with the specified id from the organization in the Watson IoT Platform.

IBM Watson Get a draft rule

Retrieve the draft rule with the specified id that has been associated with the specified logical interface.

IBM Watson Update a draft rule

Updates the draft rule with the specified id. The following properties can be updated: - name - description - condition Note that if the description field is omitted from the body of the update, then any existing description will be remov...

IBM Watson Query draft phyiscal interfaces

Physical interfaces are used to model the interfaces between physical devices and the Watson IoT Platform. A physical interface references event types. Devices that implement a physical interface publish these events to the platform. The event ...

IBM Watson Create a draft physical interface

Creates a new draft physical interface for the organization in the Watson IoT Platform.

IBM Watson Delete a draft physical interface

Deletes the draft physical interface with the specified id from the organization in the Watson IoT Platform. Please note the the delete will fail if the draft physical interface is being referenced by a device type.

IBM Watson Get a draft physical interface

Retrieve the draft physical interface with the specified id.

IBM Watson Update a draft physical interface

Updates the draft physical interface with the specified id. The following properties can be updated: - name - description Note that if the description field is omitted from the body of the update, then any existing description will be remov...

IBM Watson Get the list of event mappings

Retrieve the list of event mappings for the draft physical interface. Event mappings are keyed off of the event id specified in the MQTT topic that the inbound events are published to.

IBM Watson Map an event to the draft physical interface

Maps an event id to a specific event type for the draft specified physical interface.

IBM Watson Remove an event mapping from the draft physical interface

Removes the event mapping with the specified id from the draft physical interface.

IBM Watson Query draft schema definitions

Schemas are used to define the structure of Events, Device State and Thing State in the Watson IoT Platform. - For Events, they define the structure of the payload of the events that are published to the platform by devices. - For Device...

IBM Watson Create a draft schema definition

Creates a new draft schema definition for the organization in the Watson IoT Platform. The schema definition file is passed to the Watson IoT Platform within a multipart POST (multipart/form-data). The body of the POST **must** contain at least ...

IBM Watson Delete a draft schema definition

Deletes the draft schema definition with the specified id from the organization in the Watson IoT Platform. Deleting the schema definition deletes both the metadata and the actual schema definition file from the Watson IoT Platform. Please note ...

IBM Watson Get draft schema definition metadata

Retrieves the metadata for the draft schema definition with the specified id.

IBM Watson Update draft schema definition metadata

Updates the metadata for the draft schema definition with the specified id. The following properties can be updated: - name - description Note that if the description field is omitted from the body of the update, then any existing descript...

IBM Watson Get the contents of the draft schema definition file

Retrieves the content of the draft schema definition file with the specified id.

IBM Watson Update the content of a draft schema definition file

Updates the content of a draft schema definition file with the specified id. The schema definition file is passed to the Watson IoT Platform within a multipart POST (multipart/form-data). The body of the POST **must** contain one part with a nam...

IBM Watson Query draft thing types

Within the Watson IoT Platform, a Thing allows you to aggregate one or more instances of a Device or Thing together to represent a more coarse grained object. For example, you might aggregrate together a temperature sensor, flow sensor and power ...

IBM Watson Create a draft thing type

Creates a new draft thing type for the organization in the Watson IoT Platform. The thing type must reference the schema definition that defines the structure of instances of the thing type.

IBM Watson Delete a draft thing type

Deletes the draft thing type with the specified id from the organization in the Watson IoT Platform. Please note the the delete will fail if there is an active version of the thing type or if the thing type is currently being referenced by anothe...

IBM Watson Get a draft thing type

Retrieve the draft thing type with the specified id.

IBM Watson Perform an operation against a draft thing type

Performs the specified operation against the draft thing type. The following values can be specified for the operation property: - validate-configuration - activate-configuration - list-differences The **validate-configuration** operation ...

IBM Watson Update a draft thing type

Updates the draft thing type with the specified id. The following properties can be updated: - name - description - schemaId - metadata Note that if the description field is omitted from the body of the update, then any existing descript...

IBM Watson Get the list of draft logical interfaces associated with the thing type

Retrieve the list of draft logical interfaces that have been associated with the draft thing type. At least one logical interface must be associated with the thing type before any mappings can be defined that will generate state for the thing.

IBM Watson Associate a draft logical interface with the draft thing type

Associates a draft logical interface with the specified draft thing type. The logical interface must already exist within the organization in the Watson IoT Platform.

IBM Watson Disassociate a logical interface from the draft thing type

Disassociates the draft logical interface with the specified id from the draft thing type. Please note the the delete will fail if the logical interface being removed from the draft thing type is referenced in the property mappings for the draft ...

IBM Watson Get the list of draft property mappings for the thing type

Retrieve the list of draft property mappings for the specified draft thing type. A property mapping defines how properties from state update events on aggregated devices or things are mapped to properties defined on a logical interface associated...

IBM Watson Create the draft property mappings for a logical interface for the thing type

Creates the draft property mappings for a logical interface for the thing type. The mapping object must specify: - The id for for the logical interface that the mappings are for - The mappings that define how to map from properties on the state ...

IBM Watson Delete the property mappings for a specific logical interface for the draft thing type.

Deletes the property mappings for a specific logical interface for the draft thing type.

IBM Watson Get the draft property mappings for a specific logical interface for a thing type.

Retrieves the draft property mappings for a specific logical interface for the thing type.

IBM Watson Update the property mappings for a specific logical interface for the thing type.

Updates the property mappings for a specific logical interface for the draft thing type.

IBM Watson Query active event types

Event types are used to model the events that are published to the Watson IoT Platform. An event type must be created in an organization before more complex processing can be performed on the native event. The **/event/types** endpoint returns t...

IBM Watson Get an active event type

Retrieve the active event type with the specified id.

IBM Watson Query active logical interfaces

Logical interfaces are used to model the interfaces exposed by a device or thing in the Watson IoT Platform. A logical interface must reference a schema definition that defines the structure of the state that will be stored for the device or thing...

IBM Watson Get an active logical interface

Retrieve the active logical interface with the specified id.

IBM Watson Perform an operation against a logical interface

Performs the specified operation against the logical interface. The following values can be specified for the operation property: - deactivate-configuration The **deactivate-configuration** operation will remove any active configuration that i...

IBM Watson Query active rules

Rules allow you to specify conditions that can be used to trigger actions. For example, you might create a rule that sends an email if the temperature of a device exceeds a certain value. Rules are defined against a specific logical interface sch...

IBM Watson Get an active rule

Retrieve the active rule with the specified id that has been associated with the specified logical interface.

IBM Watson Query active phyiscal interfaces

Physical interfaces are used to model the interfaces between physical devices and the Watson IoT Platform. A physical interface references event types. Devices that implement a physical interface publish these events to the platform. The event ...

IBM Watson Get an active physical interface

Retrieve the active physical interface with the specified id.

IBM Watson Get the list of event mappings

Retrieve the list of event mappings for the active physical interface. Event mappings are keyed off of the event id specified in the MQTT topic that the inbound events are published to.

IBM Watson Query active schema definitions

Schemas are used to define the structure of Events, Device State and Thing State in the Watson IoT Platform. - For Events, they define the structure of the payload of the events that are published to the platform by devices. - For Device...

IBM Watson Get active schema definition metadata

Retrieves the metadata for the active schema definition with the specified id.

IBM Watson Get the contents of the active schema definition file

Retrieves the content of the active schema definition file with the specified id.

IBM Watson Query active thing types

Within the Watson IoT Platform, a Thing allows you to aggregate one or more instances of a Device or Thing together to represent a more coarse grained object. For example, you might aggregrate together a temperature sensor, flow sensor and power ...

IBM Watson Get an active thing type

Retrieve the active thing type with the specified id.

IBM Watson Perform an operation against an active thing type

Performs the specified operation against the active thing type. The following values can be specified for the operation property: - deactivate-configuration The **deactivate-configuration** operation will remove any active configuration that i...

IBM Watson Get the list of active logical interfaces associated with the thing type

Retrieve the list of active logical interfaces that have been associated with the thing type. At least one logical interface must be associated with the thing type before any mappings can be defined that will generate state for the thing.

IBM Watson Get the list of active property mappings for the thing type

Retrieve the list of active property mappings for the specified thing type. A property mapping defines how properties from state update events on aggregated devices or things are mapped to properties defined on a logical interface associated with...

IBM Watson Get the active property mappings for a specific logical interface for a thing type.

Retrieves the active property mappings for a specific logical interface for the thing type.

IBM Watson List things

Within the Watson IoT Platform, a Thing allows you to aggregate one or more instances of a Device or Thing together to represent a more coarse grained object. For example, you might aggregrate together a temperature sensor, flow sensor and power ...

IBM Watson Create a thing

Creates a thing instance of the specified type for the organization in the Watson IoT Platform. The thing type must have a valid set of Information Management metadata associated with it and activated before any instances can be created.

IBM Watson Delete a thing

Deletes the thing with the specified id from the organization in the Watson IoT Platform. Please note the the delete will fail if the thing being deleted is currently being aggregated by other thing instances.

IBM Watson Get a thing

Retrieve the thing with the specified id.

IBM Watson Update a thing

Updates the thing with the specified id. The following properties can be updated: - name - description - metadata - aggregatedObjects Note that if the description field is omitted from the body of the update, then any existing descriptio...

IBM Watson Get the state for the thing with the specified id

Retrieve the current state of the thing with the specified id.

IBM Watson Perform an operation against the thing state for a logical interface

Performs the specified operation against the thing state for a logical interface. The following values can be specified for the operation property: - reset-state The **reset-state** operation will reset the state of the specified thing instanc...

Submit Your API

Join the gallery to find out how much you can save with Streamdata.io.