| Method | HTTP request | Description |
|---|---|---|
| deleteAssetProfile | DELETE /api/assetProfile/{assetProfileId} | Delete asset profile (deleteAssetProfile) |
| getAssetProfileById | GET /api/assetProfile/{assetProfileId} | Get Asset Profile (getAssetProfileById) |
| getAssetProfileInfoById | GET /api/assetProfileInfo/{assetProfileId} | Get Asset Profile Info (getAssetProfileInfoById) |
| getAssetProfileInfos | GET /api/assetProfileInfos | Get Asset Profile infos (getAssetProfileInfos) |
| getAssetProfileNames | GET /api/assetProfile/names | Get Asset Profile names (getAssetProfileNames) |
| getAssetProfiles | GET /api/assetProfiles | Get Asset Profiles (getAssetProfiles) |
| getAssetProfilesByIds | GET /api/assetProfileInfos/list | Get Asset Profiles By Ids (getAssetProfilesByIds) |
| getDefaultAssetProfileInfo | GET /api/assetProfileInfo/default | Get Default Asset Profile (getDefaultAssetProfileInfo) |
| saveAssetProfile | POST /api/assetProfile | Create Or Update Asset Profile (saveAssetProfile) |
| setDefaultAssetProfile | POST /api/assetProfile/{assetProfileId}/default | Make Asset Profile Default (setDefaultAssetProfile) |
deleteAssetProfile(assetProfileId)
Delete asset profile (deleteAssetProfile)
Deletes the asset profile. Referencing non-existing asset profile Id will cause an error. Can't delete the asset profile if it is referenced by existing assets. Available for users with 'TENANT_ADMIN' authority.
| Name | Type | Description | Notes |
|---|---|---|---|
| assetProfileId | String | A string value representing the asset profile id. For example, '784f394c-42b6-435a-983c-b7beff2784f9' |
null (empty response body)
AssetProfile getAssetProfileById(assetProfileId, inlineImages)
Get Asset Profile (getAssetProfileById)
Fetch the Asset Profile object based on the provided Asset Profile Id. The server checks that the asset profile is owned by the same tenant. Available for users with 'TENANT_ADMIN' authority.
| Name | Type | Description | Notes |
|---|---|---|---|
| assetProfileId | String | A string value representing the asset profile id. For example, '784f394c-42b6-435a-983c-b7beff2784f9' | |
| inlineImages | Boolean | Inline images as a data URL (Base64) | [optional] |
AssetProfile
AssetProfileInfo getAssetProfileInfoById(assetProfileId)
Get Asset Profile Info (getAssetProfileInfoById)
Fetch the Asset Profile Info object based on the provided Asset Profile Id. Asset Profile Info is a lightweight object that includes main information about Asset Profile. Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority.
| Name | Type | Description | Notes |
|---|---|---|---|
| assetProfileId | String | A string value representing the asset profile id. For example, '784f394c-42b6-435a-983c-b7beff2784f9' |
AssetProfileInfo
PageDataAssetProfileInfo getAssetProfileInfos(pageSize, page, textSearch, sortProperty, sortOrder)
Get Asset Profile infos (getAssetProfileInfos)
Returns a page of asset profile info objects owned by tenant. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. Asset Profile Info is a lightweight object that includes main information about Asset Profile. Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority.
| Name | Type | Description | Notes |
|---|---|---|---|
| pageSize | Integer | Maximum amount of entities in a one page | |
| page | Integer | Sequence number of page starting from 0 | |
| textSearch | String | The case insensitive 'substring' filter based on the asset profile name. | [optional] |
| sortProperty | String | Property of entity to sort by | [optional] [enum: createdTime, name, description, isDefault] |
| sortOrder | String | Sort order. ASC (ASCENDING) or DESC (DESCENDING) | [optional] [enum: ASC, DESC] |
PageDataAssetProfileInfo
List getAssetProfileNames(activeOnly)
Get Asset Profile names (getAssetProfileNames)
Returns a set of unique asset profile names owned by the tenant. Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority.
| Name | Type | Description | Notes |
|---|---|---|---|
| activeOnly | Boolean | Flag indicating whether to retrieve exclusively the names of asset profiles that are referenced by tenant's assets. | [optional] [default to false] |
List
PageDataAssetProfile getAssetProfiles(pageSize, page, textSearch, sortProperty, sortOrder)
Get Asset Profiles (getAssetProfiles)
Returns a page of asset profile objects owned by tenant. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. Available for users with 'TENANT_ADMIN' authority.
| Name | Type | Description | Notes |
|---|---|---|---|
| pageSize | Integer | Maximum amount of entities in a one page | |
| page | Integer | Sequence number of page starting from 0 | |
| textSearch | String | The case insensitive 'substring' filter based on the asset profile name. | [optional] |
| sortProperty | String | Property of entity to sort by | [optional] [enum: createdTime, name, description, isDefault] |
| sortOrder | String | Sort order. ASC (ASCENDING) or DESC (DESCENDING) | [optional] [enum: ASC, DESC] |
PageDataAssetProfile
List getAssetProfilesByIds(assetProfileIds)
Get Asset Profiles By Ids (getAssetProfilesByIds)
Requested asset profiles must be owned by tenant which is performing the request.
| Name | Type | Description | Notes |
|---|---|---|---|
| assetProfileIds | List | A list of asset profile ids, separated by comma ',' |
List
AssetProfileInfo getDefaultAssetProfileInfo()
Get Default Asset Profile (getDefaultAssetProfileInfo)
Fetch the Default Asset Profile Info object. Asset Profile Info is a lightweight object that includes main information about Asset Profile. Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority.
AssetProfileInfo
AssetProfile saveAssetProfile(assetProfile)
Create Or Update Asset Profile (saveAssetProfile)
Create or update the Asset Profile. When creating asset profile, platform generates asset profile id as time-based UUID. The newly created asset profile id will be present in the response. Specify existing asset profile id to update the asset profile. Referencing non-existing asset profile Id will cause 'Not Found' error. Asset profile name is unique in the scope of tenant. Only one 'default' asset profile may exist in scope of tenant. Remove 'id', 'tenantId' from the request body example (below) to create new Asset Profile entity. Available for users with 'TENANT_ADMIN' authority.
| Name | Type | Description | Notes |
|---|---|---|---|
| assetProfile | AssetProfile |
AssetProfile
AssetProfile setDefaultAssetProfile(assetProfileId)
Make Asset Profile Default (setDefaultAssetProfile)
Marks asset profile as default within a tenant scope. Available for users with 'TENANT_ADMIN' authority.
| Name | Type | Description | Notes |
|---|---|---|---|
| assetProfileId | String | A string value representing the asset profile id. For example, '784f394c-42b6-435a-983c-b7beff2784f9' |
AssetProfile