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": "8803c233-1858-4ebb-9510-b41c7afb7224", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "a74aeeee-b3e6-45e8-af1f-f8ef9220ba40", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "812507da-c7b6-4369-8127-8f2fcf419bb4", "CreateDate": "2025-07-11T15:26:09.9287353-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-11T15:26:09.9287353-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "36f71770-ddb5-4a9f-bc86-9086b31857f8", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-07-11T15:26:09.9287353-07:00", "MeasurementValueNeededDate": "2025-07-11T15:26:09.9287353-07:00", "SourceSystemId": "sample string 3", "CompanyId": "02696cff-23cc-4220-b6a6-639d615e350d", "CreateDate": "2025-07-11T15:26:09.9287353-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-11T15:26:09.9287353-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "860d0983-586e-4d67-b5d7-976796a4ce6e", "EffectiveDate": "2025-07-11T15:26:09.9287353-07:00", "StateType": { "StateTypeId": "90f5233e-390e-479b-aea9-b729f69f736e", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "a74aeeee-b3e6-45e8-af1f-f8ef9220ba40", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "812507da-c7b6-4369-8127-8f2fcf419bb4", "CreateDate": "2025-07-11T15:26:09.9287353-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-11T15:26:09.9287353-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "06c85f23-c0d1-401d-9584-a3c5cdc3b856", "CreateDate": "2025-07-11T15:26:09.9287353-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-11T15:26:09.9287353-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "195fc741-f1f7-4339-a107-53ec97662763", "CreateDate": "2025-07-11T15:26:09.9287353-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-07-11T15:26:09.9287353-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "87e367b0-24ce-40a3-b315-399694c10396", "EffectiveDate": "2025-07-11T15:26:09.9287353-07:00", "StatusType": { "StatusTypeId": "8110571b-6466-42c5-ac95-5b2d1fcdf11b", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "a74aeeee-b3e6-45e8-af1f-f8ef9220ba40", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "812507da-c7b6-4369-8127-8f2fcf419bb4", "CreateDate": "2025-07-11T15:26:09.9287353-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-11T15:26:09.9287353-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "0b4edb98-b689-4b8a-bdb3-b15b57d4b4c4", "CreateDate": "2025-07-11T15:26:09.9287353-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-11T15:26:09.9287353-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "43f5bfd1-4ba1-4956-9a95-00b57bd6eca0", "CreateDate": "2025-07-11T15:26:09.9287353-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-07-11T15:26:09.9287353-07:00", "LastModifiedUser": "sample string 4" }, "WellPurpose": { "WellPurposeId": "9d9004aa-7d95-45ac-8460-1d2e0fe7463b", "EffectiveDate": "2025-07-11T15:26:09.9287353-07:00", "WellPurposeType": { "WellPurposeTypeId": "5de09c18-ad15-4e2b-acd8-56bfb342aa68", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "d2a282b7-4af3-41cd-807f-ececa8a55392", "CreateDate": "2025-07-11T15:26:09.9287353-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-11T15:26:09.9287353-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "6e0810cb-fa78-486e-88b8-f861fd52570f", "CreateDate": "2025-07-11T15:26:09.9287353-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-07-11T15:26:09.9287353-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2025-07-11T15:26:09.9287353-07:00", "MeasurementValueNeededDate": "2025-07-11T15:26:09.9287353-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "72b8f982-b6cd-4bb2-bb90-d6eaedc45438", "CreateDate": "2025-07-11T15:26:09.9287353-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-11T15:26:09.9287353-07:00", "LastModifiedUser": "sample string 8" }, "Total": 1, "Message": "sample string 1" }