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": "b96fc357-7d18-4f16-a030-32834f6fdcb5",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "caaf261a-2c62-4402-893a-9a812f92284c",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "51adc7ea-5cbe-4ad7-a83d-53e7c9bd7221",
"CreateDate": "2026-09-26T14:00:13.2975784-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-26T14:00:13.2975784-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "4357e8c9-12fd-4454-bf0f-405a59ef87a7",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-09-26T14:00:13.2975784-07:00",
"MeasurementValueNeededDate": "2026-09-26T14:00:13.2975784-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "ac172ffe-58df-4084-abc1-c8d0822cfbbb",
"CreateDate": "2026-09-26T14:00:13.2975784-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-26T14:00:13.2975784-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "96f4cc42-f54d-49a2-8aa8-579a9682803f",
"EffectiveDate": "2026-09-26T14:00:13.2975784-07:00",
"StateType": {
"StateTypeId": "d72e1859-30ad-4e76-86d3-b116223318ba",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "caaf261a-2c62-4402-893a-9a812f92284c",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "51adc7ea-5cbe-4ad7-a83d-53e7c9bd7221",
"CreateDate": "2026-09-26T14:00:13.2975784-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-26T14:00:13.2975784-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "d6fea9b3-28d4-4141-8799-a72e0c55ebf0",
"CreateDate": "2026-09-26T14:00:13.2975784-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-26T14:00:13.2975784-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "ae80ef37-209e-4ef3-866f-37a529ee44bb",
"CreateDate": "2026-09-26T14:00:13.2975784-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-09-26T14:00:13.2975784-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "9ea3cd8c-034d-403c-911c-0e92a747e8f3",
"EffectiveDate": "2026-09-26T14:00:13.2975784-07:00",
"StatusType": {
"StatusTypeId": "8b0ad2ca-4551-47e6-9e80-05d9b41165a0",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "caaf261a-2c62-4402-893a-9a812f92284c",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "51adc7ea-5cbe-4ad7-a83d-53e7c9bd7221",
"CreateDate": "2026-09-26T14:00:13.2975784-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-26T14:00:13.2975784-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "68b18404-25ba-4c44-b2af-0e1ef4f2bd08",
"CreateDate": "2026-09-26T14:00:13.2975784-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-26T14:00:13.2975784-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "ef0818de-794e-4f4d-bd2c-48b5af3cca5c",
"CreateDate": "2026-09-26T14:00:13.2975784-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-09-26T14:00:13.2975784-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "b523f8b3-7a84-4c8c-a6d6-38ff4aed8769",
"EffectiveDate": "2026-09-26T14:00:13.2975784-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "a8e5694a-1bd9-4298-875e-1d4bbe2ae414",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "bb592026-fa70-422a-b0d4-e5b1aa15ec03",
"CreateDate": "2026-09-26T14:00:13.2975784-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-26T14:00:13.2975784-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "e4754102-eca8-47f7-85a6-e60fe916b4bb",
"CreateDate": "2026-09-26T14:00:13.2975784-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-09-26T14:00:13.2975784-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-09-26T14:00:13.2975784-07:00",
"MeasurementValueNeededDate": "2026-09-26T14:00:13.2975784-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "17c18dfb-65c3-48a8-9e00-193a48c16ad9",
"CreateDate": "2026-09-26T14:00:13.2975784-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-26T14:00:13.2975784-07:00",
"LastModifiedUser": "sample string 8"
},
"Total": 1,
"Message": "sample string 1"
}