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": "61b531e1-d244-49f6-97fb-b791b55abc4f",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "ab3f1994-81f8-4a01-a0d7-7a1e2e6f6fb6",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "0e78f49a-485a-4f22-898d-7311856028a4",
"CreateDate": "2026-03-30T16:51:29.9551196-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-30T16:51:29.9551196-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "4993d2cc-379a-45e6-a494-4e0efd378885",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-30T16:51:29.9551196-07:00",
"MeasurementValueNeededDate": "2026-03-30T16:51:29.9551196-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "0bec7899-b182-4030-af63-b11fbe522145",
"CreateDate": "2026-03-30T16:51:29.9551196-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-30T16:51:29.9551196-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "7707cc6b-3c8e-48fc-9e91-418713466f1e",
"EffectiveDate": "2026-03-30T16:51:29.9551196-07:00",
"StateType": {
"StateTypeId": "86278971-2d4c-4f78-9651-272e61e2c72e",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "ab3f1994-81f8-4a01-a0d7-7a1e2e6f6fb6",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "0e78f49a-485a-4f22-898d-7311856028a4",
"CreateDate": "2026-03-30T16:51:29.9551196-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-30T16:51:29.9551196-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "f3eb08fc-df08-44f3-a5a7-1b6f57d7c1c1",
"CreateDate": "2026-03-30T16:51:29.9551196-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-30T16:51:29.9551196-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "961279cd-cfa3-42e6-9e8c-a29dd2e8f566",
"CreateDate": "2026-03-30T16:51:29.9551196-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-30T16:51:29.9551196-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "2c628058-aeb9-4e64-9533-0c790c82e867",
"EffectiveDate": "2026-03-30T16:51:29.9551196-07:00",
"StatusType": {
"StatusTypeId": "500935bb-f0f6-4cf7-9b2f-850e61e92e4a",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "ab3f1994-81f8-4a01-a0d7-7a1e2e6f6fb6",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "0e78f49a-485a-4f22-898d-7311856028a4",
"CreateDate": "2026-03-30T16:51:29.9551196-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-30T16:51:29.9551196-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "e5165d88-3590-4f7e-85af-dfa9c529f47e",
"CreateDate": "2026-03-30T16:51:29.9551196-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-30T16:51:29.9551196-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "72277687-d5a6-4cba-aefd-f530a0f442bc",
"CreateDate": "2026-03-30T16:51:29.9551196-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-30T16:51:29.9551196-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "cf9eaba8-ff1c-4d06-b1ac-e28e23e21ea3",
"EffectiveDate": "2026-03-30T16:51:29.9551196-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "1f8d17d9-8004-45ff-978f-130d1e754a63",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "1a486e76-6dac-4ef1-b5c2-91f914690a35",
"CreateDate": "2026-03-30T16:51:29.9551196-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-30T16:51:29.9551196-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "c14ddef3-4277-45c7-8b54-0a0f739f4b3c",
"CreateDate": "2026-03-30T16:51:29.9551196-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-30T16:51:29.9551196-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-03-30T16:51:29.9551196-07:00",
"MeasurementValueNeededDate": "2026-03-30T16:51:29.9551196-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "85e94dee-24c1-44f0-a9bb-fa8e08c816c5",
"CreateDate": "2026-03-30T16:51:29.9551196-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-30T16:51:29.9551196-07:00",
"LastModifiedUser": "sample string 8"
},
"Total": 1,
"Message": "sample string 1"
}