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": "2f775af8-015c-445f-a464-bb84aa6e60cc",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "1471d0c0-366f-4a3f-a630-b4709170015f",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "63f4474b-c1ab-492a-b240-4d9cd1feb84a",
"CreateDate": "2026-08-04T17:28:46.2371013-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-04T17:28:46.2371013-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "7d51244b-927c-46c6-b0a1-7fcef1c234e2",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-08-04T17:28:46.2371013-07:00",
"MeasurementValueNeededDate": "2026-08-04T17:28:46.2371013-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "06736a89-8078-4181-9f8c-e58d04b66a63",
"CreateDate": "2026-08-04T17:28:46.2371013-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-04T17:28:46.2371013-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "88f4f733-af99-4e06-98aa-1bafe29fc47e",
"EffectiveDate": "2026-08-04T17:28:46.2371013-07:00",
"StateType": {
"StateTypeId": "96341f9b-3caf-412a-a10c-0fa3717131c3",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "1471d0c0-366f-4a3f-a630-b4709170015f",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "63f4474b-c1ab-492a-b240-4d9cd1feb84a",
"CreateDate": "2026-08-04T17:28:46.2371013-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-04T17:28:46.2371013-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "55c70159-1cb1-4e61-b986-e25e35911be6",
"CreateDate": "2026-08-04T17:28:46.2371013-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-04T17:28:46.2371013-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "58bdd036-efd2-49ee-93f9-74b89a5fb1a5",
"CreateDate": "2026-08-04T17:28:46.2371013-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-08-04T17:28:46.2371013-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "343fca0b-86ba-4857-9de5-e367d377d8ba",
"EffectiveDate": "2026-08-04T17:28:46.2371013-07:00",
"StatusType": {
"StatusTypeId": "87274d17-fc43-4720-81f0-31cdf24ffe59",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "1471d0c0-366f-4a3f-a630-b4709170015f",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "63f4474b-c1ab-492a-b240-4d9cd1feb84a",
"CreateDate": "2026-08-04T17:28:46.2371013-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-04T17:28:46.2371013-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "5d08a839-bfbd-4e9c-91b3-4fb1aafabda1",
"CreateDate": "2026-08-04T17:28:46.2371013-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-04T17:28:46.2371013-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "b8531647-bd4b-45f5-8e09-7470582ec357",
"CreateDate": "2026-08-04T17:28:46.2371013-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-08-04T17:28:46.2371013-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "d7e049eb-caae-4f34-a851-ae8d6165c667",
"EffectiveDate": "2026-08-04T17:28:46.2371013-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "5194451a-eb4f-4155-a081-cbf9acfa1e80",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "2a03772c-e2d9-4fc6-9e71-064820100e66",
"CreateDate": "2026-08-04T17:28:46.2371013-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-04T17:28:46.2371013-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "9a8471aa-5b50-4fa2-94d1-df0d77329997",
"CreateDate": "2026-08-04T17:28:46.2371013-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-08-04T17:28:46.2371013-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-08-04T17:28:46.2371013-07:00",
"MeasurementValueNeededDate": "2026-08-04T17:28:46.2371013-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "1d4fb82f-144a-4b82-9b13-60232a638731",
"CreateDate": "2026-08-04T17:28:46.2371013-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-04T17:28:46.2371013-07:00",
"LastModifiedUser": "sample string 8"
},
"Total": 1,
"Message": "sample string 1"
}