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": "6ccda5c7-c610-47a7-8ce8-5d2de41cea33",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "52d6e07e-b4c1-41bb-934d-ac29171a0b23",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "0da7ac02-226a-4183-90c7-817dbaad2a05",
"CreateDate": "2026-06-01T20:25:36.7782152-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-01T20:25:36.7782152-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "99a773eb-d6d8-4b6e-a726-9edb4a8d986e",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-06-01T20:25:36.7782152-07:00",
"MeasurementValueNeededDate": "2026-06-01T20:25:36.7782152-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "9b1e5f52-c206-4711-87c0-eb422cddb8fb",
"CreateDate": "2026-06-01T20:25:36.7782152-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-01T20:25:36.7782152-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "d191c2cf-6fc2-4e46-bba7-f39a69937516",
"EffectiveDate": "2026-06-01T20:25:36.7782152-07:00",
"StateType": {
"StateTypeId": "b3dc8d2e-b893-48d9-8556-f4d11c37c815",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "52d6e07e-b4c1-41bb-934d-ac29171a0b23",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "0da7ac02-226a-4183-90c7-817dbaad2a05",
"CreateDate": "2026-06-01T20:25:36.7782152-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-01T20:25:36.7782152-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "bd7f3e5a-56c1-491e-9215-25a9a08c6143",
"CreateDate": "2026-06-01T20:25:36.7782152-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-01T20:25:36.7782152-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "fc445d3e-0957-4fdc-ab8b-c75ee91ea616",
"CreateDate": "2026-06-01T20:25:36.7782152-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-06-01T20:25:36.7782152-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "21c274c8-8d4c-42d1-bdc9-836f18c8e79b",
"EffectiveDate": "2026-06-01T20:25:36.7782152-07:00",
"StatusType": {
"StatusTypeId": "547d8ebc-6058-4fe1-adde-a0bbf3f315b2",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "52d6e07e-b4c1-41bb-934d-ac29171a0b23",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "0da7ac02-226a-4183-90c7-817dbaad2a05",
"CreateDate": "2026-06-01T20:25:36.7782152-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-01T20:25:36.7782152-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "337f25dc-adeb-4c1e-afcf-2677e9a5fcbd",
"CreateDate": "2026-06-01T20:25:36.7782152-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-01T20:25:36.7782152-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "569effe6-f2ca-4f4b-9046-bdb8e15cd3ed",
"CreateDate": "2026-06-01T20:25:36.7782152-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-06-01T20:25:36.7782152-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "9497a51d-f67b-4b17-ad9c-272ea7a3a192",
"EffectiveDate": "2026-06-01T20:25:36.7782152-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "c2e228b5-db6b-400a-8e16-9cbcf7fe2102",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "d7da2244-2bcb-49de-ab59-cb2a27eb873a",
"CreateDate": "2026-06-01T20:25:36.7782152-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-01T20:25:36.7782152-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "469ec88f-99d5-42f0-836b-db094c51c7a0",
"CreateDate": "2026-06-01T20:25:36.7782152-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-06-01T20:25:36.7782152-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-06-01T20:25:36.7782152-07:00",
"MeasurementValueNeededDate": "2026-06-01T20:25:36.7782152-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "2c884d86-a8f0-4d6b-9580-32f42af3f6fb",
"CreateDate": "2026-06-01T20:25:36.7782152-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-01T20:25:36.7782152-07:00",
"LastModifiedUser": "sample string 8"
},
"Total": 1,
"Message": "sample string 1"
}