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": "8ebfaaea-d24c-4e80-8d60-fa2342186f2a",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "a80af011-5d24-4cd8-8821-b732e36df7c6",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "2f36306d-8c0c-472f-a39b-880f1baca9b1",
"CreateDate": "2025-10-13T15:21:17.3433049-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-10-13T15:21:17.3433049-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "89daabfc-ba02-4362-9271-0f889ed71765",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-10-13T15:21:17.3433049-07:00",
"MeasurementValueNeededDate": "2025-10-13T15:21:17.3433049-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "e1f69c9e-8ec4-404a-956c-e877d5b6f552",
"CreateDate": "2025-10-13T15:21:17.3433049-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-10-13T15:21:17.3433049-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "c792bd4f-c788-4f08-bb07-6e5632c33e73",
"EffectiveDate": "2025-10-13T15:21:17.3433049-07:00",
"StateType": {
"StateTypeId": "302cf3ef-9391-4475-8e2a-21275a19bdce",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "a80af011-5d24-4cd8-8821-b732e36df7c6",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "2f36306d-8c0c-472f-a39b-880f1baca9b1",
"CreateDate": "2025-10-13T15:21:17.3433049-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-10-13T15:21:17.3433049-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "183aa7a8-29ae-4da6-89eb-02d5d0c364e4",
"CreateDate": "2025-10-13T15:21:17.3433049-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-10-13T15:21:17.3433049-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "15bbcefe-354b-4ba8-a7cc-eee22b7e965f",
"CreateDate": "2025-10-13T15:21:17.3433049-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-10-13T15:21:17.3433049-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "a11a019a-05ea-4dc8-90a8-393a2481b784",
"EffectiveDate": "2025-10-13T15:21:17.3433049-07:00",
"StatusType": {
"StatusTypeId": "1532a57d-4691-4a50-b7d2-f06cf3775d82",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "a80af011-5d24-4cd8-8821-b732e36df7c6",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "2f36306d-8c0c-472f-a39b-880f1baca9b1",
"CreateDate": "2025-10-13T15:21:17.3433049-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-10-13T15:21:17.3433049-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "b1c4ddbe-22a6-4e36-bd64-2e7e0b41e54c",
"CreateDate": "2025-10-13T15:21:17.3433049-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-10-13T15:21:17.3433049-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "dcf5f94f-ce27-4f65-836d-3be9c3d622ec",
"CreateDate": "2025-10-13T15:21:17.3433049-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-10-13T15:21:17.3433049-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "1891addc-5cd3-484a-819d-0ccbebbd41af",
"EffectiveDate": "2025-10-13T15:21:17.3433049-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "fef0d999-004b-4d3e-ba37-8568c6f7fc43",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "157731c9-6c62-4a85-8fc8-d53350219502",
"CreateDate": "2025-10-13T15:21:17.3433049-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-10-13T15:21:17.3433049-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "2260922e-f8d5-4abf-8ab4-85a6bfa53940",
"CreateDate": "2025-10-13T15:21:17.3433049-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-10-13T15:21:17.3433049-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-10-13T15:21:17.3433049-07:00",
"MeasurementValueNeededDate": "2025-10-13T15:21:17.3433049-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "f3fd2a7d-3d5f-42e0-b31e-c8fc7e1c9432",
"CreateDate": "2025-10-13T15:21:17.3433049-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-10-13T15:21:17.3433049-07:00",
"LastModifiedUser": "sample string 8"
},
"Total": 1,
"Message": "sample string 1"
}