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": "f8fc61a5-8c06-4abe-8648-6922df39d1c7",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "d3c4271c-5ff3-471a-997c-0173eafd7424",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "b39073eb-d9bf-4d3d-957c-805afc0e265d",
"CreateDate": "2026-11-22T14:13:01.2538823-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-22T14:13:01.2538823-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "581ce1e8-fb1f-4e5b-8486-1e133fbcad2a",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-11-22T14:13:01.2538823-08:00",
"MeasurementValueNeededDate": "2026-11-22T14:13:01.2538823-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "e84a7f75-d9b9-4139-b2c0-a61ebe9703ac",
"CreateDate": "2026-11-22T14:13:01.2538823-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-22T14:13:01.2538823-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "a780802f-1591-4a5c-98d4-cc17c14e6d54",
"EffectiveDate": "2026-11-22T14:13:01.2538823-08:00",
"StateType": {
"StateTypeId": "5be6b887-70d1-4255-bc01-437d5ba63331",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "d3c4271c-5ff3-471a-997c-0173eafd7424",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "b39073eb-d9bf-4d3d-957c-805afc0e265d",
"CreateDate": "2026-11-22T14:13:01.2538823-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-22T14:13:01.2538823-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "3ca2cbe9-8a55-4dc6-a9ef-e84c287c8b02",
"CreateDate": "2026-11-22T14:13:01.2538823-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-22T14:13:01.2538823-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "d46446a4-098c-4b53-833d-4a2809f6b0d9",
"CreateDate": "2026-11-22T14:13:01.2538823-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-22T14:13:01.2538823-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "d2a6993d-7ce7-48bd-ba77-2cba07507568",
"EffectiveDate": "2026-11-22T14:13:01.2538823-08:00",
"StatusType": {
"StatusTypeId": "80cfbe3c-1fd7-4b70-b291-e7f602415b72",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "d3c4271c-5ff3-471a-997c-0173eafd7424",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "b39073eb-d9bf-4d3d-957c-805afc0e265d",
"CreateDate": "2026-11-22T14:13:01.2538823-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-22T14:13:01.2538823-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "1157d654-1be9-4c58-a4a1-fb0baca8c9cc",
"CreateDate": "2026-11-22T14:13:01.2538823-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-22T14:13:01.2538823-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "b857817e-fcd8-4427-93d3-58cb7e859630",
"CreateDate": "2026-11-22T14:13:01.2538823-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-22T14:13:01.2538823-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "644af010-dd67-4972-b0ab-7870af42f61d",
"EffectiveDate": "2026-11-22T14:13:01.2538823-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "e88f9fbe-dd6e-418e-972e-f3ce15784869",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "e9d4b796-171e-4285-ae87-efc6e7dee657",
"CreateDate": "2026-11-22T14:13:01.2538823-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-22T14:13:01.2538823-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "3f4f84b8-c35b-41e1-b60c-3de010579092",
"CreateDate": "2026-11-22T14:13:01.2538823-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-22T14:13:01.2538823-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-11-22T14:13:01.2538823-08:00",
"MeasurementValueNeededDate": "2026-11-22T14:13:01.2538823-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "c67c0b95-faba-44ce-911c-9f10e93c3619",
"CreateDate": "2026-11-22T14:13:01.2538823-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-22T14:13:01.2538823-08:00",
"LastModifiedUser": "sample string 8"
},
"Total": 1,
"Message": "sample string 1"
}