Asset Attributes and xml Response

 

The asset attributes along with their actions should be used as defined below.  
 

 Note

 

1. The asset operations that can be performed through API are adding, updating and deleting assets.

2. Asset operations can be performed by technicians only with Inventory privilege.

3. The attributes are case sensitive and should be used as defined.

4. While renaming the button in the sample html form, specify 'operation' as hidden element.

 



 

Add/Update Workstation and Server

The Details necessary for adding workstation should be set in HttpRequest parameters and HttpRequest parameter value for 'operation' attribute can be 'AddAsset','UpdateAsset' or 'SaveAsset'.

 

Attributes

Comments

targeturl=

"/servlets/assetservlet"

Target URL for adding/updating workstation/server

assetname

Name of the asset (workstation/server)

assettype

asset Type

model

Model No. of the asset (workstation/server)

productname

Product Name of the asset (workstation/server)

sitename

Site to which workstation/server is associated

ipaddress

IP Address of workstation/server.

servicetag

Service Tag of workstation/server

wsmanufacturer

Workstation Manufacturer

procount

Processor Count of workstation/server

protype

Processor Type of workstation/server

prospeed

Processor Speed (in MHz) of workstation/server

promanufacturer

Processor Manufacturer of workstation/server

ramsize

RAM details (in MB) of workstation/server

virtualcapacity

Virtual Memory (in MB) of workstation/server

osname

Operating System Name of workstation/server

osservicepack

Operating System ServicePack of workstation/server

restag

Resource Tag of workstation/server

ressino

Resource Serial No. of workstation/server

barcode

Bar Code of workstation/server

location

Location of workstation/server

vendor

Vendor of workstation/server

acqdate

Acquisition Date of workstation/server (Supported Format:yyyy-MM-dd)

expirydate

Expiry Date of workstation/server (Supported Format:yyyy-MM-dd)

warrantyexpdate

Warranty Expiry Date of workstation/server (Supported Format:yyyy-MM-dd)

assetstate

State of the of workstation/server

assettoassociate

Associate the asset to other assets.(Valid only for Asset State 'In Use').

associatetouser

Associate the asset to user.(Valid only for Asset State 'In Use').

associatetodepartment

Associate the asset to department.(Valid only for Asset State 'In Use').

UDF Column Aliases

UDF aliases name should be specified

macaddress

MAC Address of workstation/server

nicInfo

Nic Info of workstation/server

netaddress

Net Address of workstation/server

domain

Domain of workstation/server

dnsserver

DNS Server of workstation/server

gateway

Default Gateway of workstation/server

dhcpenabled

is DHCP Enabled for workstation/server. Values allowed: true, false. Default value: false.

monitortype

Monitor Type of workstation/server

monitorserialnumber

Serial Number of the monitor.

monitormanufacturer

Monitor manufacturer details

mousetype

Mouse Type of workstation/server

mouseserialnumber

Serial Number of mouse

mousemanufacturer

Mouse manufacturer details

keyboardtype

Keyboard Type of workstation/server

keyboardserialnumber

Serial Number of keyboard

keyboardmanufacturer

Keyboard manufacturer details

username

Login Name for SDP Authentication

password

Password for SDP Authentication

domain_name

Domain Name to which the user belongs

logondomainname

Authentication Mode [AD or Local Authentication].

AD_AUTH refers to Active Directory Authentication. Local Authentication or empty value refers to Local Authentication.

 

Note:

  1. The 'assetName' is unique and hence cannot be duplicated and edited.

  2. If 'ServiceTag' is specified, then the information provided for the workstation/server is considered only for that Service Tag and not for the specified asset name.

  3. Product Type should be specified as the 'assetType'. This field is mandatory.

  4. Product of the asset should be specified as the 'productName'.

  5. If the specified 'model' or 'productName' is invalid or empty, then the model is created as 'Unknown ProductType' say, Unknown Workstation.

  6. If the specified 'site' is invalid, the workstation/server is associated to 'Not associated to any site.'

  7. If the specified 'vendor' is invalid and if the technician has permission to add a vendor, then the Vendor is created as specified by the user.

  8. The Resource State should be specified in 'assetState'.

  9. Workstations/Servers with the 'assetstate' as 'In Use', can be associated to departments, users or assets.

  10. If the 'assetstate' is specified as 'In Use' then the values should be specified in the following fields, 'assetToAssociate','associateToUser' or 'associateToDepartment'.

  11. If the assetState is 'In Use' and if the invalid values are provided for the following fields 'assetToAssociate','associateToUser' or 'associateToDepartment', the  state is set to 'In Store'

  12. Workstations/Servers in disposed state cannot be assigned users or departments.

  13. Workstations/Servers in disposed state cannot be assigned with other assets.

  14. Technician with restricted access can create/update workstations/servers only for their associated site.

  15. Technician with restricted access can assign/ associate asset based on his access for that site alone.

  16. To configure the asset additional fields for a workstation, specify the attribute as 'asset_LabelName'

 

