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": "e6ca027f-1319-458b-8dfa-4c922f224dad",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "603a0d11-f989-4f29-bdd2-925ebacf5919",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "b61eb178-ed18-4ed3-95de-46b86d798a72",
"CreateDate": "2025-03-09T04:41:18.783816-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-03-09T04:41:18.783816-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "d8155062-9073-4cb1-98d7-b837bf093222",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-03-09T04:41:18.783816-07:00",
"MeasurementValueNeededDate": "2025-03-09T04:41:18.783816-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "43a322f1-7c0b-4bf6-b1df-e9e8b0f4c495",
"CreateDate": "2025-03-09T04:41:18.783816-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-03-09T04:41:18.783816-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "8881f644-13fd-4935-af66-a5dd86cf2391",
"EffectiveDate": "2025-03-09T04:41:18.783816-07:00",
"StateType": {
"StateTypeId": "e64973d2-d0cb-448a-afc3-674aae76b383",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "603a0d11-f989-4f29-bdd2-925ebacf5919",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "b61eb178-ed18-4ed3-95de-46b86d798a72",
"CreateDate": "2025-03-09T04:41:18.783816-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-03-09T04:41:18.783816-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "576ad85f-7c17-4e95-b03e-33f6902a52f5",
"CreateDate": "2025-03-09T04:41:18.783816-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-03-09T04:41:18.783816-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "6d585406-4e4f-4bc0-8fe4-098de90d95d8",
"CreateDate": "2025-03-09T04:41:18.783816-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-03-09T04:41:18.783816-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "f28b0d03-3c67-480e-8f1d-f77a863d131a",
"EffectiveDate": "2025-03-09T04:41:18.783816-07:00",
"StatusType": {
"StatusTypeId": "07ecd7c0-5ac1-4971-92c5-62cf19c40986",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "603a0d11-f989-4f29-bdd2-925ebacf5919",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "b61eb178-ed18-4ed3-95de-46b86d798a72",
"CreateDate": "2025-03-09T04:41:18.783816-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-03-09T04:41:18.783816-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "7c7390f5-08d0-4e90-afd1-a7c9cca8218b",
"CreateDate": "2025-03-09T04:41:18.783816-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-03-09T04:41:18.783816-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "edfe7163-019b-4018-af55-6cd44284827f",
"CreateDate": "2025-03-09T04:41:18.783816-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-03-09T04:41:18.783816-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "3b78e352-6e34-4b6e-8940-a0c633e61e5f",
"EffectiveDate": "2025-03-09T04:41:18.783816-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "fe82c00b-0a03-45a3-91a9-086faa7278cd",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "2218fa3e-d9ce-416c-b8c6-d75b3cb91b1d",
"CreateDate": "2025-03-09T04:41:18.783816-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-03-09T04:41:18.783816-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "3a2a47d1-6d8f-4085-a4c4-80d6e00e599e",
"CreateDate": "2025-03-09T04:41:18.783816-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-03-09T04:41:18.783816-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-03-09T04:41:18.783816-07:00",
"MeasurementValueNeededDate": "2025-03-09T04:41:18.783816-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "d7774ef8-75ee-4385-abe3-1e39dd339660",
"CreateDate": "2025-03-09T04:41:18.783816-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-03-09T04:41:18.783816-07:00",
"LastModifiedUser": "sample string 8"
},
"Total": 1,
"Message": "sample string 1"
}