Note: This page has not yet been converted to the new developer portal format. Please use Swagger to test this API.
Asset Types
Asset type management
operations.
GET /rest/v2/asset-management/asset-types
Description
getAll
Parameters
| Name | Data Type | Required? | Description |
|---|---|---|---|
alertable | boolean | n | Alertable |
includePropertyDefinitions | boolean | n | Default value: false |
searchValue | string | n | searchValue |
X-EB-Organization-Id | string | y | HTTP header |
Responses
| Code | Description |
|---|---|
200 OK | Example {}] |
Model  |
POST /rest/v2/asset-management/asset-types
Description
createAssetType
Parameters
| Name | Data Type | Required? | Description |
|---|---|---|---|
assetTypeRequest | object | y | assetTypeRequest Example Value { "alertable": true, "assetTypeTemplateId": "string", "description": "string", "iconId": "string", "name": "string", "propertyDefinitions": [ { "allowedValues": [ {} ], "assetPropertyDataType": "BOOLEAN", "assetPropertyDisplayType": "MULTIPLE", "assetPropertyType": "ADDRESS", "assetTypeId": "string", "description": "string", "id": "string", "name": "string" } ] } |
Model  | |||
X-EB-Organization-Id | string | y | HTTP header |
Responses
| Code | Description |
|---|---|
200 OK | Example Value { "alertable": true, "assetTypeTemplateId": "string", "assetTypeTemplateName": "string", "createdId": 0, "createdName": "string", "createdProxyName": "string", "createdTimestamp": "2021-04-28T16:14:14.941Z", "description": "string", "iconId": "string", "id": "string", "lastModifiedId": 0, "lastModifiedName": "string", "lastModifiedProxyName": "string", "lastModifiedTimestamp": "2021-04-28T16:14:14.941Z", "legacy": true, "name": "string", "organizationId": 0, "propertyDefinitions": [ { "allowedValues": [ {} ], "assetPropertyDataType": "BOOLEAN", "assetPropertyDisplayType": "MULTIPLE", "assetPropertyType": "ADDRESS", "assetTypeId": "string", "assetTypeTemplateId": "string", "createdId": 0, "createdName": "string", "createdProxyName": "string", "createdTimestamp": "2021-04-28T16:14:14.941Z", "description": "string", "id": "string", "lastModifiedId": 0, "lastModifiedName": "string", "lastModifiedProxyName": "string", "lastModifiedTimestamp": "2021-04-28T16:14:14.941Z", "name": "string", "organizationId": 0, "seq": 500, "vccPropertyName": "string" } ], "seq": 0 } |
Model  |
GET /rest/v2/asset-management/asset-types/name/{name}
Description
getByAssetTypeName
Parameters
| Name | Data Type | Required? | Description |
|---|---|---|---|
name | string | y | name |
X-EB-Organization-Id | string | y | HTTP header |
Responses
| Code | Description |
|---|---|
200 OK | Example { "alertable": true, "assetTypeTemplateId": "string", "assetTypeTemplateName": "string", "createdId": 0, "createdName": "string", "createdProxyName": "string", "createdTimestamp": "2021-04-28T16:55:24.358Z", "description": "string", "iconId": "string", "id": "string", "lastModifiedId": 0, "lastModifiedName": "string", "lastModifiedProxyName": "string", "lastModifiedTimestamp": "2021-04-28T16:55:24.358Z", "legacy": true, "name": "string", "organizationId": 0, "propertyDefinitions": [ { "allowedValues": [ {} ], "assetPropertyDataType": "BOOLEAN", "assetPropertyDisplayType": "MULTIPLE", "assetPropertyType": "ADDRESS", "assetTypeId": "string", "assetTypeTemplateId": "string", "createdId": 0, "createdName": "string", "createdProxyName": "string", "createdTimestamp": "2021-04-28T16:55:24.358Z", "description": "string", "id": "string", "lastModifiedId": 0, "lastModifiedName": "string", "lastModifiedProxyName": "string", "lastModifiedTimestamp": "2021-04-28T16:55:24.358Z", "name": "string", "organizationId": 0, "seq": 500, "vccPropertyName": "string" } ], "seq": 0 } |
Model  |
GET /rest/v2/asset-management/asset-types/property-definitions/{id}/linked-to-asset
Description
isLinkedToAsset
Parameters
| Name | Data Type | Required? | Description |
|---|---|---|---|
id | string | y | id |
value | string | n | value |
X-EB-Organization-Id | string | y | HTTP header |
Responses
| Code | Description |
|---|---|
200 OK | Example { "linkedToExistingAsset": true } |
Model  |
GET /rest/v2/asset-management/asset-types/sc-building
Description
getSCBuildingAssetType
Parameters
| Name | Data Type | Required? | Description |
|---|---|---|---|
X-EB-Organization-Id | string | y | HTTP header |
Responses
| Code | Description |
|---|---|
200 OK | Example { "alertable": true, "assetTypeTemplateId": "string", "assetTypeTemplateName": "string", "createdId": 0, "createdName": "string", "createdProxyName": "string", "createdTimestamp": "2021-04-28T18:59:06.971Z", "description": "string", "iconId": "string", "id": "string", "lastModifiedId": 0, "lastModifiedName": "string", "lastModifiedProxyName": "string", "lastModifiedTimestamp": "2021-04-28T18:59:06.971Z", "legacy": true, "name": "string", "organizationId": 0, "propertyDefinitions": [ { "allowedValues": [ {} ], "assetPropertyDataType": "BOOLEAN", "assetPropertyDisplayType": "MULTIPLE", "assetPropertyType": "ADDRESS", "assetTypeId": "string", "assetTypeTemplateId": "string", "createdId": 0, "createdName": "string", "createdProxyName": "string", "createdTimestamp": "2021-04-28T18:59:06.971Z", "description": "string", "id": "string", "lastModifiedId": 0, "lastModifiedName": "string", "lastModifiedProxyName": "string", "lastModifiedTimestamp": "2021-04-28T18:59:06.971Z", "name": "string", "organizationId": 0, "seq": 500, "vccPropertyName": "string" } ], "seq": 0 } |
Model  |
GET /rest/v2/asset-management/asset-types/{id}
Description
getById
Parameters
| Name | Data Type | Required? | Description |
|---|---|---|---|
id | string | y | id |
X-EB-Organization-Id | string | y | HTTP header |
Responses
| Code | Description |
|---|---|
200 OK | Example { "alertable": true, "assetTypeTemplateId": "string", "assetTypeTemplateName": "string", "createdId": 0, "createdName": "string", "createdProxyName": "string", "createdTimestamp": "2021-04-28T19:01:31.010Z", "description": "string", "iconId": "string", "id": "string", "lastModifiedId": 0, "lastModifiedName": "string", "lastModifiedProxyName": "string", "lastModifiedTimestamp": "2021-04-28T19:01:31.011Z", "legacy": true, "name": "string", "organizationId": 0, "propertyDefinitions": [ { "allowedValues": [ {} ], "assetPropertyDataType": "BOOLEAN", "assetPropertyDisplayType": "MULTIPLE", "assetPropertyType": "ADDRESS", "assetTypeId": "string", "assetTypeTemplateId": "string", "createdId": 0, "createdName": "string", "createdProxyName": "string", "createdTimestamp": "2021-04-28T19:01:31.011Z", "description": "string", "id": "string", "lastModifiedId": 0, "lastModifiedName": "string", "lastModifiedProxyName": "string", "lastModifiedTimestamp": "2021-04-28T19:01:31.011Z", "name": "string", "organizationId": 0, "seq": 500, "vccPropertyName": "string" } ], "seq": 0 } |
Model  |
PUT /rest/v2/asset-management/asset-types/{id}
Description
update
Parameters
| Name | Data Type | Required? | Description |
|---|---|---|---|
id | string | y | id |
updateAssetTypeRequest | object | y | UpdateAssetTypeRequest Example Value { "alertable": true, "description": "string", "iconId": "string", "name": "string", "propertyDefinitions": [ { "allowedValues": [ {} ], "assetPropertyDataType": "BOOLEAN", "assetPropertyDisplayType": "MULTIPLE", "assetPropertyType": "ADDRESS", "assetTypeId": "string", "description": "string", "id": "string", "name": "string" } ] } Model  |
X-EB-Organization-Id | string | y | HTTP header |
Responses
| Code | Description |
|---|---|
200 OK | Example { "alertable": true, "assetTypeTemplateId": "string", "assetTypeTemplateName": "string", "createdId": 0, "createdName": "string", "createdProxyName": "string", "createdTimestamp": "2021-04-28T19:04:58.619Z", "description": "string", "iconId": "string", "id": "string", "lastModifiedId": 0, "lastModifiedName": "string", "lastModifiedProxyName": "string", "lastModifiedTimestamp": "2021-04-28T19:04:58.619Z", "legacy": true, "name": "string", "organizationId": 0, "propertyDefinitions": [ { "allowedValues": [ {} ], "assetPropertyDataType": "BOOLEAN", "assetPropertyDisplayType": "MULTIPLE", "assetPropertyType": "ADDRESS", "assetTypeId": "string", "assetTypeTemplateId": "string", "createdId": 0, "createdName": "string", "createdProxyName": "string", "createdTimestamp": "2021-04-28T19:04:58.619Z", "description": "string", "id": "string", "lastModifiedId": 0, "lastModifiedName": "string", "lastModifiedProxyName": "string", "lastModifiedTimestamp": "2021-04-28T19:04:58.619Z", "name": "string", "organizationId": 0, "seq": 500, "vccPropertyName": "string" } ], "seq": 0 } |
Model  |
DELETE /rest/v2/asset-management/asset-types/{id}
Description
deleteAssetType
Parameters
| Name | Data Type | Required? | Description |
|---|---|---|---|
id | string | y | id |
X-EB-Organization-Id | string | y | HTTP header |
Responses
| Code | Description |
|---|---|
200 OK | Example { "alertable": true, "assetTypeTemplateId": "string", "assetTypeTemplateName": "string", "createdId": 0, "createdName": "string", "createdProxyName": "string", "createdTimestamp": "2021-04-28T19:11:32.492Z", "description": "string", "iconId": "string", "id": "string", "lastModifiedId": 0, "lastModifiedName": "string", "lastModifiedProxyName": "string", "lastModifiedTimestamp": "2021-04-28T19:11:32.492Z", "legacy": true, "name": "string", "organizationId": 0, "propertyDefinitions": [ { "allowedValues": [ {} ], "assetPropertyDataType": "BOOLEAN", "assetPropertyDisplayType": "MULTIPLE", "assetPropertyType": "ADDRESS", "assetTypeId": "string", "assetTypeTemplateId": "string", "createdId": 0, "createdName": "string", "createdProxyName": "string", "createdTimestamp": "2021-04-28T19:11:32.492Z", "description": "string", "id": "string", "lastModifiedId": 0, "lastModifiedName": "string", "lastModifiedProxyName": "string", "lastModifiedTimestamp": "2021-04-28T19:11:32.492Z", "name": "string", "organizationId": 0, "seq": 500, "vccPropertyName": "string" } ], "seq": 0 } |
Model  |