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": "63a8ae45-4bd9-4990-b908-78cd4fe68174",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "bf7eb228-a4a4-469f-8f2e-c1cd34c94c3e",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "51e28f75-d777-4278-bdf0-34fed222366a",
"CreateDate": "2025-11-04T16:40:46.2227932-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-11-04T16:40:46.2227932-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "f8c1b5e6-9a00-4dd7-89b6-e5a98e098165",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-11-04T16:40:46.2227932-08:00",
"MeasurementValueNeededDate": "2025-11-04T16:40:46.2227932-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "54165ba8-aacf-4235-a51e-aacc7aedb532",
"CreateDate": "2025-11-04T16:40:46.2227932-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-04T16:40:46.2227932-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "f8fc7983-7584-495e-9381-990eff01e5e0",
"EffectiveDate": "2025-11-04T16:40:46.2227932-08:00",
"StateType": {
"StateTypeId": "16875d42-3c1e-4bbb-9866-6d6576ad2d8f",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "bf7eb228-a4a4-469f-8f2e-c1cd34c94c3e",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "51e28f75-d777-4278-bdf0-34fed222366a",
"CreateDate": "2025-11-04T16:40:46.2227932-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-11-04T16:40:46.2227932-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "b24320bc-e992-42b5-a3c6-66282d905183",
"CreateDate": "2025-11-04T16:40:46.2227932-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-04T16:40:46.2227932-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "2848434d-6850-4185-8cfa-1c40099a672d",
"CreateDate": "2025-11-04T16:40:46.2227932-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-11-04T16:40:46.2227932-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "2ee15341-c5b0-4232-9f28-1a738dc5cd74",
"EffectiveDate": "2025-11-04T16:40:46.2227932-08:00",
"StatusType": {
"StatusTypeId": "635d157f-0eec-4e76-aa4d-f78defb56bb1",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "bf7eb228-a4a4-469f-8f2e-c1cd34c94c3e",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "51e28f75-d777-4278-bdf0-34fed222366a",
"CreateDate": "2025-11-04T16:40:46.2227932-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-11-04T16:40:46.2227932-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "53c78302-edb8-4634-8ff5-9ef665732618",
"CreateDate": "2025-11-04T16:40:46.2227932-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-11-04T16:40:46.2227932-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "b1a6dbb0-7ed8-4902-8a52-5f9f9c739f5c",
"CreateDate": "2025-11-04T16:40:46.2227932-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-11-04T16:40:46.2227932-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "22313129-5345-452b-84ec-231ba283234b",
"EffectiveDate": "2025-11-04T16:40:46.2227932-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "03f214f5-a4ec-4d02-9fe3-192e4d3efee3",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "0155e03d-b435-444d-aba8-a746bb0853dc",
"CreateDate": "2025-11-04T16:40:46.2227932-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-11-04T16:40:46.2227932-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "d892327a-c07b-4063-8d06-897ce2cde6ca",
"CreateDate": "2025-11-04T16:40:46.2227932-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-11-04T16:40:46.2227932-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-11-04T16:40:46.2227932-08:00",
"MeasurementValueNeededDate": "2025-11-04T16:40:46.2227932-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "34cf4dad-ce5c-4d7d-b016-de5276fd67cd",
"CreateDate": "2025-11-04T16:40:46.2227932-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-11-04T16:40:46.2227932-08:00",
"LastModifiedUser": "sample string 8"
},
"Total": 1,
"Message": "sample string 1"
}