Assets

Get an asset

Returns the details of the specified asset for the current subscriber.

get/odata/assets({assetId})

Request

Base URL
https://sb2api.servicechannel.com/v3
Auth
OAuth 2
Authorization codehttps://sb2login.servicechannel.com/oauth/authorize
Token URLhttps://sb2login.servicechannel.com/oauth/token
TypeScript
https://skmtc.dev/servicechannel/apis/servicechannel-api-v-3/docs/odata/assets(:assetId)/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

assetIdinteger required

Unique numeric asset identifier you want to get the details of.

Query parameters

$expandstring

Expand a navigation property.

$selectstring

Select a set of properties to return.

$filterstring

Filter a collection of resources addressed by a request URL.

$orderbystring

Order resources by the specified property in the response.

$topinteger

Return the specified number of items in the response.

$skipinteger

Skip the specified number of items in the response.

$countboolean

Include the count of the matching resources in the response.

Response

The requested asset with its details is in the response.

Idinteger

Unique numeric asset identifier assigned by the system.

Tagstring

Alphanumeric asset identifier assigned by the client.

Manufacturerstring

Company name that produces an asset.

ModelNostring

Asset model number.

SerialNostring

Asset serial number.

LocationIdinteger

Unique numeric identifier of a location an asset is assigned to.

Areastring

Place where an asset is physically located.

WorkOrderAreastring

Work order area, such as Dining Room, Kitchen, Storage.

StoreIdstring

Alphanumeric location identifier assigned by the client.

Tradestring

Trade of an asset type the asset is assigned to, for example, HVAC, DOORS, ELECTRICAL.

TradeIdinteger

Numeric identifier of the primary trade of an asset.

Typestring

Asset type, for example, Refrigerator, Computer Monitor, etc.

AssetTypeIdinteger

Unique numeric identifier of an asset type.

BrandIdinteger

Unique numeric identifier of a manufacturer that produces an asset.

InstallDatestring

Date and time when an asset was installed at the current location.

InstallDateValstring date-time

Date and time when an asset was installed at the current location.

ManufacturerDatestring date-time

Date and time when an asset was produced.

ManufacturerDateStrstring

Date and time when an asset was produced by the manufacturer.

PurchaseDatestring

Date and time when an asset was purchased.

UsesRefrigerantinteger

Defines whether an asset uses a refrigerant. Possible values: 0 - no, 1 - yes.

Activeboolean

Shows whether an asset is still in use. Possible values: true, false.

IsLeasedboolean

Defines whether an asset is leased. Possible values: true, false.

LifeExpectancyinteger

Estimated useful life of an asset in months.

OriginalValuenumber double

Original asset price.

LeaseDatestring

Date and time when a lease was signed.

LeasePeriodinteger

Period of time in months a contracted lease is in place.

Conditioninteger

Value representation of an asset condition. Possible values: 0 - broken, 25 - poor, 50 - average, 75 - good, 100 - excellent.

ConditionStringstring

Current condition of an asset. Possible values: broken, poor, average, good, excellent.

EnergyEfficiencystring

Provides information on energy efficiency of a particular asset. Maximum is 150 characters.

Capacitystring

Provides information on the maximum amount of the refrigerant an asset can contain. Maximum is 150 characters.

HasLeakDetectorboolean

Defines whether an asset has a leak detector and belongs to the Leak Detector asset type. Possible values: true, false.

AssetLeakDetectorConnectionIdinteger

ID of the leak detector that is connected to an asset.

Locationstring

Place where an asset is physically located.

IsReplaceEquipmentboolean

Defines if the current asset is a replacement for another on condition that a tracking number is provided. Possible values: true, false.

HasTaggedboolean

Defines if an asset contains ‘Asset Tag’.

LastModifiedUseDatestring date-time

Date and time when an asset was last updated.

LastModifiedUserNamestring

Name of the user who updated an asset.

SubNamestring

Subscriber’s name who added an asset.

AssetTagstring

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 and ServiceChannel Provider.

ImportedFrominteger

Provides the number of the template an asset was imported from.

ParentIdinteger

Unique numeric identification of an asset that has a circuit or component.

Descriptionstring

Comment created by a user when adding an asset.

HasComponentsboolean

Defines whether an asset has components. Possible values: true, false.

HasCircuitsboolean

Defines if an asset has an added circuit. Possible values: true, false.

IsCircuitboolean

Defines whether an asset is a circuit. Possible values: true, false.

SubscriberIdinteger

Unique numeric ID of the subscriber an asset belongs to.

AssetValidatedboolean

Defines whether the asset has been validated by a technician. Possible values: true, false.

ValidationRequiredboolean

Defines whether an asset needs to be validated by a technician upon check-in.

IsLeakDetectorboolean

Defines whether an asset belongs to the Leak Detector asset type.

AssetStatusstring byte

Defines an asset repair status. Possible values: 0 - In Use, 1 - Out For Repair, 2 - Replacement Recommended, 3 - Repaired.

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

AdditionalTradesNamesstring

Names of the additional trades for an asset type.

AdditionalTradeIdsinteger[]

CreatedDatestring date-time

Date and time of the asset creation.

ModifiedDatestring date-time

Date and time of the last asset update.

AssetTypeGroupIdinteger

Unique ID of an asset type group.

Spendnumber double

Total asset cost. Can be calculated if the IncludeTotalCostOfOwnership feature flag is enabled.

IsCarbReportingboolean

Defines whether an asset is included in a CARB report. Possible values: true, false.

AssetValidationStatusinteger

UnableToScanReasonstring

Asset tag not scanned reason

UnableToScanReasonCustomTextstring

Asset tag not scanned reason custom text

UnableToScanReasonIdinteger

Asset tag not scanned reason id

HasChildsboolean

Currencyinteger

ModifiedDateDtostring date-time

ModifiedDate datetime offset

RetiredDatestring date-time

Date and time of the asset deactivation.

Changes

No recorded changes to this operation across all 1 revision of this API.