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": "880253e3-b967-4ad5-8ed6-88837ea0cf8e",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "d3853ca0-f5cd-4ba5-adb1-0cd66204be1b",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "e3439245-da83-49fa-b9c7-35ca6f22f735",
"CreateDate": "2026-05-12T17:08:10.0608176-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-12T17:08:10.0608176-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "b5874aee-ab45-45e1-8803-99658cdda26c",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-05-12T17:08:10.0608176-07:00",
"MeasurementValueNeededDate": "2026-05-12T17:08:10.0608176-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "b7723745-3bf9-44cc-b30f-31c542a55e49",
"CreateDate": "2026-05-12T17:08:10.0608176-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-12T17:08:10.0608176-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "40041790-53c9-47f0-b1ac-8fb88e5c8109",
"EffectiveDate": "2026-05-12T17:08:10.0608176-07:00",
"StateType": {
"StateTypeId": "458e9f94-183d-44f3-ace0-ded96e3d4dd1",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "d3853ca0-f5cd-4ba5-adb1-0cd66204be1b",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "e3439245-da83-49fa-b9c7-35ca6f22f735",
"CreateDate": "2026-05-12T17:08:10.0608176-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-12T17:08:10.0608176-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "e0df7d7e-0d34-43d7-8b15-923ab5788fa9",
"CreateDate": "2026-05-12T17:08:10.0608176-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-12T17:08:10.0608176-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "bdbb303e-156c-4526-a2a4-366c3dd2e975",
"CreateDate": "2026-05-12T17:08:10.0608176-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-05-12T17:08:10.0608176-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "6c4f1312-0ee0-4d39-9946-959c5a7346d5",
"EffectiveDate": "2026-05-12T17:08:10.0608176-07:00",
"StatusType": {
"StatusTypeId": "46b613b0-7e1c-42f7-a945-cd3291e41eed",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "d3853ca0-f5cd-4ba5-adb1-0cd66204be1b",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "e3439245-da83-49fa-b9c7-35ca6f22f735",
"CreateDate": "2026-05-12T17:08:10.0608176-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-12T17:08:10.0608176-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "5e49ac1f-de05-479b-9d5a-c50863b0e157",
"CreateDate": "2026-05-12T17:08:10.0608176-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-12T17:08:10.0608176-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "67832dc4-2716-4514-9ec1-5cbfe6c9902f",
"CreateDate": "2026-05-12T17:08:10.0608176-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-05-12T17:08:10.0608176-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "14c104a4-432b-46b5-a528-0a3e233504ea",
"EffectiveDate": "2026-05-12T17:08:10.0608176-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "05b12f35-1be1-4d7b-afec-21e0f7d632e9",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "fd3a589a-ece8-419a-b64b-2d08e5a16760",
"CreateDate": "2026-05-12T17:08:10.0608176-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-12T17:08:10.0608176-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "deddcf41-6ca0-4c0b-b8a6-7bd31d3fa0c9",
"CreateDate": "2026-05-12T17:08:10.0608176-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-05-12T17:08:10.0608176-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-05-12T17:08:10.0608176-07:00",
"MeasurementValueNeededDate": "2026-05-12T17:08:10.0608176-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "13864ffd-daf7-4107-a726-3d1be71987af",
"CreateDate": "2026-05-12T17:08:10.0608176-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-12T17:08:10.0608176-07:00",
"LastModifiedUser": "sample string 8"
},
"Total": 1,
"Message": "sample string 1"
}