--- swagger: "2.0" x-collection-name: IBM Watson x-complete: 0 info: title: IBM Watson IoT Platform List device types description: |- 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.deviceClass - deviceInfo.fwVersion - deviceInfo.hwVersion - deviceInfo.manufacturer - deviceInfo.model The following facets are supported: - deviceInfo.deviceClass - deviceInfo.fwVersion - deviceInfo.hwVersion - deviceInfo.manufacturer - deviceInfo.model version: 1.0.0 basePath: /api/v0002 schemes: - http produces: - application/json consumes: - application/json paths: /device/types/{typeId}/devices/{deviceId}/state/{logicalInterfaceId}: get: summary: Get the state for the device with the specified id description: Retrieve the current state of the device with the specified id. operationId: retrieve-the-current-state-of-the-device-with-the-specified-id x-api-path-slug: devicetypestypeiddevicesdeviceidstatelogicalinterfaceid-get parameters: - in: query name: No Name responses: 200: description: OK tags: - Internet of Things - Device - Types - Devices - DeviceId - State - LogicalInterfaceId patch: summary: Perform an operation against the device state for a logical interface description: |- 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 the default values as defined by the schema for the logical interface. operationId: performs-the-specified-operation-against-the-device-state-for-a-logicalinterface-the-following-value x-api-path-slug: devicetypestypeiddevicesdeviceidstatelogicalinterfaceid-patch parameters: - in: query name: No Name - in: body name: Operation description: The JSON representation of an operation schema: $ref: '#/definitions/holder' responses: 200: description: OK tags: - Internet of Things - Device - Types - Devices - DeviceId - State - LogicalInterfaceId /device/types: get: summary: List device types description: |- 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.deviceClass - deviceInfo.fwVersion - deviceInfo.hwVersion - deviceInfo.manufacturer - deviceInfo.model The following facets are supported: - deviceInfo.deviceClass - deviceInfo.fwVersion - deviceInfo.hwVersion - deviceInfo.manufacturer - deviceInfo.model operationId: sorting-can-be-performed-on-any-of-the-following-properties-sortorder-can-be-reversed-by-prefixing-t x-api-path-slug: devicetypes-get parameters: - in: query name: description description: Optional filter of results by description - in: query name: id description: Optional filter of results by ID - in: query name: No Name responses: 200: description: OK tags: - Internet of Things - Device - Types /device/types/{typeId}: patch: summary: Perform an operation against a device type description: |- 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 currently associated with the device type. If any instances of the device type exist, the state for those devices will be deleted as a result of performing the **deactivate-configuration** operation. The **deactivate-configuration** operation will fail if any instances of the device type are being aggregated into an instance of a thing. operationId: performs-the-specified-operation-against-the-device-type-the-followingvalues-can-be-specified-for-th x-api-path-slug: devicetypestypeid-patch parameters: - in: body name: Device Type Operation description: The JSON representation of a device type operation schema: $ref: '#/definitions/holder' - in: query name: No Name responses: 200: description: OK tags: - Internet of Things - Device - Types /device/types/{typeId}/physicalinterface: get: summary: Get the active physical interface associated with the device type description: |- 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. operationId: retrieve-the-active-physical-interface-that-has-been-associated-with-thedevice-type--at-least-one-ac x-api-path-slug: devicetypestypeidphysicalinterface-get parameters: - in: query name: No Name responses: 200: description: OK tags: - Internet of Things - Device - Types - Physicalinterface /device/types/{typeId}/logicalinterfaces: get: summary: |- Get the list of active logical interfaces associated with the device type description: |- 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. operationId: retrieve-the-list-of-active-logical-interfaces-that-have-beenassociated-with-the-device-type--at-lea x-api-path-slug: devicetypestypeidlogicalinterfaces-get parameters: - in: query name: No Name responses: 200: description: OK tags: - Internet of Things - Device - Types - Logical interfaces /device/types/{typeId}/mappings: get: summary: Get the list of active property mappings for the device type description: |- 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. operationId: retrieve-the-list-of-active-property-mappings-for-the-specified-devicetype--a-property-mapping-defin x-api-path-slug: devicetypestypeidmappings-get parameters: - in: query name: No Name responses: 200: description: OK tags: - Internet of Things - Device - Types - Mappings /device/types/{typeId}/mappings/{logicalInterfaceId}: get: summary: |- Get the active property mappings for a specific logical interface for a device type. description: |- Retrieves the active property mappings for a specific logical interface for the device type. operationId: retrieves-the-active-property-mappings-for-a-specific-logicalinterface-for-the-device-type x-api-path-slug: devicetypestypeidmappingslogicalinterfaceid-get parameters: - in: query name: No Name responses: 200: description: OK tags: - Internet of Things - Device - Types - Mappings - LogicalInterfaceId /draft/device/types: get: summary: List device types associated with an logical or physical interface description: |- 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 specified: - logicalInterfaceId - physicalInterfaceId operationId: retrieves-the-list-of-device-types-that-are-associated-with-thelogical-interface-andor-physical-inte x-api-path-slug: draftdevicetypes-get parameters: - in: query name: No Name responses: 200: description: OK tags: - Internet of Things - Draft - Device - Types /draft/device/types/{typeId}: patch: summary: Perform an operation against a draft device type description: "Performs the specified operation against the draft device type. The\nfollowing values can be specified for the operation property:\n\n - validate-configuration\n - activate-configuration\n - list-differences\n\nThe **validate-configuration** operation will analyze all of the \nconfiguration associated with the draft device type to determine if it\nis valid. If the configuration is invalid, a list of the issues will\nbe returned in the body of the response. \n \nThe **activate-configuration** operation will make the configuration\nassociated with the draft device type active. The\n**activate-configuration** operation must have been performed against a\ndraft device type before any state is generated for instances of that\ntype.\n\nThe **list-differences** operation will return a list of the differences\nthat exist between the active configuration for the device type, if\nany, and the draft configuration." operationId: performs-the-specified-operation-against-the-draft-device-type-thefollowing-values-can-be-specified- x-api-path-slug: draftdevicetypestypeid-patch parameters: - in: body name: Device Type Operation description: The JSON representation of a device type operation schema: $ref: '#/definitions/holder' - in: query name: No Name responses: 200: description: OK tags: - Internet of Things - Draft - Device - Types /draft/device/types/{typeId}/physicalinterface: get: summary: Get the draft physical interface associated with the device type description: |- 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. operationId: retrieve-the-draft-physical-interface-that-has-been-associated-with-thedevice-type--at-least-one-act x-api-path-slug: draftdevicetypestypeidphysicalinterface-get parameters: - in: query name: No Name responses: 200: description: OK tags: - Internet of Things - Draft - Device - Types - Physicalinterface post: summary: Associate a draft physical interface with the device type description: |- 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 will be replaced with the specified physical interface. operationId: associates-a-draft-physical-interface-with-the-specified-device-typethe-draft-physical-interface-mus x-api-path-slug: draftdevicetypestypeidphysicalinterface-post parameters: - in: query name: No Name - in: body name: Physical Interface description: The JSON representation of the draft physical interface schema: $ref: '#/definitions/holder' responses: 200: description: OK tags: - Internet of Things - Draft - Device - Types - Physicalinterface delete: summary: Disassociate the draft physical interface from the device type description: Disassociates the draft physical interface from the device type. operationId: disassociates-the-draft-physical-interface-from-the-device-type x-api-path-slug: draftdevicetypestypeidphysicalinterface-delete parameters: - in: query name: No Name responses: 200: description: OK tags: - Internet of Things - Draft - Device - Types - Physicalinterface /draft/device/types/{typeId}/logicalinterfaces: get: summary: |- Get the list of draft logical interfaces associated with the device type description: |- 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. operationId: retrieve-the-list-of-draft-logical-interfaces-that-have-beenassociated-with-the-device-type--at-leas x-api-path-slug: draftdevicetypestypeidlogicalinterfaces-get parameters: - in: query name: No Name responses: 200: description: OK tags: - Internet of Things - Draft - Device - Types - Logical interfaces post: summary: Associate a draft logical interface with the device type description: |- 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. operationId: associates-a-draft-logical-interface-with-the-specified-device-typethe-draft-logical-interface-must- x-api-path-slug: draftdevicetypestypeidlogicalinterfaces-post parameters: - in: body name: Logical Interface description: The JSON representation of the draft logical interface schema: $ref: '#/definitions/holder' - in: query name: No Name responses: 200: description: OK tags: - Internet of Things - Draft - Device - Types - Logical interfaces /draft/device/types/{typeId}/logicalinterfaces/{logicalInterfaceId}: delete: summary: Disassociate a draft logical interface from the device type description: |- 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. operationId: disassociates-the-draft-logical-interface--with-the-specified-idfrom-the-device-typeplease-note-the- x-api-path-slug: draftdevicetypestypeidlogicalinterfaceslogicalinterfaceid-delete parameters: - in: query name: No Name responses: 200: description: OK tags: - Internet of Things - Draft - Device - Types - Logical interfaces - LogicalInterfaceId /draft/device/types/{typeId}/mappings: get: summary: Get the list of draft property mappings for the device type description: |- 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. operationId: retrieve-the-list-of-draft-property-mappings-for-the-specified-devicetype--a-property-mapping-define x-api-path-slug: draftdevicetypestypeidmappings-get parameters: - in: query name: No Name responses: 200: description: OK tags: - Internet of Things - Draft - Device - Types - Mappings post: summary: |- Create the draft property mappings for a logical interface for the device type description: |- 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 inbound events to the properties on the logical interface. The mappings are keyed off of the event ids defined by the physical interface associated with the device type. operationId: creates-the-draft-property-mappings-for-an-logical-interface-for-thedevice-type--the-mapping-object- x-api-path-slug: draftdevicetypestypeidmappings-post parameters: - in: body name: Device Type Property Mappings description: The JSON representation of the draft device type property mappings schema: $ref: '#/definitions/holder' - in: query name: No Name responses: 200: description: OK tags: - Internet of Things - Draft - Device - Types - Mappings /draft/device/types/{typeId}/mappings/{logicalInterfaceId}: get: summary: |- Get the draft property mappings for a specific logical interface for a device type. description: |- Retrieves the draft property mappings for a specific logical interface for the device type. operationId: retrieves-the-draft-property-mappings-for-a-specific-logicalinterface-for-the-device-type x-api-path-slug: draftdevicetypestypeidmappingslogicalinterfaceid-get parameters: - in: query name: No Name responses: 200: description: OK tags: - Internet of Things - Draft - Device - Types - Mappings - LogicalInterfaceId put: summary: |- Update the draft property mappings for a specific logical interface for the device type. description: |- Updates the draft property mappings for a specific logical interface for the device type. operationId: updates-the-draft-property-mappings-for-a-specific-logical-interfacefor-the-device-type x-api-path-slug: draftdevicetypestypeidmappingslogicalinterfaceid-put parameters: - in: body name: Device Type Property Mappings description: The JSON representation of the draft device type property mappings schema: $ref: '#/definitions/holder' - in: query name: No Name responses: 200: description: OK tags: - Internet of Things - Draft - Device - Types - Mappings - LogicalInterfaceId delete: summary: |- Delete the draft property mappings for a specific logical interface for the device type. description: |- Deletes the draft property mappings for a specific logical interface for the device type. operationId: deletes-the-draft-property-mappings-for-a-specific-logical-interfacefor-the-device-type x-api-path-slug: draftdevicetypestypeidmappingslogicalinterfaceid-delete parameters: - in: query name: No Name responses: 200: description: OK tags: - Internet of Things - Draft - Device - Types - Mappings - LogicalInterfaceId x-streamrank: polling_total_time_average: 0 polling_size_download_average: 0 streaming_total_time_average: 0 streaming_size_download_average: 0 change_yes: 0 change_no: 0 time_percentage: 0 size_percentage: 0 change_percentage: 0 last_run: "" days_run: 0 minute_run: 0 ---