GET Assets?assetId={assetId}&includeAllAncestors={includeAllAncestors}

Retrieves an asset by its Id.

Request Information

URI Parameters

NameDescriptionTypeAdditional 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.

NameDescriptionTypeAdditional information
Data

Asset

None.

Total

integer

None.

Message

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Data": {
    "AssetId": "2574f176-8a3e-4a97-a95d-26c748f5aadc",
    "Name": "sample string 1",
    "Description": "sample string 2",
    "DisplayOrder": 1,
    "AssetType": {
      "AssetTypeId": "3d9d434d-68d3-4334-afff-c2e8106e6646",
      "Name": "sample string 1",
      "Description": "sample string 2",
      "DisplayColor": "sample string 3",
      "SourceSystemId": "sample string 4",
      "CompanyId": "d7a81df8-5174-4f64-abd0-71768610f661",
      "CreateDate": "2024-10-10T15:20:51.8655889-07:00",
      "CreateUser": "sample string 6",
      "LastModifiedDate": "2024-10-10T15:20:51.8655889-07:00",
      "LastModifiedUser": "sample string 7"
    },
    "AssetGroup": {
      "AssetGroupId": "04ba3b77-53a8-46ca-b583-6e2f1381c3cd",
      "Name": "sample string 1",
      "Description": "sample string 2",
      "ParentGroup": null,
      "DisplayOrder": 1,
      "FormValueNeededDate": "2024-10-10T15:20:51.8655889-07:00",
      "MeasurementValueNeededDate": "2024-10-10T15:20:51.8655889-07:00",
      "SourceSystemId": "sample string 3",
      "CompanyId": "093961df-930e-46ff-803a-653bb4380c17",
      "CreateDate": "2024-10-10T15:20:51.8655889-07:00",
      "CreateUser": "sample string 5",
      "LastModifiedDate": "2024-10-10T15:20:51.8655889-07:00",
      "LastModifiedUser": "sample string 6"
    },
    "ParentAsset": null,
    "Location": "sample string 3",
    "Barcode": {
      "Format": 0,
      "Code": "sample string 1"
    },
    "FormValueNeededDate": "2024-10-10T15:20:51.8655889-07:00",
    "MeasurementValueNeededDate": "2024-10-10T15:20:51.8655889-07:00",
    "HasChildren": true,
    "SourceSystemId": "sample string 5",
    "CompanyId": "e9b4da34-76f0-4cb9-979a-193d77b52570",
    "CreateDate": "2024-10-10T15:20:51.8655889-07:00",
    "CreateUser": "sample string 7",
    "LastModifiedDate": "2024-10-10T15:20:51.8655889-07:00",
    "LastModifiedUser": "sample string 8"
  },
  "Total": 1,
  "Message": "sample string 1"
}