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": "d2b45c6a-f2af-46bc-852d-621fa3dfd949", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "ea85e6ae-1ec8-4aca-80f8-8648caed56ad", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "889d5493-83cc-44b7-bef8-76ec3cce8999", "CreateDate": "2024-04-26T22:22:38.7358532-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-26T22:22:38.7358532-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "9c361792-ec7a-41a9-ad84-f3ea90713d67", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-04-26T22:22:38.7358532-07:00", "MeasurementValueNeededDate": "2024-04-26T22:22:38.7358532-07:00", "SourceSystemId": "sample string 3", "CompanyId": "902c40dc-42bc-424e-92e7-c7b556f1346f", "CreateDate": "2024-04-26T22:22:38.7358532-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-26T22:22:38.7358532-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "20e66bb5-076e-451d-a538-5e430a856000", "EffectiveDate": "2024-04-26T22:22:38.7358532-07:00", "StateType": { "StateTypeId": "30ff3a57-452d-4e8e-a091-48e1c8089a4f", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "ea85e6ae-1ec8-4aca-80f8-8648caed56ad", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "889d5493-83cc-44b7-bef8-76ec3cce8999", "CreateDate": "2024-04-26T22:22:38.7358532-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-26T22:22:38.7358532-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "42778fe9-b473-442d-afa8-551e2c772785", "CreateDate": "2024-04-26T22:22:38.7358532-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-26T22:22:38.7358532-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "9320d224-a5cc-4b5e-910b-628c0a1ec75e", "CreateDate": "2024-04-26T22:22:38.7358532-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-04-26T22:22:38.7358532-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "4a38aa1e-72ab-4f34-a02e-8cd5e2b6a7d3", "EffectiveDate": "2024-04-26T22:22:38.7358532-07:00", "StatusType": { "StatusTypeId": "76da8cb3-e233-4818-a2c4-f271041cac40", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "ea85e6ae-1ec8-4aca-80f8-8648caed56ad", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "889d5493-83cc-44b7-bef8-76ec3cce8999", "CreateDate": "2024-04-26T22:22:38.7358532-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-26T22:22:38.7358532-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "5a9c6fa8-459d-4986-88b7-06fd84cd1c30", "CreateDate": "2024-04-26T22:22:38.7358532-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-04-26T22:22:38.7358532-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "b1686942-eaee-40aa-b0b8-247ae26192f4", "CreateDate": "2024-04-26T22:22:38.7358532-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-04-26T22:22:38.7358532-07:00", "LastModifiedUser": "sample string 4" }, "WellPurpose": { "WellPurposeId": "1b48bb1e-9423-46be-b012-95e5a372fee4", "EffectiveDate": "2024-04-26T22:22:38.7358532-07:00", "WellPurposeType": { "WellPurposeTypeId": "e87468db-d5f4-4406-9248-79b86f4d0d50", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "f5eb0d5e-d686-40f6-aa26-95c015956c1b", "CreateDate": "2024-04-26T22:22:38.7358532-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-04-26T22:22:38.7358532-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "7e0472bb-8a97-4517-9e46-ab9304780616", "CreateDate": "2024-04-26T22:22:38.7358532-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-04-26T22:22:38.7358532-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2024-04-26T22:22:38.7358532-07:00", "MeasurementValueNeededDate": "2024-04-26T22:22:38.7358532-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "dc84c469-70f9-45a4-8702-045ba153afac", "CreateDate": "2024-04-26T22:22:38.7358532-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-26T22:22:38.7358532-07:00", "LastModifiedUser": "sample string 8" }, "Total": 1, "Message": "sample string 1" }