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": "c3e4a206-d2d8-4f03-86a8-ea055205f6c8",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "dc43cc06-f1c0-40df-aed6-c32ec04f1904",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "ad82e663-9d50-4d93-affe-0978a844577b",
"CreateDate": "2026-03-07T11:38:11.66292-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-07T11:38:11.66292-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "83a9cd90-26b9-4d15-8344-9a07b914b4c4",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-07T11:38:11.66292-08:00",
"MeasurementValueNeededDate": "2026-03-07T11:38:11.66292-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "68e58198-2b3e-454a-8a37-dfb2b4c093da",
"CreateDate": "2026-03-07T11:38:11.66292-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-07T11:38:11.66292-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "7aa9f9dd-4cc1-4cf9-85b1-602f2f3daae2",
"EffectiveDate": "2026-03-07T11:38:11.66292-08:00",
"StateType": {
"StateTypeId": "94b3981b-0f46-49e1-8f76-8396bd64f719",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "dc43cc06-f1c0-40df-aed6-c32ec04f1904",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "ad82e663-9d50-4d93-affe-0978a844577b",
"CreateDate": "2026-03-07T11:38:11.66292-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-07T11:38:11.66292-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "34b87a18-0aa3-409f-8290-09add245fb86",
"CreateDate": "2026-03-07T11:38:11.66292-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-07T11:38:11.66292-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "83b372f5-65f1-441c-bf5f-1bab2d60b9d2",
"CreateDate": "2026-03-07T11:38:11.66292-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-07T11:38:11.66292-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "8a1a7e65-923d-4ff2-82d5-448aad4e50cd",
"EffectiveDate": "2026-03-07T11:38:11.66292-08:00",
"StatusType": {
"StatusTypeId": "dc2fdd5c-4ab0-4420-b631-096643e6905b",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "dc43cc06-f1c0-40df-aed6-c32ec04f1904",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "ad82e663-9d50-4d93-affe-0978a844577b",
"CreateDate": "2026-03-07T11:38:11.66292-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-07T11:38:11.66292-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "3853c763-e8a9-45ad-80b0-c5555dea88f1",
"CreateDate": "2026-03-07T11:38:11.66292-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-07T11:38:11.66292-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "a06f071c-673e-4190-bbb7-9d3cc604dd69",
"CreateDate": "2026-03-07T11:38:11.66292-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-07T11:38:11.66292-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "2cd1244f-cbaa-4530-8ac7-2db974c5121b",
"EffectiveDate": "2026-03-07T11:38:11.66292-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "6b2032f2-d751-4147-b7fd-55cfe90d36c0",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "b725f974-6822-4ce6-ace6-7e67afbe7c74",
"CreateDate": "2026-03-07T11:38:11.66292-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-07T11:38:11.66292-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "84cd5245-8cdf-4692-b9cc-23b963d0659b",
"CreateDate": "2026-03-07T11:38:11.66292-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-07T11:38:11.66292-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-03-07T11:38:11.66292-08:00",
"MeasurementValueNeededDate": "2026-03-07T11:38:11.66292-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "91e55053-d62b-44b3-9032-be10a4b7885e",
"CreateDate": "2026-03-07T11:38:11.66292-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-07T11:38:11.66292-08:00",
"LastModifiedUser": "sample string 8"
},
"Total": 1,
"Message": "sample string 1"
}