Examples as Postman collections

The Bosch IoT Things team provides the HTTP API description at apidocs.bosch-iot-suite.com - Bosch IoT Things - API v2.

To make these descriptions available in your Postman client you will need to import the content as a collection.

E.g. given your subscription is hosted on AWS, the URL where the yml file is provided by our service is:
https://things.eu-1.bosch-iot-suite.com/documentation/rest/services/things_2.yml

postman import example

tip Don’t forget to register a namespace before your first request to create a thing or a policy. Find details at Manage your namespace.

Variables

The baseUrl is configured as a variable.
You can change the variable in context of one collection

  • Open the context menu of the collection
    things-postman-edit-base-url
  • … > View more actions > Edit > Variables

Alternatively, you can configure your environment. postman environment
example

Path variables

Some of the requests work with path variables. These are easy to recognize, as they start with a colon (:) character.
Example: Create or update a Thing with a specified ID

  PUT {{baseUrl}}/things/:thingId

In such a case, the :thingId will need a specific value, following the pattern your.namespace:device-name.

To initialize such a variable see Params > Path Variables.

Example thing ID

Further reading

Find details provided by the Swagger team at their online presence: https://swagger.io/blog/news/whats-new-in-openapi-3-0/

Imprint Legal info Privacy statement