Note: This page has not yet been converted to the new developer portal format. Please use Swagger to test this API.
Asset Query
POST /rest/v2/asset-query/assets/attribute-value-list
Description
aggregateByAttribute
Parameters
| Name | Data Type | Required? | Description |
|---|---|---|---|
attributeId | string | n | attributeId |
attributeName | string | n | attributeName |
searchCriteria | string | n | searchCritera Example Value string Parameter content type application/json;charset=UTF-8 Model  |
X-EB-Organization-Id | string | y | HTTP header |
Responses
| Code | Description |
|---|---|
200 OK | Example Value [ { "aggregationResults": [ "string" ], "count": 0, "key": "string" } ] |
Model  |
POST /rest/v2/asset-query/assets/attribute-value-max-min
Description
aggregateByAttributeMaxAndMin
Parameters
| Name | Data Type | Required? | Description |
|---|---|---|---|
attributeId | string | n | attributeId |
attributeName | string | n | attributeName |
searchCriteria | string | n | searchCritera Example Value string Parameter content type application/json;charset=UTF-8 Model |
X-EB-Organization-Id | string | y | HTTP header |
Responses
| Code | Description |
|---|---|
200 OK | Example Value { "max": 0, "min": 0 } |
Model  |
POST /rest/v2/asset-query/assets/bbox
Description
geoBoundsAggregation
Parameters
| Name | Data Type | Required? | Description |
|---|---|---|---|
searchCriteria | string | n | searchCritera Example Value string Parameter content type application/json;charset=UTF-8 Model |
wrap_longitude | boolean | n | wrap_longitude Default value: true |
X-EB-Organization-Id | string | y | HTTP header |
Responses
| Code | Description |
|---|---|
200 OK | Example Value {} |
Model  |
POST /rest/v2/asset-query/assets/count
Description
count
Parameters
| Name | Data Type | Required? | Description |
|---|---|---|---|
searchCriteria | string | n | searchCritera Example Value string Parameter content type application/json;charset=UTF-8 Model |
X-EB-Organization-Id | string | y | HTTP header |
Responses
| Code | Description |
|---|---|
200 OK | Example Value { "additionalProp1": 0, "additionalProp2": 0, "additionalProp3": 0 } |
Model  |
POST /rest/v2/asset-query/assets/geohash
Description
geoGridAggregation
Parameters
| Name | Data Type | Required? | Description |
|---|---|---|---|
geohash | string | n | Geohash to use for the bounding box |
level | integer | n | The zoom level for aggregations. Valid values are between 1 and 12. Default value: 1 Example: 1 |
searchCriteria | string | n | searchCritera Example Value string Parameter content type application/json;charset=UTF-8 Model |
X-EB-Organization-Id | string | y | HTTP header |
Responses
| Code | Description |
|---|---|
200 OK | Example Value { "additionalProp1": 0, "additionalProp2": 0, "additionalProp3": 0 } |
Model  |
POST /rest/v2/asset-query/assets/polygon
Description
The list of polygon IDs
Parameters
| Name | Data Type | Required? | Description |
|---|---|---|---|
polygons | array | y | The list of polygon IDs |
searchCriteria | string | n | searchCritera Example Value string Parameter content type application/json;charset=UTF-8 Model |
X-EB-Organization-Id | string | y | HTTP header |
Responses
| Code | Description |
|---|---|
200 OK | Example Value { "additionalProp1": 0, "additionalProp2": 0, "additionalProp3": 0 } |
Model  |
POST /rest/v2/asset-query/assets/quick-search
Description
getAllAsset
Parameters
| Name | Data Type | Required? | Description |
|---|---|---|---|
assetTypeId | string | y | assetTypeId |
pageNumber | integer ($int32) | n | pageNumber. Default value: 1 |
pageSize | integer ($int32) | n | pageSize |
searchBy | string | n | searchBy. Available values: Name, NameOrExternalId |
searchValue | string | n | searchValue |
Authorization | string | y | Basic Authorization header |
X-EB-Organization-Id | string | y | Organization ID |
ids | array [string] | n | IDs Example value: [ “string” ] Parameter Content Type: application/json |
Responses
| Code | Description |
|---|---|
200 OK | Example Value { "currentPageNo": 0, "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": "2022-02-04T19:41:08.555Z", "endTimestamp": 0, "externalId": "string", "geometry": "string", "iconId": "string", "id": "string", "lastModifiedId": 0, "lastModifiedName": "string", "lastModifiedProxyName": "string", "lastModifiedTimestamp": "2022-02-04T19:41:08.555Z", "name": "string", "notes": "string", "organizationId": 0, "properties": [ { "name": "string", "propertyId": "string", "value": {} } ], "startTimestamp": 0 } ], "pageSize": 0, "start": 0, "totalCount": 0, "totalPageCount": 0 } |
Model  |
POST /rest/v2/asset-query/assets/stream
Description
stream
Parameters
| Name | Data Type | Required? | Description |
|---|---|---|---|
maxRecordsReturned | integer | n | The max number of returned records |
srt | string | n | The sort by field, sort=+name + for ASC |
searchCriteria | string | n | searchCritera Example Value string Parameter content type application/json;charset=UTF-8 Model |
X-EB-Organization-Id | string | y | HTTP header |
Responses
| Code | Description |
|---|---|
200 OK | Example Value {} |
Model  |
POST /rest/v2/asset-query/assets/{id}
Description
getAsset
Parameters
| Name | Data Type | Required? | Description |
|---|---|---|---|
id | string | n | 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-29T23:32:45.835Z", "endTimestamp": 0, "externalId": "string", "geometry": "string", "iconId": "string", "id": "string", "lastModifiedId": 0, "lastModifiedName": "string", "lastModifiedProxyName": "string", "lastModifiedTimestamp": "2021-04-29T23:32:45.835Z", "name": "string", "notes": "string", "organizationId": 0, "properties": [ { "name": "string", "propertyId": "string", "value": {} } ], "startTimestamp": 0, "uploadBatchCreatedTimestamp": "2021-04-29T23:32:45.835Z" } |
Model  |