Features - Connectors Framework - Inbound REST API - Assets
View Asset by ExternalID
Overview
Retrieve an Asset's information of the client using externalID of the asset
URL Format
https://{domain}.mobiwork.com/api/rest/{clientId}/{versionNumber}/asset/{assetId}/view.html?token=XXXXXXXX&userId={userId}&externalId={externalId}
Arguments
clientId
required
MobiWork assigned unique ID of the company
versionNumber
required
Version number of MobiWork API SDK release. Current version is: 10.0.78
token
required
Part of URL as a request parameter and is required in every call to verify access to API calls
externalId
required
Specified in URL as a parameter, is the ExternalID of the asset to be retrieved
userId
optional
If provided, this User ID will be taken as a logged in user
Return
Returns an Asset Object if valid arguments are provided. Returns an error if not a valid request
Request Body XSD
None
Response Body XSD
Curl Example
HTTP Method: GET
Request: curl -k -X GET "https://www.mobiwork.com/api/rest/12014/10.0.78/asset/54782/view.html?token=COJL8X2FKSLMMRTYCH2B&externalId=ext555"
Response: <?xml encoding="UTF-8" ?>
<response version="10.0.78" statusCode="1">
<asset>
<mobiworkAssetId>54782</mobiworkAssetId>
<externalId>ext555</externalId>
<name>05D744969-Full Electric Bed</name>
<description>Full Electric Bed Frame-Retro</description>
<modelNumber>Semi Electric Bed 5310</modelNumber>
<serialNumber>05D744969-FEB</serialNumber>
<status>Active</status>
<typeId>15</typeId>
<type>Building</type>
<categoryId>4855</categoryId>
<category>Homecare Beds</category>
<subCategoryId>27509</subCategoryId>
<subCategory>test sub</subCategory>
<customFieldList>
<customField>
<apiName>LicenseTag</apiName>
<fieldType>1</fieldType>
<value></value>
<name>License Tag</name>
</customField>
<customField>
<apiName>ServicedBy</apiName>
<fieldType>6</fieldType>
<value></value>
<name>Serviced By</name>
</customField>
<customField>
<apiName>OilFilterNumber</apiName>
<fieldType>1</fieldType>
<value></value>
<name>Oil Filter Number</name>
</customField>
<customField>
<apiName>valueofassets</apiName>
<fieldType>1</fieldType>
<value>2000</value>
<name>Value of asset</name>
</customField>
<customField>
<apiName>images</apiName>
<fieldType>25</fieldType>
<value></value>
<name>Additional Images</name>
</customField>
</customFieldList>
</asset>
</response>