3.9.0
(ClientConfig)
(MindsphereCredentials)
Patch an aspect type Patch an aspect type. Only adding variables supported. Patching requires the inclusion of already existing variables. Other fields may be omitted. Conforms to RFC 7396 - JSON merge Patch.
(JSON)
{Keys are ifMatch
,id
,aspecttype*}
Promise
:
AspectTypeResource of type JSON
*
Filter aspect types by name or tenantId. Returns aspect types whose name or tenantId equals to filterValue. Only one field type and value can be passed at a time.
(String)
Field type on which aspect types need to be filtered.
(String)
Value based on which aspect types need to be filtered.
Promise
:
AspectTypeListResource of type JSON
*
Filter aspect types by name or tenantId. Returns aspect types whose name or tenantId starts with the filter value. Only one field type and filter value can be passed.
(String)
Field type on which aspect types need to be filtered.
(String)
Value based on which aspect types need to be filtered.
Promise
:
AspectTypeListResource of type JSON
*
Filter aspect types by name or tenantId. Returns aspect types whose name or tenantId ends with the filter value. Only one field type and filter value can be passed.
(String)
Field type on which aspect types need to be filtered.
(String)
Value based on which aspect types need to be filtered.
Promise
:
AspectTypeListResource of type JSON
*
Filter aspect types by name or tenantId. Returns aspect types whose name or tenantId contains the filter value. Only one field type and filter value can be passed.
(String)
Field type on which aspect types need to be filtered.
(String)
Value based on which aspect types need to be filtered.
Promise
:
AspectTypeListResource of type JSON
*
Filter aspect types by name or tenantId. Returns aspect types whose name or tenantId matches an array of filter values. One field type and multiple filter values can be passed.
(String)
Field type on which aspect types need to be filtered.
(String)
Variable array of values based on which aspect types need to be filtered.
Promise
:
AspectTypeListResource of type JSON
*
(ClientConfig)
(MindsphereCredentials)
Delete an asset Deletes the given asset. After deletion only users with admin role can read it, but modification is not possible anymore. It's not possible to delete an asset if it has children.
(JSON)
{Keys are ifMatch
,id
}
no response value expected for this operation
*
Deletes a file assignment from an asset Deletes a file assignment from an asset. If the asset's parent type has defined a file with the same key, the key will be displayed with the inherited value.
(JSON)
{Keys are id
,key
,ifMatch*}
Promise
:
AssetResourceWithHierarchyPath of type JSON
*
List all available assets
List all assets available for the authenticated user. ## Filter Supports all basic fields and the 'hasType' filter which search for the assets with type that originated from the given asset type. # Examples Example: This filter searches for assets which type is exactly the given type: { \"typeId\": \"mandal.ship\" }
Beyond the basic fields we can search for assets which type is inherited from the given type: { \"hasType\": \"mandal.ship\" }
(JSON)
{Keys are page,size,sort,filter,ifNoneMatch}
Promise
:
AssetListResource of type JSON
*
Patch an asset Patch an asset with the provided content. Only values can be modified, asset's structure have to be modified in asset's type. Conforms to RFC 7396 - JSON merge Patch.
(JSON)
{Keys are ifMatch
,id
,asset*}
Promise
:
AssetResourceWithHierarchyPath of type JSON
*
Filter assets by name or assetId or tenantId or externalId or subTenant or parentId or typeId. Returns assets whose name or tenantId equals to filterValue. Only one field type and value can be passed at a time.
(String)
Field type on which assets need to be filtered.
(String)
Value based on which assets need to be filtered.
Promise
:
AssetListResource of type JSON
*
Filter assets by name or assetId or tenantId or externalId or subTenant or parentId or typeId. Returns assets whose name or tenantId starts with the filter value. Only one field type and filter value can be passed.
(String)
Field type on which assets need to be filtered.
(String)
Value based on which assets need to be filtered.
Promise
:
AssetListResource of type JSON
*
Filter assets by name or assetId or tenantId or externalId or subTenant or parentId or typeId. Returns assets whose name or tenantId ends with the filter value. Only one field type and filter value can be passed.
(String)
Field type on which assets need to be filtered.
(String)
Value based on which assets need to be filtered.
Promise
:
AssetListResource of type JSON
*
Filter assets by name or assetId or tenantId or externalId or subTenant or parentId or typeId. Returns assets whose name or tenantId contains the filter value. Only one field type and filter value can be passed.
(String)
Field type on which assets need to be filtered.
(String)
Value based on which assets need to be filtered.
Promise
:
AssetListResource of type JSON
*
Filter assets by name or assetId or tenantId or externalId or subTenant or parentId or typeId. Returns assets whose name or tenantId matches an array of filter values. One field type and multiple filter values can be passed.
(String)
Field type on which assets need to be filtered.
(String)
Variable array of values based on which assets need to be filtered.
Promise
:
AssetListResource of type JSON
*
Deletes an asset and returns a boolean which confirms deletion. It internally checks existence of the asset after we receive a confirmation from server. It retries 3 times for getting the confirmation from server. After deletion only users with admin role can read it, but modification is not possible anymore. s not possible to delete an asset if it has children.
(JSON)
{Keys are ifMatch
,id
}
Promise
:
boolean
*
(ClientConfig)
(MindsphereCredentials)
Deletes a file assignment from an asset type Deletes a file assignment from an asset type. If the type's parent has defined a file with the same key, the key will be displayed with the inherited value.
(JSON)
{Keys are id
,key
,ifMatch*}
Promise
:
AssetTypeResource of type JSON
*
Patch an asset type Patch an asset type. Patching requires the inclusion of all existing variables and aspects. Missing file assignments will be deleted. Other fields may be omitted. Conforms to RFC 7396 - JSON merge Patch.
(JSON)
{Keys are ifMatch
,id
,assettype*,exploded}
Promise
:
AssetTypeResource of type JSON
*
Filter asset types by name or tenantId or parentTypeId. Returns asset types whose name or tenantId or parentTypeId equals to filterValue. Only one field type and value can be passed at a time.
(String)
Field type on which asset types need to be filtered.
(String)
Value based on which asset types need to be filtered.
Promise
:
AssetTypeListResource of type JSON
*
Filter asset types by name or tenantId or parentTypeId. Returns asset types whose name or tenantId or parentTypeId starts with the filter value. Only one field type and filter value can be passed.
(String)
Field type on which asset types need to be filtered.
(String)
Value based on which asset types need to be filtered.
Promise
:
AssetTypeListResource of type JSON
*
Filter asset types by name or tenantId or parentTypeId. Returns asset types whose name or tenantId or parentTypeId ends with the filter value. Only one field type and filter value can be passed.
(String)
Field type on which asset types need to be filtered.
(String)
Value based on which asset types need to be filtered.
Promise
:
AssetTypeListResource of type JSON
*
Filter asset types by name or tenantId or parentTypeId. Returns asset types whose name or tenantId or parentTypeId contains the filter value. Only one field type and filter value can be passed.
(String)
Field type on which asset types need to be filtered.
(String)
Value based on which asset types need to be filtered.
Promise
:
AssetTypeListResource of type JSON
*
Filter asset types by name or tenantId or parentTypeId. Returns asset types whose name or tenantId or parentTypeId matches an array of filter values. One field type and multiple filter values can be passed.
(String)
Field type on which asset types need to be filtered.
(String)
Variable array of values based on which asset types need to be filtered.
Promise
:
AssetTypeListResource of type JSON
*
(ClientConfig)
(MindsphereCredentials)
(ClientConfig)
(MindsphereCredentials)
(ClientConfig)
(MindsphereCredentials)
Delete location assigned to given asset.
(JSON)
{Keys are ifMatch
,id
}
Promise
:
AssetResourceWithHierarchyPath of type JSON
*
Create or Update location assigned to given asset
(JSON)
{Keys are ifMatch
,id
,location
}
no response value expected for this operation
(ClientConfig)
(MindsphereCredentials)