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": "7d06fdb1-4a7d-4844-af6b-0f8a58c1d2f0",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "b489c5b0-7e51-4b18-af51-0e668f7d008f",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "969255cf-6987-4c81-8813-11696f98dab7",
"CreateDate": "2025-11-17T18:56:47.7584498-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-11-17T18:56:47.7584498-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "3545464d-6009-4aa9-8518-f600962c124d",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-11-17T18:56:47.7584498-08:00",
"MeasurementValueNeededDate": "2025-11-17T18:56:47.7584498-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "6fe30eab-ffab-4a6e-8675-385cdabbdbce",
"CreateDate": "2025-11-17T18:56:47.7584498-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-17T18:56:47.7584498-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "1db084b5-69fc-4627-8978-a8b6970b46c1",
"EffectiveDate": "2025-11-17T18:56:47.7584498-08:00",
"StateType": {
"StateTypeId": "364c14e3-c16d-4d96-ae2f-05468e0318a8",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "b489c5b0-7e51-4b18-af51-0e668f7d008f",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "969255cf-6987-4c81-8813-11696f98dab7",
"CreateDate": "2025-11-17T18:56:47.7584498-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-11-17T18:56:47.7584498-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "ba9358de-fd8b-4910-852f-4f9461a20b32",
"CreateDate": "2025-11-17T18:56:47.7584498-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-17T18:56:47.7584498-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "c54e5370-910f-4694-8521-5e2dde780f9d",
"CreateDate": "2025-11-17T18:56:47.7584498-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-11-17T18:56:47.7584498-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "66447e20-923d-4465-80c6-49772a019b28",
"EffectiveDate": "2025-11-17T18:56:47.7584498-08:00",
"StatusType": {
"StatusTypeId": "b7fd0222-4d25-4a8e-9968-8dc147f0176b",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "b489c5b0-7e51-4b18-af51-0e668f7d008f",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "969255cf-6987-4c81-8813-11696f98dab7",
"CreateDate": "2025-11-17T18:56:47.7584498-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-11-17T18:56:47.7584498-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "14e4bd40-d08d-441d-8ee0-c96e71d22a17",
"CreateDate": "2025-11-17T18:56:47.7584498-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-11-17T18:56:47.7584498-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "555d3c6e-80fc-43af-acc2-ae692ab69053",
"CreateDate": "2025-11-17T18:56:47.7584498-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-11-17T18:56:47.7584498-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "7f013929-21e2-4aab-a2d1-a7f5b831c9f5",
"EffectiveDate": "2025-11-17T18:56:47.7584498-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "743ec80b-040c-46ec-9476-68765423be82",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "dc8b1ce1-f04d-4873-adaa-1ab6b073fc0f",
"CreateDate": "2025-11-17T18:56:47.7584498-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-11-17T18:56:47.7584498-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "60bc5db2-d5af-4bfc-969c-06ca9d99cdd5",
"CreateDate": "2025-11-17T18:56:47.7584498-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-11-17T18:56:47.7584498-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-11-17T18:56:47.7584498-08:00",
"MeasurementValueNeededDate": "2025-11-17T18:56:47.7584498-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "d68edcd8-1992-41a6-9b8c-4cdc5c1ba6a3",
"CreateDate": "2025-11-17T18:56:47.7584498-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-11-17T18:56:47.7584498-08:00",
"LastModifiedUser": "sample string 8"
},
"Total": 1,
"Message": "sample string 1"
}