Note: This page has not yet been converted to the new developer portal format. Please use Swagger to test this API.
Assets
Asset management operations
GET /rest/v2/asset-management/assets
Description
getAllAssets
Parameters
| Name | Data Type | Required? | Description |
|---|---|---|---|
assetTypeId | string | y | assetTypeId |
pageNumber | integer | n | pageNumber |
pageSize | integer | n | pageSize |
searchValue | string | n | searchValue |
X-EB-Organization-Id | string | y | HTTP header |
Responses
| Code | Description |
|---|---|
200 OK | Example Value { "data": [ { "address": { "city": "string", "country": "string", "postalCode": "string", "state": "string", "streetAddress1": "string", "streetAddress2": "string" }, "assetTypeId": "string", "assetTypeName": "string", "category": "string", "createdId": 0, "createdName": "string", "createdProxyName": "string", "createdTimestamp": "2021-04-28T19:37:04.639Z", "endTimestamp": 0, "externalId": "string", "geometry": "string", "iconId": "string", "id": "string", "lastModifiedId": 0, "lastModifiedName": "string", "lastModifiedProxyName": "string", "lastModifiedTimestamp": "2021-04-28T19:37:04.639Z", "name": "string", "notes": "string", "organizationId": 0, "properties": [ { "name": "string", "propertyId": "string", "value": {} } ], "startTimestamp": 0, "uploadBatchCreatedTimestamp": "2021-04-28T19:37:04.639Z" } ], "first": true, "last": true, "pageNumber": 0, "pageSize": 0, "totalCount": 0, "totalPageCount": 0 } |
Model  |
POST /rest/v2/asset-management/assets
Description
createAsset
Parameters
| Name | Data Type | Required? | Description |
|---|---|---|---|
createAssetRequest | object | y | createAssetRequest Example Value { "address": { "city": "string", "country": "string", "postalCode": "string", "state": "string", "streetAddress1": "string", "streetAddress2": "string" }, "assetTypeId": "string", "category": "string", "endTimestamp": 0, "externalId": "string", "geometry": "string", "iconId": "string", "name": "string", "notes": "string", "properties": [ { "name": "string", "propertyId": "string", "value": {} } ], "startTimestamp": 0 } Parameter content type application/json Model  |
X-EB-Organization-Id | string | y | HTTP header |
Responses
| Code | Description |
|---|---|
200 OK | Example Value { "address": { "city": "string", "country": "string", "postalCode": "string", "state": "string", "streetAddress1": "string", "streetAddress2": "string" }, "assetTypeId": "string", "assetTypeName": "string", "category": "string", "createdId": 0, "createdName": "string", "createdProxyName": "string", "createdTimestamp": "2021-04-28T19:39:52.629Z", "endTimestamp": 0, "externalId": "string", "geometry": "string", "iconId": "string", "id": "string", "lastModifiedId": 0, "lastModifiedName": "string", "lastModifiedProxyName": "string", "lastModifiedTimestamp": "2021-04-28T19:39:52.629Z", "name": "string", "notes": "string", "organizationId": 0, "properties": [ { "name": "string", "propertyId": "string", "value": {} } ], "startTimestamp": 0, "uploadBatchCreatedTimestamp": "2021-04-28T19:39:52.629Z" } |
Model  |
GET /rest/v2/asset-management/assets/asset-type-id/{assetTypeId}/external-id/{externalId}
Description
getAssetByAssetTypeIdAndExternalId
Parameters
| Name | Data Type | Required? | Description |
|---|---|---|---|
assetTypeId | string | y | assetTypeId |
externalId | string | y | externalId |
X-EB-Organization-Id | string | y | HTTP header |
Responses
| Code | Description |
|---|---|
200 OK | Example Value { "address": { "city": "string", "country": "string", "postalCode": "string", "state": "string", "streetAddress1": "string", "streetAddress2": "string" }, "assetTypeId": "string", "assetTypeName": "string", "category": "string", "createdId": 0, "createdName": "string", "createdProxyName": "string", "createdTimestamp": "2021-04-28T19:45:17.221Z", "endTimestamp": 0, "externalId": "string", "geometry": "string", "iconId": "string", "id": "string", "lastModifiedId": 0, "lastModifiedName": "string", "lastModifiedProxyName": "string", "lastModifiedTimestamp": "2021-04-28T19:45:17.221Z", "name": "string", "notes": "string", "organizationId": 0, "properties": [ { "name": "string", "propertyId": "string", "value": {} } ], "startTimestamp": 0, "uploadBatchCreatedTimestamp": "2021-04-28T19:45:17.221Z" } |
Model  |
GET /rest/v2/asset-management/assets/{id}
Description
getAsset
Parameters
| Name | Data Type | Required? | Description |
|---|---|---|---|
id | string | y | id |
X-EB-Organization-Id | string | y | HTTP header |
Responses
| Code | Description |
|---|---|
200 OK | Example Value { "address": { "city": "string", "country": "string", "postalCode": "string", "state": "string", "streetAddress1": "string", "streetAddress2": "string" }, "assetTypeId": "string", "assetTypeName": "string", "category": "string", "createdId": 0, "createdName": "string", "createdProxyName": "string", "createdTimestamp": "2021-04-28T19:49:35.237Z", "endTimestamp": 0, "externalId": "string", "geometry": "string", "iconId": "string", "id": "string", "lastModifiedId": 0, "lastModifiedName": "string", "lastModifiedProxyName": "string", "lastModifiedTimestamp": "2021-04-28T19:49:35.237Z", "name": "string", "notes": "string", "organizationId": 0, "properties": [ { "name": "string", "propertyId": "string", "value": {} } ], "startTimestamp": 0, "uploadBatchCreatedTimestamp": "2021-04-28T19:49:35.237Z" } |
Model  |
PUT /rest/v2/asset-management/assets/{id}
Description
updateAssetById
Parameters
| Name | Data Type | Required? | Description |
|---|---|---|---|
id | string | y | id |
updateAssetRequest | object | y | updateAssetRequest Example Value { "address": { "city": "string", "country": "string", "postalCode": "string", "state": "string", "streetAddress1": "string", "streetAddress2": "string" }, "assetTypeId": "string", "category": "string", "endTimestamp": 0, "externalId": "string", "geometry": "string", "iconId": "string", "name": "string", "notes": "string", "properties": [ { "name": "string", "propertyId": "string", "value": {} } ], "startTimestamp": 0 } Parameter content type application/json Model  |
X-EB-Organization-Id | string | y | HTTP header |
Responses
| Code | Description |
|---|---|
200 OK | Example Value { "address": { "city": "string", "country": "string", "postalCode": "string", "state": "string", "streetAddress1": "string", "streetAddress2": "string" }, "assetTypeId": "string", "assetTypeName": "string", "category": "string", "createdId": 0, "createdName": "string", "createdProxyName": "string", "createdTimestamp": "2021-04-28T19:51:57.834Z", "endTimestamp": 0, "externalId": "string", "geometry": "string", "iconId": "string", "id": "string", "lastModifiedId": 0, "lastModifiedName": "string", "lastModifiedProxyName": "string", "lastModifiedTimestamp": "2021-04-28T19:51:57.834Z", "name": "string", "notes": "string", "organizationId": 0, "properties": [ { "name": "string", "propertyId": "string", "value": {} } ], "startTimestamp": 0, "uploadBatchCreatedTimestamp": "2021-04-28T19:51:57.834Z" } |
Model  |
DELETE /rest/v2/asset-management/assets/{id}
Description
deleteAssetById
Parameters
| Name | Data Type | Required? | Description |
|---|---|---|---|
id | string | y | id |
X-EB-Organization-Id | string | y | HTTP header |
Responses
| Code | Description |
|---|---|
200 OK | Example Value { "address": { "city": "string", "country": "string", "postalCode": "string", "state": "string", "streetAddress1": "string", "streetAddress2": "string" }, "assetTypeId": "string", "assetTypeName": "string", "category": "string", "createdId": 0, "createdName": "string", "createdProxyName": "string", "createdTimestamp": "2021-04-28T19:57:26.291Z", "endTimestamp": 0, "externalId": "string", "geometry": "string", "iconId": "string", "id": "string", "lastModifiedId": 0, "lastModifiedName": "string", "lastModifiedProxyName": "string", "lastModifiedTimestamp": "2021-04-28T19:57:26.291Z", "name": "string", "notes": "string", "organizationId": 0, "properties": [ { "name": "string", "propertyId": "string", "value": {} } ], "startTimestamp": 0, "uploadBatchCreatedTimestamp": "2021-04-28T19:57:26.291Z" } |
Model  |