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": "e2a00ad6-a132-4bac-a1e1-6489eec4e103",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "46c66e77-2b3e-4af1-b1df-d2c5e30b1d36",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "81c0f4b1-fad2-41b8-8fd1-1e2f21950666",
"CreateDate": "2024-12-21T06:58:57.983806-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2024-12-21T06:58:57.983806-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "5206aaa3-9833-4711-b910-c2bc370d34c2",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2024-12-21T06:58:57.983806-08:00",
"MeasurementValueNeededDate": "2024-12-21T06:58:57.983806-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "9f71f59c-f359-4d20-8281-2ab42b16bb8e",
"CreateDate": "2024-12-21T06:58:57.983806-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2024-12-21T06:58:57.983806-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "4f075ec9-e961-4bf3-bf3c-c50a191b178d",
"EffectiveDate": "2024-12-21T06:58:57.983806-08:00",
"StateType": {
"StateTypeId": "d5ed44ce-c269-413c-8153-e681a0c50454",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "46c66e77-2b3e-4af1-b1df-d2c5e30b1d36",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "81c0f4b1-fad2-41b8-8fd1-1e2f21950666",
"CreateDate": "2024-12-21T06:58:57.983806-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2024-12-21T06:58:57.983806-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "81aa4fea-abe8-47e8-86a7-5d8c0c6a4524",
"CreateDate": "2024-12-21T06:58:57.983806-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2024-12-21T06:58:57.983806-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "52b21619-c520-4a40-a863-21bc409dad4c",
"CreateDate": "2024-12-21T06:58:57.983806-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2024-12-21T06:58:57.983806-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "b5974b3b-5d17-4086-a4b8-075a468cb930",
"EffectiveDate": "2024-12-21T06:58:57.983806-08:00",
"StatusType": {
"StatusTypeId": "7b499fc6-f3f7-4281-8b63-b01df8368be3",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "46c66e77-2b3e-4af1-b1df-d2c5e30b1d36",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "81c0f4b1-fad2-41b8-8fd1-1e2f21950666",
"CreateDate": "2024-12-21T06:58:57.983806-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2024-12-21T06:58:57.983806-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "9d866653-ad01-4eb8-8b34-dadd422e32ee",
"CreateDate": "2024-12-21T06:58:57.983806-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2024-12-21T06:58:57.983806-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "55fb3ab2-f5be-45c9-a729-c9bb7d53e831",
"CreateDate": "2024-12-21T06:58:57.983806-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2024-12-21T06:58:57.983806-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "cf7eb598-a416-46ba-9498-0240392d4d8a",
"EffectiveDate": "2024-12-21T06:58:57.983806-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "e72263e9-a84c-4bab-901a-96f6d7ef17e7",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "a57af924-c49b-4a6b-983f-01172e9930e3",
"CreateDate": "2024-12-21T06:58:57.983806-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2024-12-21T06:58:57.983806-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "6e00f4c6-8f10-4e22-aae6-501e0ee29801",
"CreateDate": "2024-12-21T06:58:57.983806-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2024-12-21T06:58:57.983806-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2024-12-21T06:58:57.983806-08:00",
"MeasurementValueNeededDate": "2024-12-21T06:58:57.983806-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "a45f644b-a612-444d-94c7-37e2f1d1b431",
"CreateDate": "2024-12-21T06:58:57.983806-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2024-12-21T06:58:57.983806-08:00",
"LastModifiedUser": "sample string 8"
},
"Total": 1,
"Message": "sample string 1"
}