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": "f1f5b20b-f398-4b1d-9aec-68bc2402d1ce",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "4ee88bea-6a62-4103-9ffb-58d69f5d0346",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "5c0d9e4d-419a-426f-8601-6f3a968f8604",
"CreateDate": "2026-02-02T20:45:11.9240557-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-02T20:45:11.9240557-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "7e699ed3-adc5-45a5-ad3c-a468b3a67c59",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-02-02T20:45:11.9240557-08:00",
"MeasurementValueNeededDate": "2026-02-02T20:45:11.9240557-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "6cd0e64f-7675-49b8-91f5-bc389b371ed4",
"CreateDate": "2026-02-02T20:45:11.9240557-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-02T20:45:11.9240557-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "667fe8f7-5198-44df-8337-0f0f7cfbf7e0",
"EffectiveDate": "2026-02-02T20:45:11.9240557-08:00",
"StateType": {
"StateTypeId": "8982d442-b38a-40a7-9ec7-550d9d3b54de",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "4ee88bea-6a62-4103-9ffb-58d69f5d0346",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "5c0d9e4d-419a-426f-8601-6f3a968f8604",
"CreateDate": "2026-02-02T20:45:11.9240557-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-02T20:45:11.9240557-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "fdfb3c9d-3e47-4a0c-8fa6-809fda8ea3a2",
"CreateDate": "2026-02-02T20:45:11.9240557-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-02T20:45:11.9240557-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "54a3e6bb-74b2-4e80-8634-7253d0ca075c",
"CreateDate": "2026-02-02T20:45:11.9240557-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-02-02T20:45:11.9240557-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "2c2a5621-5018-4726-bd26-9f8cdca05822",
"EffectiveDate": "2026-02-02T20:45:11.9240557-08:00",
"StatusType": {
"StatusTypeId": "a765b327-d7a4-44c4-b8c2-9f589b5957e7",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "4ee88bea-6a62-4103-9ffb-58d69f5d0346",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "5c0d9e4d-419a-426f-8601-6f3a968f8604",
"CreateDate": "2026-02-02T20:45:11.9240557-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-02T20:45:11.9240557-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "be1e9dae-5a31-44de-9371-06bc6ae1aff4",
"CreateDate": "2026-02-02T20:45:11.9240557-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-02-02T20:45:11.9240557-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "bf423355-d8e6-46fa-969a-7d9883baa2ca",
"CreateDate": "2026-02-02T20:45:11.9240557-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-02-02T20:45:11.9240557-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "08033eae-ba72-4b51-b645-f3662f041206",
"EffectiveDate": "2026-02-02T20:45:11.9240557-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "3421c7bc-a223-4e8e-a13c-e849250dea7c",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "726fb25b-466b-409e-a456-854feba6355f",
"CreateDate": "2026-02-02T20:45:11.9240557-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-02-02T20:45:11.9240557-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "9ce226b3-760d-43df-a09b-a3cf3abe9003",
"CreateDate": "2026-02-02T20:45:11.9240557-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-02-02T20:45:11.9240557-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-02-02T20:45:11.9240557-08:00",
"MeasurementValueNeededDate": "2026-02-02T20:45:11.9240557-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "714e9aae-2451-423a-93f4-74ac260a4e07",
"CreateDate": "2026-02-02T20:45:11.9240557-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-02T20:45:11.9240557-08:00",
"LastModifiedUser": "sample string 8"
},
"Total": 1,
"Message": "sample string 1"
}