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": "b3f70159-ce89-402e-ba70-4cf2ac55003c",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "7bec8b34-dda8-4514-85f0-96d21d107df0",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "7f428ffb-3e0f-41d5-a084-bab191d59b16",
"CreateDate": "2026-09-13T23:40:32.1905884-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-13T23:40:32.1905884-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "f6a75e43-102c-4d12-aa66-a8e2a143acc1",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-09-13T23:40:32.1905884-07:00",
"MeasurementValueNeededDate": "2026-09-13T23:40:32.1905884-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "ba2fad3e-277a-4c93-91c1-642e2a337433",
"CreateDate": "2026-09-13T23:40:32.1905884-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-13T23:40:32.1905884-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "8fab1bf9-6b4d-48cf-b0ce-faab284494d0",
"EffectiveDate": "2026-09-13T23:40:32.1905884-07:00",
"StateType": {
"StateTypeId": "d6d0455d-b736-4752-8438-f14aa496eaca",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "7bec8b34-dda8-4514-85f0-96d21d107df0",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "7f428ffb-3e0f-41d5-a084-bab191d59b16",
"CreateDate": "2026-09-13T23:40:32.1905884-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-13T23:40:32.1905884-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "21a3787c-16eb-4ea0-8eca-a800b82561f7",
"CreateDate": "2026-09-13T23:40:32.1905884-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-13T23:40:32.1905884-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "51adf833-d435-4495-aba9-740a8207cf4b",
"CreateDate": "2026-09-13T23:40:32.1905884-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-09-13T23:40:32.1905884-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "4b7c28a7-4055-446d-8801-6609acf57db5",
"EffectiveDate": "2026-09-13T23:40:32.1905884-07:00",
"StatusType": {
"StatusTypeId": "d62a2404-5638-406f-8990-7e3a3914985a",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "7bec8b34-dda8-4514-85f0-96d21d107df0",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "7f428ffb-3e0f-41d5-a084-bab191d59b16",
"CreateDate": "2026-09-13T23:40:32.1905884-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-13T23:40:32.1905884-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "7af87ad4-ee81-4805-bc97-d23433cf2f3d",
"CreateDate": "2026-09-13T23:40:32.1905884-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-13T23:40:32.1905884-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "7e8d94f8-bab4-4d0c-bd90-bba2be58087d",
"CreateDate": "2026-09-13T23:40:32.1905884-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-09-13T23:40:32.1905884-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "81300bd9-6e5a-4386-a143-96c839857e96",
"EffectiveDate": "2026-09-13T23:40:32.1905884-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "6b5c42ec-a56c-4fce-a0d7-b8279cb4bd5e",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "692d4258-b6af-49b0-b5cb-d82cb2d0a8da",
"CreateDate": "2026-09-13T23:40:32.1905884-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-13T23:40:32.1905884-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "fc6b8573-9b0c-48e0-b1f2-dd5e5d5c66af",
"CreateDate": "2026-09-13T23:40:32.1905884-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-09-13T23:40:32.1905884-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-09-13T23:40:32.1905884-07:00",
"MeasurementValueNeededDate": "2026-09-13T23:40:32.1905884-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "e05a9010-2698-496d-8e66-0607eefbf831",
"CreateDate": "2026-09-13T23:40:32.1905884-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-13T23:40:32.1905884-07:00",
"LastModifiedUser": "sample string 8"
},
"Total": 1,
"Message": "sample string 1"
}