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¶
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 OperationsTenants can choose to be list objects at a given path.
Tenants can choose to be list objects at a given path.
Objects Metadata Catalog OperationsData Lake objects metadata catalog operations.
Data Lake objects metadata catalog operations.
Object Access OperationsData Lake object access operations.
Data Lake object access operations.
Object OperationsData Lake object operations.
Data Lake object operations.
Object Event Subscription OperationsTenants can choose to be notified for object events (add, update or delete) for their space in Data Lake.
Tenants can choose to be notified for object events (add, update or delete) for their space in Data Lake.
Time Series Bulk ImportTime Series Bulk Import Operations.
Time Series Bulk Import Operations.
Object Operations with Access TokenTenants can request for access token to make direct object operations in object storage
Tenants can request for access token to make direct object operations in object storage
Service DocumentService 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
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 DocumentMetadata 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.
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 OdataGet data lake objects for a tenant based provided contract path key.
Get data lake objects for a tenant based provided contract path key.
Private Cloud¶
New¶
Old¶
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 OperationsData Lake objects metadata catalog operations.
Data Lake objects metadata catalog operations.
Object Access OperationsData Lake object access operations.
Data Lake object access operations.
Object OperationsData Lake object operations.
Data Lake object operations.
Object Event Subscription OperationsTenants can choose to be notified for object events (add, update or delete) for their space in Data Lake.
Tenants can choose to be notified for object events (add, update or delete) for their space in Data Lake.
Time Series Bulk ImportTime Series Bulk Import Operations.
Time Series Bulk Import Operations.
Object Operations with Access TokenTenants can request for access token to make direct object operations in object storage
Tenants can request for access token to make direct object operations in object storage