POST Create an Asset
URL: BaseURL/api/v1/asset
Asset Field Table
Field Name | Field Type | Field Category | Detail Specification |
---|---|---|---|
assetId | String | Hardware,Software,Non-IT | This field is only for view. |
assetTypeName(required) | String | Hardware,Software,Non-IT | In request assetTypeName should be given by bifurcating hierarchical relation with “$” sign. Eg.hardware$computer. |
name(required) | String | Hardware,Software,Non-IT | |
type(required) | String | Hardware,Software,Non-IT | To differentiate the request is of which type i.e HardwareAsset , SoftwareAsset, NonITAsset. |
impactName | String | Hardware,Software,Non-IT | |
statusName | String | Hardware,Software,Non-IT | |
vendorName | String | Hardware,Software,Non-IT | |
productName | String | Hardware,Software,Non-IT | |
departmentName | String | Hardware,Software,Non-IT | |
usedByEmail | Hardware,Software,Non-IT | ||
acquitionDate | String (In above mentioned date format) | Hardware,Software,Non-IT | |
managedByEmail | Hardware,Software,Non-IT | ||
managedByGroupName | String | Hardware,Software,Non-IT | Manage Group Name |
assetGroupName | String | Hardware,Software,Non-IT | Asset Group Name |
locationName | String | Hardware,Software,Non-IT | |
barCode | String | Hardware,Software,Non-IT | |
tags | Set of String | Hardware,Software,Non-IT | |
assignmentDate | String (In above mentioned date format) | Hardware,Software,Non-IT | |
businessServiceName | String | Hardware,Software,Non-IT | |
customField | Key-Value Pair | Hardware,Software,Non-IT | |
description | String | Hardware,Software,Non-IT | |
assetPropertyList | List of Key-Value Pair | Hardware,Software,Non-IT | List of Asset property group associate with an asset. |
ipAddress | String | Hardware | |
hostName | String | Hardware | |
macAddress | String | Hardware | |
swTypeName | String | Software | Software Type Name |
swCategoryName | String | Software | Software Category Name |
installationStatus | Boolean | Software | true/false |
version | String | Software |
Asset property Group Field Table
Hardware Property Group Table
Field Name | Field Type | Detail Specification |
---|---|---|
type (required) | String | Type should be Hardware Property. |
serialNumber | String | |
warrentyExpirationDate | String | |
auditDate | String (In above mentioned date format) | |
propertyCustomField | Key-Value Pair |
Computer Property Group Table
Field Name | Field Type | Detail Specification |
---|---|---|
type (required) | String | Type should be Computer Property. |
osName | String | |
osVersion | String | |
servicePackName | String | |
osLicenceKey | String | |
osManufacturerName | String | |
osArchitecture | String | osArchitecture should be bit_64 / bit_32 / all |
bootupState | String | |
memorySize | Number | Memory size should be in GB |
diskSize | Number | Disk size should be in GB |
cpuSpeed | Number | CPU Speed should be in GHz |
cpuCoreCount | Number | |
partOfDomain | Boolean | true/false |
domainName | Stringr | |
numberOfLogicalProcessors | Number | |
numberOfProcessors | Number | |
pcSystemType | String | |
activationStatus | String | |
lastLoggedInUser | String | Name of Last Logged In User |
propertyCustomField | Key-Value Pair |
SNMP Property Group Table
Field Name | Field Type | Detail Specification |
---|---|---|
type (required) | String | |
systemOID | String | Type should be SNMP Property. |
systemUpTime | Number | systemUpTime Should be in minutes |
firmware | String | |
firmwareVersion | String | |
port | Number | |
contactName | String | |
manufacturerName | String | |
propertyCustomField | Key-Value Pair |
Storage Property Group Table
Field Name | Field Type | Detail Specification |
---|---|---|
type (required) | String | Type should be Storage Property. |
driveType | String | |
diskSpace | Number | Disk Space should be in GB. |
freeSpace | Number | Free Space should be in GB. |
freeSpaceCheckedOn | String (In above mentioned date format) | |
propertyCustomField | Key-Value Pair |
UPS Property Table
Field Name | Field Type | Detail Specification |
---|---|---|
type (required) | String | Type should be UPS Property. |
modelName | String | |
batteryVoltage | String | |
batteryCurrent | String | |
batteryCapacity | String | |
capacity | String | |
voltage | String | |
power | String | |
propertyCustomField | Key-Value Pair |
Firewall Property Group Table
Field Name | Field Type | Detail Specification |
---|---|---|
type (required) | String | Type should be Firewall Property. |
firmware | String | |
firmwareVersion | String | |
port | Number | |
subnetMask | String | |
propertyCustomField | Key-Value Pair |
Mobile Device Property Group Table
Field Name | Field Type | Detail Specification |
---|---|---|
type (required) | String | Type should be Mobile Device Property. |
os | String | |
osVersion | String | |
memory | Number | Memory should be in GB. |
IMEINumber | String | |
propertyCustomField | Key-Value Pair |
Rack Property Group Table
Field Name | Field Type | Detail Specification |
---|---|---|
type (required) | String | Type should be Rack Property. |
footPrint | String | |
powerConsumption | String | |
rackUnits | Number | |
rackUnitsInUse | Number | |
propertyCustomField | Key-Value Pair |
Software Property Group Table
Field Name | Field Type | Detail Specification |
---|---|---|
type (required) | String | Type should be Software Property. |
licenseExpiryDate | String (In above mentioned date format) | |
licenceTypeName | String | License Type Name |
softwareCost | Number | |
lastAuditDate | String (In above mentioned date format) | |
licenseKeys | Set of String | |
executableFileNames | Set of String | |
propertyCustomField | Key-Value Pair |
Example (Request & Response)
Hardware Asset
Request
{
"type" : "HardwareAsset",
"assetTypeName" : "hardware$computer",
"name" : "Hardware Asset Name",
"acquitionDate" : "15-08-2020 13:34",
"tags" : [
"tag-1",
"tag-2"
] ,
"customField" : {
"Custom field name" : "value",
"Custom field name " : "value"
},
"assetPropertyList": [
{
"type": "HardwareProperty",
"field name": "field value",
"propertyCustomField" : {
"Custom field name" : "value",
"Custom field name " : "value"
}
},
{
"type": "ComputerProperty",
"field name": "field value",
"propertyCustomField" : {
"Custom field name" : "value",
"Custom field name " : "value"
}
}
]
}
Response
{
"type": "HardwareAsset",
"id": 1,
"assetTypeName": "Computer",
"assetId": "AST-1",
"name": "Hardware Asset Name",
"impactName": "Low",
"statusName": "In Use",
"origin": "manual",
"acquitionDate": "15-08-2020",
"tags": [
"tag-1",
"tag-2"
],
"customField": {
"hardware-textbox": "hardware-text",
"number": 88
},
"createdDate": "19-10-2020 11:23",
"updatedDate": "19-10-2020 11:23",
"assetPropertyList": [
{
"id": 1,
"refName": "AST-1",
"type": "ComputerProperty",
"osName": "Windows",
"osVersion": null,
"servicePackName": null,
"osLicenceKey": null,
"osArchitecture": null,
"bootupState": null,
"memorySize": 0,
"diskSize": 0,
"domainName": null,
"cpuSpeed": 0,
"cpuCoreCount": 0,
"partOfDomain": false,
"numberOfLogicalProcessors": 0,
"numberOfProcessors": 0,
"pcSystemType": null,
"lastLoggedInUser": null,
"activationStatus": null,
"propertyCustomField": {
"computerproperty-textbox" : "computer-text"
}
}
]
}
Software Asset
Request
{
"type" : "SoftwareAsset",
"assetTypeName" : "software$os",
"name" : "Software Asset Name",
"acquitionDate" : "15-08-2020 13:34",
"tags" : [
"tag-1",
"tag-2"
],
"customField" : {
"number" : 88,
"software-textbox" : "software-text"
},
"assetPropertyList": [
{
"type": "SoftwareProperty",
"softwareCost": 700,
"propertyCustomField" : {
"softwareproperty-textbox" : "softwareproperty-text"
}
}
]
}
Response
{
"type": "SoftwareAsset",
"id": 1,
"assetTypeName": "OS",
"assetId": "AST-3",
"name": "Software Asset Name",
"impactName": "Low",
"statusName": "In Use",
"origin": "manual",
"acquitionDate": "15-08-2020",
"tags": [
"tag-1",
"tag-2"
],
"customField": {
"number": 88,
"software-textbox": "software-text"
},
"createdDate": "19-10-2020 11:30",
"updatedDate": "19-10-2020 11:30",
"assetPropertyList": [
{
"id": 1,
"refName": "AST-3",
"type": "SoftwareProperty",
"softwareCost": 700,
"licenseKeys": null,
"executableFileNames": null,
"propertyCustomField": {
"softwareproperty-textbox": "softwareproperty-text"
}
}
],
"installationStatus": false
}
Non-IT Asset
Request
{
"type" : "NonITAsset",
"assetTypeName" : "non it assets$document",
"name" : "Non IT Asset Name",
"acquisitionDate" : "15-08-2020 13:34",
"tags" : [
"tag-1",
"tag-2"
],
"customField" : {
"number" : 88,
"nonit-textbox" : "nonit-textbox"
}
}
Response
{
"type": "NonITAsset",
"id": 1,
"assetTypeName": "Document",
"assetId": "AST-4",
"name": "Non IT Asset Name",
"impactName": "Low",
"statusName": "In Use",
"origin": "manual",
"acquitionDate": "15-08-2020",
"tags": [
"tag-1",
"tag-2"
],
"customField": {
"number": 88,
"nonit-textbox" : "nonit-textbox"
},
"createdDate": "19-10-2020 11:33",
"updatedDate": "19-10-2020 11:33"
}