Import Business App Metadata

[POST] /rest/2.0/update/am/businessapp/metadata

Import business app metadata as per input criteria in the request body

Input ParametersInput Parameters

Parameters

Description

Character Limit

name

(Required to import business app metadata) Name of the business application.   

255

businessAppid

(Required to import business app metadata) Unique ID of the business application.   

40

operationalStatus   

Operational status of the application.   

255

businessCriticality   

How critical the application is to the business.   

255

environment   

Designates how this business app is used, e.g. Production, Staging, QA, etc.   

255

ownedBy   

Person who owns the application from the business side.   

255

managedBy   

Person who owns the application from the IT side.   

255

supportedBy   

User supporting the business application   

255

supportGroup   

Group supporting the business application   

255

created

(Required to import business app metadata) Business app created date

NA

lastUpdated

(Required to import business app metadata) Business app last updated date

NA

Sample - Import business app metadataSample - Import business app metadata

API Request

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

 

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

Request body

{
 "data": [
 {
 "businessAppId": "2fc86c650a0a0bb4003698b5331640df",
 "name": "Banking Service",
 "businessCriticality": "1 - Most Critical",
 "status": "Installed",
 "environment": "Production",
 "usedFor": "Production",
 "created": 1620643264000,
 "lastUpdated": 1620653309000,
 "operationalStatus": "Installed",
 "ownedBy": "Pxxl Axxp",
 "managedBy": "Bxxxn Fxxxuna",
 "supportedBy": "John Doe",
 "supportGroup": "IT Operations"
 },
 {
 "businessAppId": "5678f28f933a31003b4bb095e57ffb88",
 "name": "Customer Support Portal",
 "businessCriticality": "3 - Low",
 "status": "Installed",
 "environment": "Development",
 "usedFor": "Development",
 "created": 1620643264000,
 "lastUpdated": 1620653309000,
 "operationalStatus": "Installed",
 "ownedBy": "Pxxl Axxp",
 "managedBy": "Bxxxn Fxxxuna",
 "supportedBy": "John Doe",
 "supportGroup": "Application Security"
 }
 ]
}  
    

Response

{
 "requestId": "8e9b3fd5-bb89-4666-a472-4bc5758335a2",
 "responseMessage": "Business app metadata imported successfully",
 "responseCode": "SUCCESS",
 "failedIds": null
}      
    

If the business app data for the associated business app id of the asset is not present then the association of that business app with the asset will not happen but the rest of all the data will get updated.