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": "2b7fee79-0a6d-416f-afb6-fec46654e52f", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "cc86c562-111b-4598-9d2b-9437d91bef46", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "73bd10bd-fe13-446c-91e7-1620a14a1144", "CreateDate": "2023-06-04T04:34:29.9829337-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2023-06-04T04:34:29.9829337-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "7b14fe23-8087-4d3f-890b-23efa4018a3e", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2023-06-04T04:34:29.9829337-07:00", "MeasurementValueNeededDate": "2023-06-04T04:34:29.9829337-07:00", "SourceSystemId": "sample string 3", "CompanyId": "36b29691-f4e4-4883-b335-77520dad2eba", "CreateDate": "2023-06-04T04:34:29.9829337-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2023-06-04T04:34:29.9829337-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "cf686327-3236-43e5-ac85-6ac545416fc6", "EffectiveDate": "2023-06-04T04:34:29.9829337-07:00", "StateType": { "StateTypeId": "632dffba-7150-410a-9e12-03f4bd4d9289", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "cc86c562-111b-4598-9d2b-9437d91bef46", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "73bd10bd-fe13-446c-91e7-1620a14a1144", "CreateDate": "2023-06-04T04:34:29.9829337-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2023-06-04T04:34:29.9829337-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "80e722a4-4441-46d7-bbfc-8a10075eec51", "CreateDate": "2023-06-04T04:34:29.9829337-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2023-06-04T04:34:29.9829337-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "a933860f-7912-43d7-9b63-b7bbc390aa76", "CreateDate": "2023-06-04T04:34:29.9829337-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2023-06-04T04:34:29.9829337-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "df3da9a3-71f0-4f3f-9466-e600bd3c67c6", "EffectiveDate": "2023-06-04T04:34:29.9829337-07:00", "StatusType": { "StatusTypeId": "bcb6dea8-b4cd-4a36-98d1-64d6a6ccb68c", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "cc86c562-111b-4598-9d2b-9437d91bef46", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "73bd10bd-fe13-446c-91e7-1620a14a1144", "CreateDate": "2023-06-04T04:34:29.9829337-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2023-06-04T04:34:29.9829337-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "3bb5aa3d-0c26-4bd8-859a-398672e551a1", "CreateDate": "2023-06-04T04:34:29.9829337-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2023-06-04T04:34:29.9829337-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "58b4ec6e-23bb-4179-8a3a-1e87995ed2b0", "CreateDate": "2023-06-04T04:34:29.9829337-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2023-06-04T04:34:29.9829337-07:00", "LastModifiedUser": "sample string 4" }, "WellPurpose": { "WellPurposeId": "3c4a4391-49f3-4b71-804c-cea34b7e6529", "EffectiveDate": "2023-06-04T04:34:29.9829337-07:00", "WellPurposeType": { "WellPurposeTypeId": "f32c251f-d426-4393-86a4-4205cacefe45", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "58bd9a21-6a45-4d0b-a8c5-b97a56b9cb35", "CreateDate": "2023-06-04T04:34:29.9829337-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2023-06-04T04:34:29.9829337-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "7f6557b7-71a0-4449-987f-f85b18f6fe6c", "CreateDate": "2023-06-04T04:34:29.9829337-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2023-06-04T04:34:29.9829337-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2023-06-04T04:34:29.9829337-07:00", "MeasurementValueNeededDate": "2023-06-04T04:34:29.9829337-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "3d4d8ef3-4c81-4b57-8777-37d707a05f16", "CreateDate": "2023-06-04T04:34:29.9829337-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2023-06-04T04:34:29.9829337-07:00", "LastModifiedUser": "sample string 8" }, "Total": 1, "Message": "sample string 1" }