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": "3a681dda-bcdd-4556-a573-6f187c4d4373", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "8efbb075-8e53-442f-b165-68c7234b958b", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "dcf17865-792b-4821-bd08-07d3751d8df8", "CreateDate": "2024-04-28T20:02:31.7503924-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-28T20:02:31.7503924-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "35275bb5-5b86-41d3-91e3-9d2c765d5a41", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-04-28T20:02:31.7503924-07:00", "MeasurementValueNeededDate": "2024-04-28T20:02:31.7503924-07:00", "SourceSystemId": "sample string 3", "CompanyId": "04256df4-93f1-4ed6-b2f7-0ef16316b4b6", "CreateDate": "2024-04-28T20:02:31.7503924-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-28T20:02:31.7503924-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "8d8c1c71-7261-42c8-9252-93b4c1b26c6f", "EffectiveDate": "2024-04-28T20:02:31.7503924-07:00", "StateType": { "StateTypeId": "682707c8-6d73-473f-bc0c-924d6792018e", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "8efbb075-8e53-442f-b165-68c7234b958b", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "dcf17865-792b-4821-bd08-07d3751d8df8", "CreateDate": "2024-04-28T20:02:31.7503924-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-28T20:02:31.7503924-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "8a206e3e-60db-4937-b35b-e8a5309d8565", "CreateDate": "2024-04-28T20:02:31.7503924-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-28T20:02:31.7503924-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "56b3690e-52b5-42ba-ae0d-6561ea70a99e", "CreateDate": "2024-04-28T20:02:31.7503924-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-04-28T20:02:31.7503924-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "6c6c85a6-a7f3-41d8-b35b-5e3061b61c64", "EffectiveDate": "2024-04-28T20:02:31.7503924-07:00", "StatusType": { "StatusTypeId": "b73a1f70-b871-4bb9-894a-be7e95aa229a", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "8efbb075-8e53-442f-b165-68c7234b958b", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "dcf17865-792b-4821-bd08-07d3751d8df8", "CreateDate": "2024-04-28T20:02:31.7503924-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-28T20:02:31.7503924-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "5777c52d-37ed-4ee5-9788-0332b212d4fb", "CreateDate": "2024-04-28T20:02:31.7503924-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-04-28T20:02:31.7503924-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "c3ef85d4-18b9-4ce8-b9a1-3a03288ac273", "CreateDate": "2024-04-28T20:02:31.7503924-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-04-28T20:02:31.7503924-07:00", "LastModifiedUser": "sample string 4" }, "WellPurpose": { "WellPurposeId": "4734c5de-8e90-4a9a-a407-eea9bf19390d", "EffectiveDate": "2024-04-28T20:02:31.7503924-07:00", "WellPurposeType": { "WellPurposeTypeId": "315c8b21-c783-4179-9c94-577cafbd0a5c", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "349c92d8-d4f2-4c20-8a60-dbf29c830dd3", "CreateDate": "2024-04-28T20:02:31.7503924-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-04-28T20:02:31.7503924-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "4f88911f-8d96-4ec0-b46b-814cdcbdda0f", "CreateDate": "2024-04-28T20:02:31.7503924-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-04-28T20:02:31.7503924-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2024-04-28T20:02:31.7503924-07:00", "MeasurementValueNeededDate": "2024-04-28T20:02:31.7503924-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "23b06391-25eb-4c22-889e-e3c0bdf5b29e", "CreateDate": "2024-04-28T20:02:31.7503924-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-28T20:02:31.7503924-07:00", "LastModifiedUser": "sample string 8" }, "Total": 1, "Message": "sample string 1" }