/
REST Objects Asset
Document toolboxDocument toolbox

REST Objects Asset

Owned by Andrew Hill (Deactivated)
Last updated: Aug 11, 2023 by Jason AndrewVersion comment

5.0.0

The Asset object can be part of:

  • The Appointment Book object, in the following location:
  • In this situation, an Asset object represents the details of an asset (item of physical equipment) to be associated with a Work Item when performing an appointment booking.  

or:

  • The Work Item object, in the following locations:
  • In this situation, an Asset object represents the details of an asset (item of physical equipment) associated with a booked Work Item. 

ServiceBroker supports Asset objects as part of objects when the primary sub-system is ServiceDispatch or ServiceMobility. (Work Item objects associated with other primary-subsystems do not support the use of an Asset object).

The behaviour of the Asset object is different for the two supported primary sub-systems. Please see below for details.

On this page:

Related pages:

ServiceDispatch

When ServiceDispatch is the primary sub-system for a Work Item object, then the structure of any associated Asset objects in ServiceBroker is as defined below. 

Asset Object Format

JSON Format 
{
	"InServiceDate": "",
	"Mfg": "",
	"Model": "",
	"ProdLine": "",
	"SerialNum": ""
}

Asset Object Properties

PropertyTypeRequired?DescriptionField Mappings
ServiceDispatch
FlexformsstringNo

An optional collection of FlexForm IDs. Each form specified in the collection will be available for the identified task.

See: FlexForm Object

N/A
FlexviewstringNo

The optional FlexViews object is used to provided additional read-only details and information specific to the object they are included in. The FlexViews are fully customizable by the customer.

See: Flex Views Object

N/A
InServiceDateDatetimeNo

The date/time that the asset came into service.

ProductInfo: InstallDate
MfgstringNo

A description of the manufacturer of the asset.

ProductInfo: BrandDesc
ModelstringNo

The asset's model number.

ProductInfo: ModelNo
ProdLinestringNo

A description of the asset.

ProductInfo: ProductDesc
SerialNumstringNo

The asset's serial number.

ProductInfo: SerialNo
ServiceCodesstringNo
An optional collection of service code IDs. The first service code ID specified in the collection is the top level service code, the second service code ID specified in the collection corresponds with the second level service code, etc. There may be a maximum of 7 levels of service codes defined.

See: Service Code Object

N/A

ServiceMobility

When ServiceMobility is the primary sub-system for a Work Item object, then the structure of any associated Asset objects in ServiceBroker is not be defined at the ServiceBroker level. 

Instead, the Asset object will be a pass-through object in Broker - that is, the Asset object will have the object structure as defined by the version of ServiceMobility which is the primary sub-system.

Accordingly, please see the appropriate documentation for the Asset object in the relevant version of ServiceMobility:

Related content