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": "b00872c1-d2d0-4f13-a33c-0aa5a980b1be",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "0a55c053-5586-4e95-9bdf-6aa0aae6106e",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "bd3b9342-89aa-4660-893d-4f795b59dadd",
"CreateDate": "2025-10-22T09:11:40.0975122-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-10-22T09:11:40.0975122-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "44be3935-5378-4714-afab-70fc46961846",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-10-22T09:11:40.0975122-07:00",
"MeasurementValueNeededDate": "2025-10-22T09:11:40.0975122-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "01e4797b-0ccd-44a8-9cf7-cc4ab4ff2b5a",
"CreateDate": "2025-10-22T09:11:40.0975122-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-10-22T09:11:40.0975122-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "f215ec09-f0fe-4fb8-9158-205c6d396092",
"EffectiveDate": "2025-10-22T09:11:40.0975122-07:00",
"StateType": {
"StateTypeId": "eebfa08f-783d-4a10-80c3-a3e8295c9a39",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "0a55c053-5586-4e95-9bdf-6aa0aae6106e",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "bd3b9342-89aa-4660-893d-4f795b59dadd",
"CreateDate": "2025-10-22T09:11:40.0975122-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-10-22T09:11:40.0975122-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "ae3dd23f-88a0-44e1-8c82-0c8c5a92bfbc",
"CreateDate": "2025-10-22T09:11:40.0975122-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-10-22T09:11:40.0975122-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "cd97ab77-44d2-4dd9-8b08-e85c794890c1",
"CreateDate": "2025-10-22T09:11:40.0975122-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-10-22T09:11:40.0975122-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "22740284-a18d-40ce-ad64-962f96f457f0",
"EffectiveDate": "2025-10-22T09:11:40.0975122-07:00",
"StatusType": {
"StatusTypeId": "c68cbf99-8ade-45dc-8280-49a9aa2e7eac",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "0a55c053-5586-4e95-9bdf-6aa0aae6106e",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "bd3b9342-89aa-4660-893d-4f795b59dadd",
"CreateDate": "2025-10-22T09:11:40.0975122-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-10-22T09:11:40.0975122-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "e6983d41-69d9-4548-80c9-b74de6e8fd55",
"CreateDate": "2025-10-22T09:11:40.0975122-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-10-22T09:11:40.0975122-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "f9baf6f9-b63d-40ac-a0bd-851a3c73230d",
"CreateDate": "2025-10-22T09:11:40.0975122-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-10-22T09:11:40.0975122-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "5cfc71f6-ec0d-41de-8766-9797df01a0a7",
"EffectiveDate": "2025-10-22T09:11:40.0975122-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "71403319-9b41-46c1-8e55-605a2b40c247",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "dcdc9fa1-8d3d-45e2-8c1a-26435fa9edee",
"CreateDate": "2025-10-22T09:11:40.0975122-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-10-22T09:11:40.0975122-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "768f39d7-69ea-486d-afd9-40ca7d9be304",
"CreateDate": "2025-10-22T09:11:40.0975122-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-10-22T09:11:40.0975122-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-10-22T09:11:40.0975122-07:00",
"MeasurementValueNeededDate": "2025-10-22T09:11:40.0975122-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "7e2e88f3-bd62-4b67-96cc-07fea00a2e07",
"CreateDate": "2025-10-22T09:11:40.0975122-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-10-22T09:11:40.0975122-07:00",
"LastModifiedUser": "sample string 8"
},
"Total": 1,
"Message": "sample string 1"
}