Asset Attributes and xml Response

     

    The operations that can be performed with assets are described below  
     

     Note

    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. When renaming the button in the sample html form, specify 'operation' as hidden element.

     



     

    Add/Update Workstation and Server

    To add or update a workstation or a server, the targetURL attribute should be set to /servlets/AssetServlet.
    'operation' attribute be set to
    AddAsset: Used to add a new workstation/server.
    UpdateAsset: Used to update a new workstation/server.
    SaveAsset: Used for both adding and updating a workstation/server.
    'accountName', 'siteName', 'assetName' and 'assetType' are mandatory parameters.

     

    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)

    accountName

    account to which workstation/server is associated

    siteName

    site to which workstation/server is associated

    ipAddress

    ipaddress of workstation/server.

    serviceTag

    Service Tag of workstation/server

    wsManufacturer

    Workstation Manufacturer

    proCount

    Number of cores in the Processor

    proType

    proType of workstation/server

    proSpeed

    proSpeed of workstation/server

    proManufacturer

    proManufacturer of workstation/server

    ramSize

    ramSize of workstation/server

    virtualCapacity

    virtualCapacity of workstation/server

    osName

    osName of workstation/server

    osServicePack

    osServicePack of workstation/server

    resTag

    resTag of workstation/server

    resSlNo

    resSlNo of workstation/server

    barCode

    barCode of workstation/server

    location

    location of workstation/server

    vendor

    vendor of workstation/server

    acqDate

    Acqisition Date of workstation/server

    expiryDate

    expiryDate of workstation/server

    warrantyExpDate

    warrantyExpiryDate of workstation/server

    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

    macAddress of workstation/server

    nicInfo

    NicInfo of workstation/server

    netAddress

    netAddress of workstation/server

    domain

    domain of workstation/server

    dnsServer

    dnsServer of workstation/server

    gateway

    gateway of workstation/server

    dhcpEnabled

    dhcpEnabled of workstation/server

    monitorType

    monitorType of workstation/server

    monitorSerialNumber

    monitorSerialNumber of workstation/server

    monitorManufacturer

    monitorManufacturer of workstation/server

    mouseType

    mouseType of workstation/server

    mouseSerialNumber

    mouseSerialNumber of workstation/server

    mouseManufacturer

    mouseManufacturer of workstation/server

    keyboardType

    keyboardType of workstation/server

    keyboardSerialNumber

    keyboardSerialNumber of workstation/server

    keyboardManufacturer

    keyboardManufacturer of workstation/server

    username

    Login Name for ServiceDesk Plus - MSP Authentication

    password

    Password for ServiceDesk Plus - MSP 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 '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. Workstations/Servers 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. Workstations/Servers in disposed state cannot be assigned users or departments.

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

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

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

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

    • The mandatory fields are not specified

    • The technician with restricted access is trying to create a new workstation/server.

     

    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 Save Asset 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

    To add or update an asset, the targetURL attribute should be set to /servlets/AssetServlet.
    'operation' attribute be set to
    AddAsset: Used to add a new workstation/server.
    UpdateAsset: Used to update a new workstation/server.
    SaveAsset: Used for both adding and updating a workstation/server.
    'accountName', 'siteName', 'assetName' and 'assetType' are mandatory parameters.

     

    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

    accountName

    Account to which asset is associated

    siteName

    site to which asset is associated

    assetTag

    asset Tag

    assetSlNo

    Serial No of the asset

    barCode

    barCode of asset

    location

    location of asset

    purchaseCost

    PurchaseCost of the asset

    vendor

    vendor of asset

    acqDate

    Acqisition Date of asset

    expiryDate

    expiryDate of asset

    warrantyExpDate

    warrantyExpiryDate 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 ServiceDesk Plus - MSP Authentication

    password

    Password for ServiceDesk Plus - MSP 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 'vendor' is invalid and if the technician has permission to add a vendor, then the Vendor is created as specified by the user.

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

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

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

    9. 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'

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

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

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

    13. 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,

    • The mandatory fields are not specified

    • The technician with restricted access is trying to create a new asset.

     

    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

    To delete an asset, the targetURL attribute should be set to /servlets/AssetServlet and the 'operation' attribute should be 'DeleteAsset'. The 'accountName', 'siteName', 'assetName' and 'assetType' parameters are mandatory.

     

    Attributes

    Comments

    targetURL="/servlets/AssetServlet"

    target url for deleting asset

    assetName

    Name of the asset

    assetId

    ID of the asset

    assetType

    type of asset

    accountName

    Account to which the asset belongs

    siteName

    Site to which the asset belongs

    username

    Login Name for ServiceDesk Plus - MSP Authentication

    password

    Password for ServiceDesk Plus - MSP 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.

     

    Add/Update Asset Type

    To Add/Update asset type, the targetURL attribute should be set to /servlets/AssetServlet and the 'operation' attribute should be 'SaveAssetType'.The 'typeName', 'type' and 'category' parameters are mandatory while adding an asset type and the parameter 'typeName' is mandatory while updating an asset type.

     

    Attributes

    Comments

    targetURL="/servlets/AssetServlet"

    target url for Adding/updating an asset type

    typeName

    Asset type name(Eg.UPS)

    type

    type of the asset(Asset/Component)

    category

    Category of the asset type(IT/Non-IT)

    description

    Description about the asset type

    username

    Login Name for ServiceDesk Plus - MSP Authentication

    password

    Password for ServiceDesk Plus - MSP 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 Add/Update asset type can be accessed here.  

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

     

    Copyright © 2017, ZOHO Corp. All Rights Reserved.