The chat responses are generated using Generative AI technology for intuitive search and may not be entirely accurate. They are not intended as professional advice. For full details, including our use rights, privacy practices and potential export control restrictions, please refer to our Generative AI Service Terms of Use and Generative AI Service Privacy Information. As this is a test version, please let us know if something irritating comes up. Like you get recommended a chocolate fudge ice cream instead of an energy managing application. If that occurs, please use the feedback button in our contact form!
Skip to content
Insights Hub and Industrial IoT

Insights Hub drives smart manufacturing through the industrial Internet of Things. Gain actionable insights with asset and operational data and improve your processes.

Integrated Data Lake Service – API Overview

Note

The new version of Private Cloud API (4.0.1) is only available for Virtual Private Cloud (VPC).

Region Europe 1

Run in Postman

Data Lake API
 3.11.0 
OAS 2.0

[ Base URL: /api/datalake/v3 ]
/insights-hub/api_specs/integrated-data-lake-v3-11-0-eu1.yaml

Service for storing Objects, download objects, add extended metadata tags,
subscribe for notifications, import tenant specific MindSphere Time
Series data, and enable data access using cross account access and STS in Integrated MindSphere Data Lake.

  • Objects reside in user specified path like below example. Extension in object name is optional. Root path can be denoted as "/"
/basefolder/subfolder/objectname.objectext
  • The following generic error codes might occur at any of the specified operations. Generic errors are prefixed with 'mdsp.core.generic.'.

    • missingParameter
    • invalidParameter
    • missingRequestBodyProperty
    • invalidRequestBodyProperty
    • unauthorized
    • forbidden
    • noMatch
    • unsupportedMediaType
    • tooManyRequests
    • internalServerError

Object List Operations

Tenants can choose to be list objects at a given path.

Objects Metadata Catalog Operations

Data Lake objects metadata catalog operations.

Object Access Operations

Data Lake object access operations.

Object Operations

Data Lake object operations.

Object Event Subscription Operations

Tenants can choose to be notified for object events (add, update or delete) for their space in Data Lake.

Time Series Bulk Import

Time Series Bulk Import Operations.

Object Operations with Access Token

Tenants can request for access token to make direct object operations in object storage

Service Document

Service Document in OData v4.0 protocol contains information about the entities. An entity is analogous to a database table. Service Document content is roughly equivalent to the names of the Tables in the database. It contains URLs for accessing those entities

Metadata Document

Metadata Document in OData v4.0 protocol contains information about the structure of the entities. This includes information like the attribute names and other details like Keys and other restrictions like nullability etc.

Data Lake Odata

Get data lake objects for a tenant based provided contract path key.

Download OpenAPI Specification

Private Cloud

New

Run in Postman
Download OpenAPI Specification

Old

Run in Postman

Data Lake API
 3.4.2 
OAS 2.0

[ Base URL: /api/datalake/v3 ]
/insights-hub/api_specs/integrated-data-lake-v3-4-2-eu1.yaml

Service for storing Objects, download objects, add extended metadata tags,
subscribe for notifications, import tenant specific MindSphere Time
Series data, and enable data access using cross account access and STS in Integrated MindSphere Data Lake.

  • Objects reside in user specified path like below example. Extension in object name is optional. Root path can be denoted as "/"
/basefolder/subfolder/objectname.objectext
  • The following generic error codes might occur at any of the specified operations. Generic errors are prefixed with 'mdsp.core.generic.'.

    • missingParameter
    • invalidParameter
    • missingRequestBodyProperty
    • invalidRequestBodyProperty
    • unauthorized
    • forbidden
    • noMatch
    • unsupportedMediaType
    • tooManyRequests
    • internalServerError

Objects Metadata Catalog Operations

Data Lake objects metadata catalog operations.

Object Access Operations

Data Lake object access operations.

Object Operations

Data Lake object operations.

Object Event Subscription Operations

Tenants can choose to be notified for object events (add, update or delete) for their space in Data Lake.

Time Series Bulk Import

Time Series Bulk Import Operations.

Object Operations with Access Token

Tenants can request for access token to make direct object operations in object storage

Download OpenAPI Specification
2025