Start Analysis

API Start Analysis
Purpose
API URL https://<API URL>:<API Port>///api/v1/analysis/start-analysis
Authentication type Basic/Bearer
Method Type POST
Example: https://<API URL>:<API Port>///api/v1/analysis/start-analysis

analysisJson:

[
 {
 "number": "string",
 "short_description": "string",
 "description": "string",
 "date": "string"
 }
]

Parameters Required in Request Body of API

Column Column type Expected/sample Value Remarks
analysisInput.analysisName string Analysis Mandatory parameter: Analysis Name
analysisInput.runbookToolTypeName string BIGFIX Mandatory parameter : analysis input runbookToolTypeName
analysisInput.type string SAAS Optional value. Analysis input type
analysisInput.isScriptRequired bool true/false Optional value. If isScriptRequired true or not
analysisInput.isKNWRequired bool true/false Optional value. If KNWRRequired true or not
analysisInput.sAASUserEmail string email SAAS user email. Mandatory if authentication is bearer.
Response Messages
Column Column type Value Remarks
statusCode int

  • Created= 201,

  • Success=200

  • Error = 300,

  • RequiredAttributeValueMissing = 400,

  • Unauthorized = 401,

 This field provide status code
status string Success/Fail This field provide status
message string null or message in case of not success
result string XXXXXXXX This field provide unique number for reference