Skip to content

IoT File Service

Idea

The IoT File Service provides the user with file management for files related to assets. The service provides an interface to manage data, search files and download them to specified agents. Files can also be uploaded to a temporary storage and managed there.

Access

For accessing this service you need to have the respective roles listed in IoT File Service roles and scopes.

A user can only interact with files within their tenant and subtenants.

Basics

The service implements CRUD (create, read, update and delete) functionality and searching for files.

Each file is linked to an asset. An asset can have multiple files attached. The asset ID is required for each request.

Each file has a set of standard properties as metadata:

  • File ID
  • File name
  • File path (location of the file in MindSphere)
  • File type (e.g., image)
  • File size
  • Description
  • Timestamps (created, updated)

The content of these files is not parsed by MindSphere and it requires custom applications or analytical tools to interpret and visualize the data.

The maximum file size that can be stored or retrieved depends on the client's network speed. The current timeout is one minute, and any file that takes longer than one minute to read or write results in an error 502 "Bad Gateway".

Versioning

The service does not provide explicit versioning. If different versions of a file need to be stored, put a version identifier in the file name to make it unique.

File Deletion

Files are always deleted physically. There is no logical delete. Files of an asset are automatically deleted if the asset is deleted physically.

Files can be queried using filtering and sorting operations. For more information refer to the Filtering documentation.

Features

The IoT File Service exposes its API for realizing the following tasks:

  • Create a new file
  • Update (overwrite) an existing file
  • Read a file
  • Delete a file
  • Search for files by metadata
  • Count and order files by metadata

Limitations

To get the current list of limitations go to release notes and choose the latest date. From there go to "MindAccess Developer Plan Subscribers and MindAccess Operator Plan Subscribers" and pick the IoT service you are interested in.

Example Scenario

The application developer of a brewery wants to store files associated to assets in order to provide additional meta information (e.g., images, technical descriptions, manuals, etc.).

The developer uses the IoT File Service to upload files to an asset.

Any questions left?

Ask the community


Except where otherwise noted, content on this site is licensed under the MindSphere Development License Agreement.