Add Workstation/Server

The sample form to Add Workstations/Servers can be accessed here. The 'AddAsset' operation performs only the add operation.

The operation status is Success when the workstation/server is added successfully. The xml response also displays the 'resourceid' and the 'resourcename' along with the message. Click here to view the xml response.

 

The operation status is failure if

 

Update Workstation/Server

The sample form to Update Workstations/Servers can be accessed here. The 'UpdateAsset' operation performs only the update of existing assets with the information provided.

The operation status is Success when the workstation/server is updated successfully. Click here to view the xml response.

 

Save Workstation/Server

The sample form to Save Workstation/Server can be accessed here.

While performing SaveAsset operation, if the asset is already available with the specified criteria, the asset is updated. Else, a new asset is created with the information provided.

 

 

Add/Update Asset

The details to add/update assets should be set in the Http Request parameters and the Http Request parameter value for 'operation' command can be 'AddAsset', 'UpdateAsset' or 'SaveAsset'.

 

Attributes

Comments

targeturl=

"/servlets/AssetServlet"

Target URL for adding/updating asset

assetname

Name of the asset

assettype

Type of asset

productname

Product Name of the asset

sitename

Site to which asset is associated

assettag

Asset Tag

ressino

Serial No. of the asset

barcode

Bar Code of asset

location

Location of asset

purchasecost

Purchase Cost of the asset

vendor

Vendor of asset

acqdate

Acquisition Date of asset

expirydate

Expiry Date of asset

warrantyexpdate

Warranty Expiry Date of asset

assetstate

State of the of asset

assettoassociate

Associate the asset to other assets.(Valid only for Asset State 'In Use').

associatetouser

Associate the asset to user.(Valid only for Asset State 'In Use').

associatetodepartment

Associate the asset to department.(Valid only for Asset State 'In Use').

username

Login Name for SDP Authentication

password

Password for SDP Authentication

domain_name

Domain Name to which the user belongs

logondomainname

Authentication Mode [AD or Local Authentication].

AD_AUTH refers to Active Directory Authentication. Local Authentication or empty value refers to Local Authentication.

Note:

  1. The 'assetName' is unique and hence cannot be duplicated or edited.

  2. Product Type should be specified as the 'assetType'. This field is mandatory.

  3. Product of the asset should be specified as the 'productName'.

  4. If the specified 'model' or 'productName' is invalid or empty, then the model is created as 'Unknown ProductType' say, Unknown Workstation.

  5. If the specified 'site' is invalid, the workstation/server is associated to 'Not associated to any site.'

  6. If the specified 'vendor' is invalid and if the technician has permission to add a vendor, then the Vendor is created as specified by the user.

  7. The Resource State should be specified in 'assetState'.

  8. Assets with the 'assetstate' as 'In Use', can be associated to departments, users or assets.

  9. If the 'assetstate' is specified as 'In Use' then the values should be specified in the following fields, 'assetToAssociate','associateToUser' or 'associateToDepartment'.

  10. If the assetState is 'In Use' and if the invalid values are provided for the following fields 'assetToAssociate','associateToUser' or 'associateToDepartment', the  state is set to 'In Store'

  11. Assets in disposed state cannot be assigned users or departments.

  12. Assets in disposed state cannot be assigned with other assets.

  13. Technician with restricted access can create/update Assets only for their associated site.

  14. Technician with restricted access can assign/ associate asset based on his access for that site alone.

 

Add Asset

Click here to access the sample form.

The operation status is Success when the asset details are added successfully. The xml response also displays the 'asseteid' and the 'resourcename' along with the message. Click here to view the xml response.

 

The operation status is failure if,

 

Update Asset

The sample form to Update Asset can be accessed here. The 'UpdateAsset' operation performs only the update of existing assets with the information provided.

The operation status is Success when the asset is updated successfully. Click here to view the xml response.

 

Save Asset

The sample form to Save Workstation/Server can be accessed here.

While performing SaveAsset operation, if the asset is already available with the specified criteria, the asset is updated. Else, a new asset is created with the information provided.

 

 

Delete Asset

The details necessary for deleting assets should be set in HttpRequest parameters and Httprequest parameter value for operation attribute should be 'DeleteAsset'.

 

Attributes

Comments

targeturl="/servlets/assetservlet"

target URL for deleting asset

assetname

Name of the asset

assettype

type of asset

username

Login Name for SDP Authentication

password

Password for SDP Authentication

domain_name

Domain Name to which the user belongs.

logondomainname

Authentication Mode [AD or Local Authentication].

AD_AUTH refers to Active Directory Authentication.

Local Authentication or empty value refers to Local Authentication.

 

The sample form to delete asset can be accessed here.  

The operation status is a Success if the asset is deleted successfully. Click here to view the xml response.

ServiceDeskPlus - Help Desk and Asset Management Software

Copyright © 2012, ZOHO Corp. All Rights Reserved.
ManageEngine