Asset Object Formats
| Include Page | ||||
|---|---|---|---|---|
|
Asset Object Properties
Required properties are in bold.
| Property | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
| AccountNum | string | When the asset is associated with an Account Location, the AccountNum field represents the ID of the associated Account. When set, the LocationNum field must also be set. | ||||||
| AssetNum | string | This property uniquely identifies the asset and can be composed of alpha, numerics, and most special characters. | ||||||
| AssetSubType | string |  This property is for future use and currently is not used. | ||||||
| FlexAttrs | object |
|
| FlexForm | object |
(3.12) | |||||||||||||||||||||||||||
| FlexView | object |
| |||||||||||||||||||||||||||
| History | object | An optional property in which it is possible to store one or more collections, containing service history details for the asset. When used, each item in the collection should be used to store details of a work order. Alternatively, instead of adding service history information to the Asset object, the Asset Service History REST API Interface can optionally be used, allowing ServiceMobility to obtain the service history data for assets from a 3rd party system containing the relevant details.
| |||||||||||||||||||||||||||
| InServiceDate | datetime | The UTC date and time when the asset was originally placed in service. | |||||||||||||||||||||||||||
| IsComponent | boolean | Identifies if this asset is a component of another asset. Valid values are:
| |||||||||||||||||||||||||||
| LastServiceDate | datetime | The UTC date and time when the asset was last serviced | |||||||||||||||||||||||||||
| Location | string | An open text field that can be used by the customer to describe the physical location of where the asset was installed. | |||||||||||||||||||||||||||
| LocationNum | string | When the asset is associated with an Account Location, the LocationNum field represents the ID of the associated Location. When set, the AccountNum field must also be set. | |||||||||||||||||||||||||||
| Mfg | string | Identifies the manufacture of the asset. | |||||||||||||||||||||||||||
| Model | string | Identifies the manufacture's model number of the asset. | |||||||||||||||||||||||||||
| ProdNum | string | Optionally identifies a corresponding item in the product catalog. | |||||||||||||||||||||||||||
| SerialNum | string | Identifies the serial number of the asset. | |||||||||||||||||||||||||||
| Desc | string | Contains a brief description of the asset. | |||||||||||||||||||||||||||
| Status | string | Contains an Asset Status Codes system category value identifying the current state of the asset. | |||||||||||||||||||||||||||
| ServiceCodes | object |
| |||||||||||||||||||||||||||
| ServiceCodesDesc | collection | This optional collection contains the description for service codes. The order the descriptions appear in the array are the order mobile worker has selected service codes in the mobile application.
| |||||||||||||||||||||||||||
| Type | string | Contains an REST System Categories Asset Types system category value identifying the type of asset. | |||||||||||||||||||||||||||
| VerificationAPI | object | Captures response of Asset's Model Number Verification in Work Order process. Mobile worker can verify asset installed at the account location when
| |||||||||||||||||||||||||||
| VerificationQR | object | Captures response of Asset Verification by scanning QR code in Work Order process. Mobile worker can verify asset installed at the account location when rules
| |||||||||||||||||||||||||||
| Delete | boolean | Optional property. This property is used during a PATCH request to remove specific items. This property will never be returned during a GET request. |