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": "0d1ff484-5e13-4475-8d47-e313b43fcbba", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "e1a9012e-ecdd-4c56-9719-9a1bc5333190", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "6655c21f-ef5c-43ca-9a40-3706cabd71bc", "CreateDate": "2025-01-30T16:54:52.2931632-08:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-01-30T16:54:52.2931632-08:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "aef4513b-35cf-41e2-ae9b-074fac8297c4", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-01-30T16:54:52.2931632-08:00", "MeasurementValueNeededDate": "2025-01-30T16:54:52.2931632-08:00", "SourceSystemId": "sample string 3", "CompanyId": "5e5d343b-2306-4902-af81-f9e2ef34f1c4", "CreateDate": "2025-01-30T16:54:52.2931632-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-01-30T16:54:52.2931632-08:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "78045f3f-0b6c-45e9-b432-3cb4ac2d6fa2", "EffectiveDate": "2025-01-30T16:54:52.2931632-08:00", "StateType": { "StateTypeId": "1bde27be-99ca-4078-8c58-f6d47132bfee", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "e1a9012e-ecdd-4c56-9719-9a1bc5333190", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "6655c21f-ef5c-43ca-9a40-3706cabd71bc", "CreateDate": "2025-01-30T16:54:52.2931632-08:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-01-30T16:54:52.2931632-08:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "ec71d3f9-3ce7-45a3-bf31-d27a4c480a60", "CreateDate": "2025-01-30T16:54:52.2931632-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-01-30T16:54:52.2931632-08:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "1f118ad4-1c4b-4d68-bc32-a796272ce1fc", "CreateDate": "2025-01-30T16:54:52.2931632-08:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-01-30T16:54:52.2931632-08:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "34255b3e-94cb-4a89-8175-f25072c0517a", "EffectiveDate": "2025-01-30T16:54:52.2931632-08:00", "StatusType": { "StatusTypeId": "d456be7a-034c-4f28-954e-dc514a9e87a3", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "e1a9012e-ecdd-4c56-9719-9a1bc5333190", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "6655c21f-ef5c-43ca-9a40-3706cabd71bc", "CreateDate": "2025-01-30T16:54:52.2931632-08:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-01-30T16:54:52.2931632-08:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "16b742b1-07b6-4b52-a8da-703965388949", "CreateDate": "2025-01-30T16:54:52.2931632-08:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-01-30T16:54:52.2931632-08:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "36a8e7a3-85fd-474d-8dfd-0bb7edb8aa29", "CreateDate": "2025-01-30T16:54:52.2931632-08:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-01-30T16:54:52.2931632-08:00", "LastModifiedUser": "sample string 4" }, "WellPurpose": { "WellPurposeId": "24be5937-165f-4024-9986-54929478d3a3", "EffectiveDate": "2025-01-30T16:54:52.2931632-08:00", "WellPurposeType": { "WellPurposeTypeId": "9ea2ece5-60e7-4afb-9ed0-be3add5707b0", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "a3296112-c81d-4575-be1b-a471585b18e4", "CreateDate": "2025-01-30T16:54:52.2931632-08:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-01-30T16:54:52.2931632-08:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "d70a1d2e-1311-45ca-83b9-93606c8f4be0", "CreateDate": "2025-01-30T16:54:52.2931632-08:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-01-30T16:54:52.2931632-08:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2025-01-30T16:54:52.2931632-08:00", "MeasurementValueNeededDate": "2025-01-30T16:54:52.2931632-08:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "8f7dcd35-7c34-4e4e-89e9-fe8e16df930b", "CreateDate": "2025-01-30T16:54:52.2931632-08:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-01-30T16:54:52.2931632-08:00", "LastModifiedUser": "sample string 8" }, "Total": 1, "Message": "sample string 1" }