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": "f960e40e-3897-45d2-b910-a2530022e323",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "b0a6132d-92f2-486c-b521-c711f1fb9685",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "7eed25da-6d0f-4829-a285-bb4d21bb2c83",
"CreateDate": "2026-06-17T17:31:28.7972907-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-17T17:31:28.7972907-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "ab49e2c0-82e3-4117-ab8a-08cf98b8de0b",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-06-17T17:31:28.7972907-07:00",
"MeasurementValueNeededDate": "2026-06-17T17:31:28.7972907-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "261a60c6-7ce8-476a-b565-9e77f8e4606d",
"CreateDate": "2026-06-17T17:31:28.7972907-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-17T17:31:28.7972907-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "fea7f46a-70b3-4a2f-9ae4-122bd0e6daa0",
"EffectiveDate": "2026-06-17T17:31:28.7972907-07:00",
"StateType": {
"StateTypeId": "b950dc38-a95f-4370-a27f-7e9202ea5ff1",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "b0a6132d-92f2-486c-b521-c711f1fb9685",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "7eed25da-6d0f-4829-a285-bb4d21bb2c83",
"CreateDate": "2026-06-17T17:31:28.7972907-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-17T17:31:28.7972907-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "943762f2-7189-410d-8346-130bf8a953ee",
"CreateDate": "2026-06-17T17:31:28.7972907-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-17T17:31:28.7972907-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "5d6f2e1a-75d4-49d2-bf7a-7e6bd105dbc3",
"CreateDate": "2026-06-17T17:31:28.7972907-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-06-17T17:31:28.7972907-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "a3fa3e1c-b0cb-4599-90a7-5e4ee1926a93",
"EffectiveDate": "2026-06-17T17:31:28.7972907-07:00",
"StatusType": {
"StatusTypeId": "b6cee37a-91bd-422a-9978-7b37983e8f07",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "b0a6132d-92f2-486c-b521-c711f1fb9685",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "7eed25da-6d0f-4829-a285-bb4d21bb2c83",
"CreateDate": "2026-06-17T17:31:28.7972907-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-17T17:31:28.7972907-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "e76d0ec0-bfa8-4914-a9dd-393a7106460b",
"CreateDate": "2026-06-17T17:31:28.7972907-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-17T17:31:28.7972907-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "629a6f9a-c0a4-4174-b726-2015ab81533f",
"CreateDate": "2026-06-17T17:31:28.7972907-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-06-17T17:31:28.7972907-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "5481b131-523c-4f1a-84b1-4855eb827b7d",
"EffectiveDate": "2026-06-17T17:31:28.7972907-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "6db5e49c-3fa0-4558-8483-a5f777701a90",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "c99f342d-e798-4d5f-8ac0-2851056ce8a6",
"CreateDate": "2026-06-17T17:31:28.7972907-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-17T17:31:28.7972907-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "412ac585-1121-4952-8286-1b51a46fefaf",
"CreateDate": "2026-06-17T17:31:28.7972907-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-06-17T17:31:28.7972907-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-06-17T17:31:28.7972907-07:00",
"MeasurementValueNeededDate": "2026-06-17T17:31:28.7972907-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "e0bf7a27-aeb9-4d15-aa0d-661ff5644323",
"CreateDate": "2026-06-17T17:31:28.7972907-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-17T17:31:28.7972907-07:00",
"LastModifiedUser": "sample string 8"
},
"Total": 1,
"Message": "sample string 1"
}