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": "fc8481d0-26c8-464f-a726-a3bbdae4a61c",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "bd9debc4-2442-4af0-a4d8-f309e10fe145",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "7011acdd-5093-41d5-bf08-f3735bd2b48a",
"CreateDate": "2026-02-15T08:59:49.3201215-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-15T08:59:49.3201215-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "4846e13a-586a-4bd5-a164-8d81696090f9",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-02-15T08:59:49.3201215-08:00",
"MeasurementValueNeededDate": "2026-02-15T08:59:49.3201215-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "b4d3f51c-4cef-48bf-8221-23e6133bc1f1",
"CreateDate": "2026-02-15T08:59:49.3201215-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-15T08:59:49.3201215-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "40b18c5c-b811-47b0-888b-08e775ee2516",
"EffectiveDate": "2026-02-15T08:59:49.3201215-08:00",
"StateType": {
"StateTypeId": "5286c4bc-fbf4-439d-8afa-5057d54e8ec6",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "bd9debc4-2442-4af0-a4d8-f309e10fe145",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "7011acdd-5093-41d5-bf08-f3735bd2b48a",
"CreateDate": "2026-02-15T08:59:49.3201215-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-15T08:59:49.3201215-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "0ba58f92-2ad5-4836-8105-ecf04991f13c",
"CreateDate": "2026-02-15T08:59:49.3201215-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-15T08:59:49.3201215-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "54392abf-5ec1-4f8d-8a97-edd7592879e7",
"CreateDate": "2026-02-15T08:59:49.3201215-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-02-15T08:59:49.3201215-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "e051af34-3b9c-493d-b57e-5d69c00ee931",
"EffectiveDate": "2026-02-15T08:59:49.3201215-08:00",
"StatusType": {
"StatusTypeId": "9c3b303a-3b14-444a-a510-95f1f26df9ce",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "bd9debc4-2442-4af0-a4d8-f309e10fe145",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "7011acdd-5093-41d5-bf08-f3735bd2b48a",
"CreateDate": "2026-02-15T08:59:49.3201215-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-15T08:59:49.3201215-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "816a2a24-888f-45fa-8846-22965c1a2f46",
"CreateDate": "2026-02-15T08:59:49.3201215-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-02-15T08:59:49.3201215-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "002f3e75-fffa-4678-90d5-a3ad76874f31",
"CreateDate": "2026-02-15T08:59:49.3201215-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-02-15T08:59:49.3201215-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "2bba4761-5f9b-4033-b83c-4088d483aa5a",
"EffectiveDate": "2026-02-15T08:59:49.3201215-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "ca6f9675-7745-4c77-81f4-50ceb971ba7c",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "379a45e1-86c0-4b56-9fd7-f7e8b32f6be1",
"CreateDate": "2026-02-15T08:59:49.3201215-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-02-15T08:59:49.3201215-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "68d6aa5c-b178-4dd0-8fb9-34473c0db429",
"CreateDate": "2026-02-15T08:59:49.3201215-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-02-15T08:59:49.3201215-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-02-15T08:59:49.3201215-08:00",
"MeasurementValueNeededDate": "2026-02-15T08:59:49.3201215-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "0b44a361-be21-4efe-ba56-42aee5fd1673",
"CreateDate": "2026-02-15T08:59:49.3201215-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-15T08:59:49.3201215-08:00",
"LastModifiedUser": "sample string 8"
},
"Total": 1,
"Message": "sample string 1"
}