GET Assets?assetId={assetId}&includeAllAncestors={includeAllAncestors}
Retrieves an asset by its Id.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| assetId |
Id of the asset |
globally unique identifier |
Required |
| includeAllAncestors |
Indicates whether to include all ancestor assets and groups or just the immediate parents |
boolean |
Default value is False |
Body Parameters
None.
Response Information
Resource Description
On success, the asset.
| Name | Description | Type | Additional information |
|---|---|---|---|
| Data | Asset |
None. |
|
| Total | integer |
None. |
|
| Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"Data": {
"AssetId": "2823ed10-e77e-4508-a8d8-4e87989240eb",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "5f43a2d6-7285-4955-a78c-4e7965d4bc8c",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "5c25bea6-93e7-412c-b037-83c56b2fdb1c",
"CreateDate": "2025-08-29T17:17:19.4280256-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-08-29T17:17:19.4280256-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "be2b2a10-5d21-429e-a1cc-3a92d98c3862",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-08-29T17:17:19.4280256-07:00",
"MeasurementValueNeededDate": "2025-08-29T17:17:19.4280256-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "a7d88541-719c-4697-9e18-dc8ded7df9ec",
"CreateDate": "2025-08-29T17:17:19.4280256-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-08-29T17:17:19.4280256-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "2e800dcf-6587-4bf7-a30b-0322d0fae1c4",
"EffectiveDate": "2025-08-29T17:17:19.4280256-07:00",
"StateType": {
"StateTypeId": "5e6ca3e9-4eab-45b2-b35a-34609b55b284",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "5f43a2d6-7285-4955-a78c-4e7965d4bc8c",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "5c25bea6-93e7-412c-b037-83c56b2fdb1c",
"CreateDate": "2025-08-29T17:17:19.4280256-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-08-29T17:17:19.4280256-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "aaeccdb9-2703-47aa-bc28-944ad59c0ab9",
"CreateDate": "2025-08-29T17:17:19.4280256-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-08-29T17:17:19.4280256-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "fee65607-5e82-4174-b9ba-134ff57b7d66",
"CreateDate": "2025-08-29T17:17:19.4280256-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-08-29T17:17:19.4280256-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "73e4c562-2e54-407a-a296-616299553863",
"EffectiveDate": "2025-08-29T17:17:19.4280256-07:00",
"StatusType": {
"StatusTypeId": "6ada5c75-74fe-4add-a2a2-e1821e8b510b",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "5f43a2d6-7285-4955-a78c-4e7965d4bc8c",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "5c25bea6-93e7-412c-b037-83c56b2fdb1c",
"CreateDate": "2025-08-29T17:17:19.4280256-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-08-29T17:17:19.4280256-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "5ec31d0c-5b31-4af7-adbc-f5ac8841bd54",
"CreateDate": "2025-08-29T17:17:19.4280256-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-08-29T17:17:19.4280256-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "ca28495c-bbf4-472d-b962-3e61e4e03724",
"CreateDate": "2025-08-29T17:17:19.4280256-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-08-29T17:17:19.4280256-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "56e80cb0-0eb6-47b6-9279-f37fd8c69498",
"EffectiveDate": "2025-08-29T17:17:19.4280256-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "440e0cd1-670a-4e7c-a0dc-1c4a040dd981",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "924ec81e-8e1a-499e-9bf8-932f41f2dd09",
"CreateDate": "2025-08-29T17:17:19.4280256-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-08-29T17:17:19.4280256-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "a6341a31-a5ba-4548-817b-327f37948033",
"CreateDate": "2025-08-29T17:17:19.4280256-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-08-29T17:17:19.4280256-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-08-29T17:17:19.4280256-07:00",
"MeasurementValueNeededDate": "2025-08-29T17:17:19.4280256-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "c77a0f9e-ac8e-4a99-afe3-986e151d623d",
"CreateDate": "2025-08-29T17:17:19.4280256-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-08-29T17:17:19.4280256-07:00",
"LastModifiedUser": "sample string 8"
},
"Total": 1,
"Message": "sample string 1"
}