Import Asset Business Metadata

[POST] /rest/2.0/update/am/asset/business/metadata

Import asset business metadata as per input criteria in the request body.

Input ParametersInput Parameters

Parameter

Description

Character Limit

qualysAssetId

(Required to import asset business metadata) Unique ID of the asset

NA

businessAppIds

Unique IDs of the business application   

40

operationalStatus   

Operational status of the asset   

128

environment   

The environment this asset is connected to / runs on   

128

ownedBy   

Person who owns the asset from the business side.   

255

managedBy   

Person who owns the asset from the IT side   

255

supportedBy   

User supporting the asset   

255

supportGroup   

Group supporting the asset   

255

company   

The Company or Subsidiary

128

department   

The departmental organizational structure   

128

assignedLocation.name

The assigned location name, for example building name   

255

assignedLocation.city

The assigned location's city   

128

assignedLocation.state   

The assigned location's state   

128

assignedLocation.country   

The assigned location's country   

128

Sample - Import asset business metadataSample - Import asset business metadata

API Request

curl -X POST -H "Accept: */*" 
-H "Authorization: Bearer <JWTToken>"
-H "Content-Type: application/json" 
-i "<qualys_base_url>/rest/2.0/update/am/asset/business/metadata"
--data-binary @asset-business-metadata.json  
    

 

 If the JSON file mentioned in the request is available in a different directory, provide its path accordingly.

Request Body

{
 "data": [
 {
 "qualysAssetId": "6420613",
 "metadata": {
 "operationalStatus": "Operational",
 "environment": "Production",
 "company": "Qualys",
 "department": "IT Operations",
 "ownedBy": "Pxxl Axxp",
 "managedBy": "Bxxxn Fxxxuna",
 "supportedBy": "John Doe",
 "supportGroup": "IT Operations",
 "businessAppIds": ["2fc86c650a0a0bb4003698b5331640df"],
 "assignedLocation": {
 "name": "401 Biscayne St, Miami FL",
 "street": "401 Biscayne St, Miami FL",
 "city": "Miami",
 "state": "FL",
 "country": "USA"
 }
 }
 },
 {
 "qualysAssetId": "6286688",
 "metadata": {
 "operationalStatus": "Repair",
 "environment": "Development",
 "company": "Qualys",
 "department": "Customer Support",
 "ownedBy": "Pxxl Axxp",
 "managedBy": "Bxxxn Fxxxuna",
 "supportedBy": "John Doe",
 "supportGroup": "Customer Support",
 "businessAppIds":
["27d415a8c0a8000b00ffe2ab0f82e8d2","5678f28f933a31003b4bb095e57ffb88"],
 "assignedLocation": {
 "name": "123 Plazuela Roma Italy",
 "street": "123 Plazuela Roma Italy",
 "city": "Roma",
 "state": "Roma",
 "country": "Italy"
 }
 }
 }
 ]
}  
    

Response

{
   "requestId":"9017b662-01c9-4e74-97c5-eae6d29f08ed",
   "responseMessage":"Asset metadata imported successfully",
   "responseCode":"SUCCESS",
   "failedIds":null
}