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": "5e4582f2-e0f9-4e58-a908-668a738f125d", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "d4433580-24e6-43d2-a2e1-b8bac06f512f", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "94606723-cd7b-4c08-b6fe-bf3b4d649e18", "CreateDate": "2024-07-26T18:56:10.7628825-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-07-26T18:56:10.7628825-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "b1e8b02b-98eb-45dd-add5-1733bbee779e", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-07-26T18:56:10.7628825-07:00", "MeasurementValueNeededDate": "2024-07-26T18:56:10.7628825-07:00", "SourceSystemId": "sample string 3", "CompanyId": "ca292bdf-415c-4c95-b9e2-c1f398ee22cf", "CreateDate": "2024-07-26T18:56:10.7628825-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-07-26T18:56:10.7628825-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "1ccb84be-6163-427b-9537-b6b1b8ebb783", "EffectiveDate": "2024-07-26T18:56:10.7628825-07:00", "StateType": { "StateTypeId": "8bc18bec-990b-43a3-995f-ec423f9cc746", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "d4433580-24e6-43d2-a2e1-b8bac06f512f", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "94606723-cd7b-4c08-b6fe-bf3b4d649e18", "CreateDate": "2024-07-26T18:56:10.7628825-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-07-26T18:56:10.7628825-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "636716fd-6dde-4b56-8237-61dc84809477", "CreateDate": "2024-07-26T18:56:10.7628825-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-07-26T18:56:10.7628825-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "58456184-99ae-4906-b8f1-e1a53aca8c1d", "CreateDate": "2024-07-26T18:56:10.7628825-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-07-26T18:56:10.7628825-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "c9410f9b-0cbf-4227-85f7-928285f5104a", "EffectiveDate": "2024-07-26T18:56:10.7628825-07:00", "StatusType": { "StatusTypeId": "62c1f459-f810-4a6c-bcbb-33eb9d02eb11", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "d4433580-24e6-43d2-a2e1-b8bac06f512f", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "94606723-cd7b-4c08-b6fe-bf3b4d649e18", "CreateDate": "2024-07-26T18:56:10.7628825-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-07-26T18:56:10.7628825-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "39fcb6ec-9205-4ca8-8683-11041cb03d26", "CreateDate": "2024-07-26T18:56:10.7628825-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-07-26T18:56:10.7628825-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "399eb110-953f-497f-a50c-88b21f970a5e", "CreateDate": "2024-07-26T18:56:10.7628825-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-07-26T18:56:10.7628825-07:00", "LastModifiedUser": "sample string 4" }, "WellPurpose": { "WellPurposeId": "e74acd58-a634-4c34-9d59-5075ad891556", "EffectiveDate": "2024-07-26T18:56:10.7628825-07:00", "WellPurposeType": { "WellPurposeTypeId": "f0bd144c-fd4a-4388-aa47-48ea580ddc87", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "421b4291-65bb-4a52-89bb-bd204bcb725a", "CreateDate": "2024-07-26T18:56:10.7628825-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-07-26T18:56:10.7628825-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "01121299-d7c1-43a9-9e22-31a976e48ad2", "CreateDate": "2024-07-26T18:56:10.7628825-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-07-26T18:56:10.7628825-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2024-07-26T18:56:10.7628825-07:00", "MeasurementValueNeededDate": "2024-07-26T18:56:10.7628825-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "f1afe029-5f94-4905-ad0f-586524827a14", "CreateDate": "2024-07-26T18:56:10.7628825-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-07-26T18:56:10.7628825-07:00", "LastModifiedUser": "sample string 8" }, "Total": 1, "Message": "sample string 1" }