--- title: "Get an asset" method: GET path: "/assets/{assetId}" tags: ["Assets"] --- # Get an asset `GET /assets/{assetId}` ## Request - Base URL: `https://sb2api.servicechannel.com/v3` - URL: `https://sb2api.servicechannel.com/v3/assets/{assetId}` - Auth: OAuth 2 - Authorization code: `https://sb2login.servicechannel.com/oauth/authorize` - Token URL: `https://sb2login.servicechannel.com/oauth/token` - TypeScript: (a function with typed inputs; its response is checked against the schema) Returns the details of the specified asset for the current subscriber.
Send the [GET/ assets/locations/{locationId}](/swagger/ui/index?version=3#/Assets/GETv3_assets_locations__locationId__trade__trade_) request to retrieve assets for a particular location. ## Path parameters - `assetId` integer, required ## Query parameters - `locationId` integer - `storeId` string - `tagId` string - `trackingNumber` integer ## Response `200` The details of the requested asset are in the response. - ServiceChannelServicesMessagingAssetsAssetResponse: Object details of an asset. - `Id` integer: Unique numeric asset identifier assigned by the system. - `Tag` string: Alphanumeric asset identifier assigned by the client. - `Manufacturer` string: Company name that produces an asset. - `ModelNo` string: Asset model number. - `SerialNo` string: Asset serial number. - `LocationId` integer: Unique numeric identifier of a location an asset is assigned to. - `Area` string: Place where an asset is physically located. - `WorkOrderArea` string: Work order area, such as *Dining Room*, *Kitchen*, *Storage*. - `StoreId` string: Alphanumeric location identifier assigned by the client. - `Trade` string: Trade of an asset type the asset is assigned to, for example, *HVAC*, *DOORS*, *ELECTRICAL*. - `TradeId` integer: Numeric identifier of the primary trade of an asset. - `Type` string: Asset type, for example, *Refrigerator*, *Computer Monitor*, etc. - `AssetTypeId` integer: Unique numeric identifier of an asset type. - `BrandId` integer: Unique numeric identifier of a manufacturer that produces an asset. - `InstallDate` string: Date and time when an asset was installed at the current location. - `InstallDateVal` string, date-time: Date and time when an asset was installed at the current location. - `ManufacturerDate` string, date-time: Date and time when an asset was produced. - `ManufacturerDateStr` string: Date and time when an asset was produced by the manufacturer. - `PurchaseDate` string: Date and time when an asset was purchased. - `UsesRefrigerant` integer: Defines whether an asset uses a refrigerant. **Possible values**: 0 - no, 1 - yes. - `Active` boolean: Shows whether an asset is still in use. **Possible values**: *true*, *false*. - `IsLeased` boolean: Defines whether an asset is leased. **Possible values**: *true*, *false*. - `LifeExpectancy` integer: Estimated useful life of an asset in months. - `OriginalValue` number, double: Original asset price. - `LeaseDate` string: Date and time when a lease was signed. - `LeasePeriod` integer: Period of time in months a contracted lease is in place. - `Condition` integer: Value representation of an asset condition. **Possible values**: `0` - *broken*, `25` - *poor*, `50` - *average*, `75` - *good*, `100` - *excellent*. - `ConditionString` string: Current condition of an asset. **Possible values**: *broken*, *poor*, *average*, *good*, *excellent*. - `EnergyEfficiency` string: Provides information on energy efficiency of a particular asset. Maximum is 150 characters. - `Capacity` string: Provides information on the maximum amount of the refrigerant an asset can contain. Maximum is 150 characters. - `HasLeakDetector` boolean: Defines whether an asset has a leak detector and belongs to the Leak Detector asset type. **Possible values**: *true*, *false*. - `AssetLeakDetectorConnectionId` integer: ID of the leak detector that is connected to an asset. - `Location` string: Place where an asset is physically located. - `Warranty` ServiceChannelServicesMessagingAssetsWarranty: Object containing warranty parameters. - `ExpirationDate` string, date-time: Warranty expiration date based on the warranty expiration settings. - `ProviderId` integer: ID of a provider who is in charge of warranty services. - `NTE` number, double: Maximum amount of money to be spent on warranty services in USD. Value -1 means that the amount is not applicable. - `Priority` string: Defines how quickly warranty services should be provided, for example, *Emergency-4 Hours*, *Normal-48 Hours*, *7 Days*. - `PriorityId` integer - `Category` string: Warranty category, for example, *ADVISE ONLY*, *REPAIR*, *DISASTER*. - `CategoryId` integer - `Provider` ServiceChannelServicesMessagingAssetsWarrantyProvider: Object containing warranty provider details. - `Type` 'Fixed' | 'PrimaryRanked' | 'FixedRanked': Defines the provider type responsible for warranty services. **Possible values**: `0` - Fixed provider, `1`- Primary rank provider, `2` - Fixed rank provider. - `Value` integer: Provider type value. Displays provider ID for the fixed provider type; provider rank number — from 1 to 100 — for the fixed rank type; 1 for a primary rank provider. - `ProviderName` string: Name of the provider who is in charge of warranty services. - `Expiration` ServiceChannelServicesMessagingAssetsWarrantyExpiration: Object containing warranty expiration details. - `Type` 'FromPurchaseDate' | 'FromInstallDate': Warranty expiration calculation type. **Possible values**: 0 - the expiration date is calculated starting from the asset purchase data; 1 - the expiration date is calculated starting from the asset installation date. - `Period` integer: Warranty period in months. - `IsReplaceEquipment` boolean: Defines if the current asset is a replacement for another on condition that a tracking number is provided. **Possible values**: *true*, *false*. - `HasTagged` boolean: Defines if an asset contains ‘Asset Tag’. - `LastModifiedUseDate` string, date-time: Date and time when an asset was last updated. - `LastModifiedUserName` string: Name of the user who updated an asset. - `SubName` string: Subscriber’s name who added an asset. - `AssetRefrigerant` ServiceChannelServicesMessagingRefrigerantTrackingAssetRefrigerant - `Id` integer - `AssetId` integer - `RefrigerantUsageType` integer - `RackId` string - `RackEntityId` integer - `CarbID` string - `IsCarbReporting` boolean - `SystemLocation` string, byte - `OperationalStatus` string, byte - `RefrigerantPartNumber` string - `PartNumberId` integer - `RackTypeId` integer - `CurrentCharge` number, double - `CurrentChargeMetrics` number, double - `CurrentChargeOunces` number, double - `ChargeDescriptionId` integer - `ChargeProviderName` string - `EffectiveChargeDate` string, date-time - `RefrigerantChargeOptionId` integer - `RackTypeName` string - `UserId` integer - `TagId` string - `AssetTypeId` integer - `RefrigerantPurposeId` integer - `RefrigerantPurposeName` string - `ParentId` integer - `CreateOperationalStatusHistory` boolean - `OperationStatusDate` string, date-time - `HasLeakDetector` boolean - `AssetLeakDetectorId` integer - `InitialCharge` boolean - `RackType` string, byte - `NeedsRetrofitRetirement` boolean - `RequiresAutomaticLeakDetector` boolean - `ConnectedRackId` integer - `PreviousConnectedRackId` integer - `UpdatedDate` string, date-time - `AssetAttributesMap` ServiceChannelServicesMessagingAssetsAssetAttributesMap - `StandardAttributesMap` integer - `ViewableForProvidersAttributesMap` integer - `EditableForProvidersAttributesMap` integer - `RequiredStandardAttributesMap` integer - `AssetTag` string: Unique alphanumeric decoded value contained in a barcode, QR code, or NFC tag of an asset. It is used to scan assets via [ServiceChannel Mobile](https://servicechannel.atlassian.net/wiki/spaces/SCU/pages/575341308/Asset+Tagging#AssetTagging-AccessingtheAssetScanningModuleinSCMobile) and [ServiceChannel Provider](https://servicechannel.atlassian.net/wiki/spaces/SCU/pages/1181745372/Scanning+and+Validating+Assets+via+SC+Provider+for+FTM+Internal+Techs). - `ImportedFrom` integer: Provides the number of the template an asset was imported from. - `ParentId` integer: Unique numeric identification of an asset that has a circuit or component. - `Description` string: Comment created by a user when adding an asset. - `HasComponents` boolean: Defines whether an asset has components. **Possible values**: *true*, *false*. - `HasCircuits` boolean: Defines if an asset has an added circuit. **Possible values**: *true*, *false*. - `IsCircuit` boolean: Defines whether an asset is a circuit. **Possible values**: *true*, *false*. - `SubscriberId` integer: Unique numeric ID of the subscriber an asset belongs to. - `AssetValidated` boolean: Defines whether the asset has been validated by a technician. **Possible values**: *true*, *false*. - `ValidationRequired` boolean: Defines whether an asset needs to be validated by a technician upon check-in. - `IsLeakDetector` boolean: Defines whether an asset belongs to the *Leak Detector* asset type. - `AssetStatus` string, byte: Defines an asset repair status. **Possible values**: `0` - *In Use*, `1` - *Out For Repair*, `2` - *Replacement Recommended*, `3` - *Repaired*. - `AssetUpdatesStatus` string, byte: Defines the asset update status. **Possible values**: 0 - Attributes updated by provider, 1- New unconfirmed - asset created by provider, 2 - Rejected, 3 - Asset change confirmed. - `AdditionalTradesNames` string: Names of the additional trades for an asset type. - `AdditionalTradeIds` integer[] - `CreatedDate` string, date-time: Date and time of the asset creation. - `ModifiedDate` string, date-time: Date and time of the last asset update. - `AssetTypeGroupId` integer: Unique ID of an asset type group. - `Spend` number, double: Total asset cost. Can be calculated if the *IncludeTotalCostOfOwnership* feature flag is enabled. - `IsCarbReporting` boolean: Defines whether an asset is included in a CARB report. **Possible values**: *true*, *false*. - `AssetValidationStatus` integer - `UnableToScanReason` string: Asset tag not scanned reason - `UnableToScanReasonCustomText` string: Asset tag not scanned reason custom text - `UnableToScanReasonId` integer: Asset tag not scanned reason id - `CustomAttributes` ServiceChannelServicesMessagingEquipmentsEquipmentAttributeDescription[]: Custom Attributes - `EquipmentAttributeId` integer - `EquipmentTypeAttributeId` integer - `ValueType` integer - `EquipmentId` integer - `Value` SystemObject - `ValueText` string - `SelectedOptionsText` string - `Visible` boolean - `Editable` boolean - `Required` boolean - `Name` string - `Custom` boolean - `HasChilds` boolean - `Currency` integer - `ModifiedDateDto` string, date-time: ModifiedDate datetime offset - `RetiredDate` string, date-time: Date and time of the asset deactivation. ## Other responses - `400`: The request is not accepted due to bad syntax, missing parameters, insufficient data, etc. - `401`: The request is not authorized.
Error codes: 504 — API call rejected by security permissions - `404`: The request URI is incorrect, or the resource does not exist.
Error codes: 502 — Asset is not found --- [API](https://skmtc.dev/servicechannel/apis/servicechannel-api-v-3.md) - [All operations](https://skmtc.dev/servicechannel/apis/servicechannel-api-v-3/llms.txt) - [OpenAPI document](https://skmtc.dev/servicechannel/apis/servicechannel-api-v-3/revisions/d490d6596809?raw)