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": "23a7933a-b506-4de6-a706-21d1a4b5a93d",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "1bd7a383-e2bd-4335-ac28-782adb56f080",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "69a4c209-2d51-4580-8fa3-42d3bd915bd1",
"CreateDate": "2025-06-02T15:05:00.2098113-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-06-02T15:05:00.2098113-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "8ca0f6e3-6623-4979-876a-a6c5599bcef7",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-06-02T15:05:00.2098113-07:00",
"MeasurementValueNeededDate": "2025-06-02T15:05:00.2098113-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "7c610bd9-32c6-4090-b14c-890e47b5a796",
"CreateDate": "2025-06-02T15:05:00.2098113-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-06-02T15:05:00.2098113-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "e32e8c52-1a38-4c84-8d68-a1f568495652",
"EffectiveDate": "2025-06-02T15:05:00.2098113-07:00",
"StateType": {
"StateTypeId": "7d7c6217-f905-457a-b620-7251d7da7982",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "1bd7a383-e2bd-4335-ac28-782adb56f080",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "69a4c209-2d51-4580-8fa3-42d3bd915bd1",
"CreateDate": "2025-06-02T15:05:00.2098113-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-06-02T15:05:00.2098113-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "27764883-0d00-4502-88a5-873851155e48",
"CreateDate": "2025-06-02T15:05:00.2098113-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-06-02T15:05:00.2098113-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "2da6a85d-1325-4509-9905-01895f6af3c6",
"CreateDate": "2025-06-02T15:05:00.2098113-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-06-02T15:05:00.2098113-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "c3f56e90-3dbc-4c91-a4c4-5964b7453819",
"EffectiveDate": "2025-06-02T15:05:00.2098113-07:00",
"StatusType": {
"StatusTypeId": "381f1efa-0be6-414d-8b92-841354873dc3",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "1bd7a383-e2bd-4335-ac28-782adb56f080",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "69a4c209-2d51-4580-8fa3-42d3bd915bd1",
"CreateDate": "2025-06-02T15:05:00.2098113-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-06-02T15:05:00.2098113-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "da703407-e418-4432-8528-f1be9def27e0",
"CreateDate": "2025-06-02T15:05:00.2098113-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-06-02T15:05:00.2098113-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "56b112f5-8a11-41dd-9f60-20819d617cd7",
"CreateDate": "2025-06-02T15:05:00.2098113-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-06-02T15:05:00.2098113-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "91161bef-ceb0-486f-b1ac-54aa0fec62da",
"EffectiveDate": "2025-06-02T15:05:00.2098113-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "26301077-9353-46c9-b970-afaf99cdd223",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "20ee5f73-ce8a-4790-be4c-c0ca20cca4f5",
"CreateDate": "2025-06-02T15:05:00.2098113-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-06-02T15:05:00.2098113-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "ea975a74-96cf-4f3f-8fb6-0e54e7647f2d",
"CreateDate": "2025-06-02T15:05:00.2098113-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-06-02T15:05:00.2098113-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-06-02T15:05:00.2098113-07:00",
"MeasurementValueNeededDate": "2025-06-02T15:05:00.2098113-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "46d0557b-1024-4481-9c01-b42808e98cb4",
"CreateDate": "2025-06-02T15:05:00.2098113-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-06-02T15:05:00.2098113-07:00",
"LastModifiedUser": "sample string 8"
},
"Total": 1,
"Message": "sample string 1"
}