Solutions resources
An IoT developer can retrieve the data about their solutions via the
Bosch IoT Things HTTP API.
However, a more convenient user interface is offered at
Manage your solution.
Solution Model
{
"solutionId": "string",
"solutionSecret": "hashed string",
"apiToken": "string",
"serviceName": "string",
"plan": "string",
"status": {
"dataVolume": "string"
},
"_marketplace": "string",
"customer": {
"name": "string",
"email": "string",
"info": "string"
},
"namespaces": {
"namespaceId1": {
"default": false,
"searchIndex": {
"things": {
"includes": [
"thingId",
"_created",
"attrbiutes",
"definition",
"policyId"
]
}
}
},
"namespaceIdN": {
"default": true,
"searchIndex": {
"things":{
"includes": [
"thingId",
"_created",
"features(myFeature/properties/location-x)"
]
}
}
}
}
}
Caption
- The
solutionId
is generated by our service. - The
solutionSecret
is generated by our service. - The
apiToken
is generated by our service. - The
serviceName
is “things”. - The
plan
is the service plan for your instance (e.g. Free, Starter, Standard). - The
status
-dataVolume
is calculated by our service.
In case of the Free plan you have for example a volume limit of 0.5 MB, while each managed entity (e.g. one thing) counts at least with 10 kB; for larger entities the size is counted as it effectively is. - The
_marketplace
is an internal field generated by our service. - The
namespaces
can be changed by you.
See manage-namespace
Note onnamespaces
:
A solution may define various namespaces. However, only one namespace is the “default” namespace. This one will be used, in case a solution creates a Thing without explicitly specifying a namespace.
Solutions root resource
The root resource itself is the endpoint for solutions.
https://<host>/api/2/solutions
The following operations are available over the HTTP API:
Solutions - Namespaces
The more convenient way to manage your namespaces (in
case you have booked for example a Standard plan) is to use the user
interface.
See Manage your namespace.
Deletion of a namespace includes the full deletion of all entities within this namespace, such as things and policies. Deleting the entities will erase them from our data store without an option to restore.
In order to avoid that some authorized subject could delete all data just by trying out our interactive HTTP API documentation, the Solutions resource does not offer any longer the operations:
PUT /solutions/{solutionId}/namespaces
Creates or Updates the namespaces of a SolutionDELETE/solutions/{solutionId}/namespaces
Delete all namespaces of a specific Solution
However, in case you need to delete a namespace, please use the UI. The deletion of a namespace will require a second confirmation by the user. Then, it triggers the full deletion of all entities within this namespace. The progress bar displays an estimation on how long the procedure might need.
Solutions - Connections
The more convenient way to manage your connections is
to use the user interface.
See Manage your connections.
Further reading
A successful registration at the solution store is part
of the service booking. Find details at
Book the Bosch IoT Things cloud service.