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": "b0905ba7-d1e4-4055-91d1-92dbf6fa7a88", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "49f538e3-825c-4426-88ff-b10a60500a85", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "2f7cbce7-369b-43b6-8d64-74060b3fc87a", "CreateDate": "2025-04-17T04:21:53.8936226-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-04-17T04:21:53.8936226-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "ca56aa93-e008-4a79-bcdf-6f82670b3177", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-04-17T04:21:53.8936226-07:00", "MeasurementValueNeededDate": "2025-04-17T04:21:53.8936226-07:00", "SourceSystemId": "sample string 3", "CompanyId": "b6078803-9505-4085-bbc9-3ee1cafbda6c", "CreateDate": "2025-04-17T04:21:53.8936226-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-17T04:21:53.8936226-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "f29cd698-5c87-4e5a-965b-a38db4bb3ee8", "EffectiveDate": "2025-04-17T04:21:53.8936226-07:00", "StateType": { "StateTypeId": "834bc4dc-feed-48ac-af67-cc43411cc7c5", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "49f538e3-825c-4426-88ff-b10a60500a85", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "2f7cbce7-369b-43b6-8d64-74060b3fc87a", "CreateDate": "2025-04-17T04:21:53.8936226-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-04-17T04:21:53.8936226-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "027f3c07-640d-4862-84b6-32924e0fbeb3", "CreateDate": "2025-04-17T04:21:53.8936226-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-17T04:21:53.8936226-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "48a8c70f-1551-4161-a78d-71c942087e3b", "CreateDate": "2025-04-17T04:21:53.8936226-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-04-17T04:21:53.8936226-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "3b010827-b175-4d51-915b-30491e9d3c9d", "EffectiveDate": "2025-04-17T04:21:53.8936226-07:00", "StatusType": { "StatusTypeId": "6ee0669e-327e-4291-8ad2-46fd6c15b7b2", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "49f538e3-825c-4426-88ff-b10a60500a85", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "2f7cbce7-369b-43b6-8d64-74060b3fc87a", "CreateDate": "2025-04-17T04:21:53.8936226-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-04-17T04:21:53.8936226-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "d50a91da-60d9-4a8c-95f3-0d809016d14b", "CreateDate": "2025-04-17T04:21:53.8936226-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-04-17T04:21:53.8936226-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "565ebd37-faac-4aaf-8ba2-fd5ef0e45837", "CreateDate": "2025-04-17T04:21:53.8936226-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-04-17T04:21:53.8936226-07:00", "LastModifiedUser": "sample string 4" }, "WellPurpose": { "WellPurposeId": "fad9d52c-9379-4039-8a63-253f98c88e85", "EffectiveDate": "2025-04-17T04:21:53.8936226-07:00", "WellPurposeType": { "WellPurposeTypeId": "cd5455b6-2fca-4174-b178-3da1520d2909", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "de66c329-f2e9-4b1a-8f10-f330f11ee7ce", "CreateDate": "2025-04-17T04:21:53.8936226-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-04-17T04:21:53.8936226-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "7b3c8e2c-79ba-4ee4-bc1a-8faa83a0ab4f", "CreateDate": "2025-04-17T04:21:53.8936226-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-04-17T04:21:53.8936226-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2025-04-17T04:21:53.8936226-07:00", "MeasurementValueNeededDate": "2025-04-17T04:21:53.8936226-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "805fc840-1967-4da9-af9c-3682c6099393", "CreateDate": "2025-04-17T04:21:53.8936226-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-04-17T04:21:53.8936226-07:00", "LastModifiedUser": "sample string 8" }, "Total": 1, "Message": "sample string 1" }