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": "ad2d9bd3-5f66-4d80-a4ee-d7fb094a2c29",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "2b3f9393-dae7-43a7-baca-ca44651b800d",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "c42f07d0-42c0-4689-9b05-23d99febfb51",
"CreateDate": "2024-11-21T05:28:53.6979761-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2024-11-21T05:28:53.6979761-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "f7d1fd5d-e209-410a-a9a0-7c91416c9313",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2024-11-21T05:28:53.6979761-08:00",
"MeasurementValueNeededDate": "2024-11-21T05:28:53.6979761-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "abbb0cb2-2f48-4331-be68-7fb4860552c3",
"CreateDate": "2024-11-21T05:28:53.6979761-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2024-11-21T05:28:53.6979761-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "d173830f-c239-49a4-b07c-99c5b709bd15",
"EffectiveDate": "2024-11-21T05:28:53.6979761-08:00",
"StateType": {
"StateTypeId": "43381b1c-05b8-4026-948d-9bc630eba87d",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "2b3f9393-dae7-43a7-baca-ca44651b800d",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "c42f07d0-42c0-4689-9b05-23d99febfb51",
"CreateDate": "2024-11-21T05:28:53.6979761-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2024-11-21T05:28:53.6979761-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "d005a519-97f6-4e38-a534-fa41c54a9ff7",
"CreateDate": "2024-11-21T05:28:53.6979761-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2024-11-21T05:28:53.6979761-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "9845499a-c171-425e-b577-8bf1b02aa73a",
"CreateDate": "2024-11-21T05:28:53.6979761-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2024-11-21T05:28:53.6979761-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "41de4299-94c7-4e0d-a2ad-33ab057ad31f",
"EffectiveDate": "2024-11-21T05:28:53.6979761-08:00",
"StatusType": {
"StatusTypeId": "82c21f8e-53fa-4bda-bace-7612baea8637",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "2b3f9393-dae7-43a7-baca-ca44651b800d",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "c42f07d0-42c0-4689-9b05-23d99febfb51",
"CreateDate": "2024-11-21T05:28:53.6979761-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2024-11-21T05:28:53.6979761-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "9243bd29-3ccf-42a7-b8b0-12983e75b419",
"CreateDate": "2024-11-21T05:28:53.6979761-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2024-11-21T05:28:53.6979761-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "b45fbcf2-f1df-4e2d-b89b-035eec9089fb",
"CreateDate": "2024-11-21T05:28:53.6979761-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2024-11-21T05:28:53.6979761-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "608d3b37-0f41-4584-b46e-f466713d3c92",
"EffectiveDate": "2024-11-21T05:28:53.6979761-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "2165001c-b9f6-4aa1-9814-b064a7b39090",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "9216b214-a90f-461e-8e98-faee4baf77aa",
"CreateDate": "2024-11-21T05:28:53.6979761-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2024-11-21T05:28:53.6979761-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "9517c14f-e66a-48a7-9c8c-a642202eba57",
"CreateDate": "2024-11-21T05:28:53.6979761-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2024-11-21T05:28:53.6979761-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2024-11-21T05:28:53.6979761-08:00",
"MeasurementValueNeededDate": "2024-11-21T05:28:53.6979761-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "555c06f8-c3e0-4747-a375-7e072917f93f",
"CreateDate": "2024-11-21T05:28:53.6979761-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2024-11-21T05:28:53.6979761-08:00",
"LastModifiedUser": "sample string 8"
},
"Total": 1,
"Message": "sample string 1"
}