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": "f89783e7-baeb-4675-a941-3108bd0ed01e",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "1a3cb220-c3f7-420c-9028-a1d7680c5d29",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "d1a0402c-a479-4423-a978-2f1c7cbaf958",
"CreateDate": "2025-09-13T18:30:29.9228335-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-09-13T18:30:29.9228335-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "dad6fae4-39c6-4150-a83a-617bde413d95",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-09-13T18:30:29.9228335-07:00",
"MeasurementValueNeededDate": "2025-09-13T18:30:29.9228335-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "2aa18af0-460f-42f8-854f-49f829aae8de",
"CreateDate": "2025-09-13T18:30:29.9228335-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-09-13T18:30:29.9228335-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "449cf308-d8d8-43c4-9cc1-00809c6a3ebd",
"EffectiveDate": "2025-09-13T18:30:29.9228335-07:00",
"StateType": {
"StateTypeId": "e57570fe-96c0-4a32-b9ff-c78aa2edb58c",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "1a3cb220-c3f7-420c-9028-a1d7680c5d29",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "d1a0402c-a479-4423-a978-2f1c7cbaf958",
"CreateDate": "2025-09-13T18:30:29.9228335-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-09-13T18:30:29.9228335-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "9fbc90c8-5c1c-4497-bc1b-a8f99f2ec71a",
"CreateDate": "2025-09-13T18:30:29.9228335-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-09-13T18:30:29.9228335-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "88e9c6e6-9c1e-43e5-9bc9-994242085822",
"CreateDate": "2025-09-13T18:30:29.9228335-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-09-13T18:30:29.9228335-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "b7230903-4427-4d10-b627-5ad7c9b1eddf",
"EffectiveDate": "2025-09-13T18:30:29.9228335-07:00",
"StatusType": {
"StatusTypeId": "fc32d705-8641-4368-853c-ddb44b892ebe",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "1a3cb220-c3f7-420c-9028-a1d7680c5d29",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "d1a0402c-a479-4423-a978-2f1c7cbaf958",
"CreateDate": "2025-09-13T18:30:29.9228335-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-09-13T18:30:29.9228335-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "7eb15aee-005e-4561-9004-2fee6abca96a",
"CreateDate": "2025-09-13T18:30:29.9228335-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-09-13T18:30:29.9228335-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "f4ae67ab-5049-47b7-8ce5-6a4ae754bb7c",
"CreateDate": "2025-09-13T18:30:29.9228335-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-09-13T18:30:29.9228335-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "e8210906-5f24-41d7-a02f-af8f7c6412a8",
"EffectiveDate": "2025-09-13T18:30:29.9228335-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "119717f8-25b8-4280-b71d-398fca85cb12",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "872959ec-4fab-4a17-a06f-6fc33908c843",
"CreateDate": "2025-09-13T18:30:29.9228335-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-09-13T18:30:29.9228335-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "82027d75-6259-4331-9aff-b79cfaf53ca0",
"CreateDate": "2025-09-13T18:30:29.9228335-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-09-13T18:30:29.9228335-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-09-13T18:30:29.9228335-07:00",
"MeasurementValueNeededDate": "2025-09-13T18:30:29.9228335-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "a1e45e4a-91aa-424d-98bb-206c7561b117",
"CreateDate": "2025-09-13T18:30:29.9228335-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-09-13T18:30:29.9228335-07:00",
"LastModifiedUser": "sample string 8"
},
"Total": 1,
"Message": "sample string 1"
}