Recommend Runbook


API	SaveRecommendData
Purpose	To recommend runbook.
API URL	https://<API URL>:<API Port>//v2/runbook/recommend/orgentityid/{orgentityid}
Authentication type	Basic /Token
Method Type	Post

Request Format:

{
 "Description": "string",
 "ModuleId": "string",
 "RunbookToolId": "string"
}

Parameter Required in Request body of API


Column	Column Type	Mandatory	Expected/Sample value	Remarks
Description	String	Yes	"Incident details"	This field contains the description
ModuleId	String	Yes	"1"	ModuleId=1 for Incident Management
RunbookToolId	String	Yes	"Tool123"	This field contains the Runbook tool ID
orgentityid	string	Yes	12

Output:

{
 "Count": 1,
 "Result": {
 "ModuleId": "1",
 "RunbookName": "Backup_and_restore_IIS",
 "Similarity": "0.9",
 "Threashold": "0.950000",
 "RunbookFriendlyName": "Backup_and_restore_IIS",
 "Description": "List System processes hung",
 "Parameters": [
 {
 "Param_Name": "choice",
 "DefaultValue": "2",
 "RegEx": "[a-zA-z]+[0-9]+",
 "ProximityList": "",
 "IsPasswordParam": false,
 "CustomScriptIds": "",
 "Param_Fields": [
 {
 "FieldName": "Description",
 "ParseOrder": "regex",
 "IndexValue": 1
 }
 ]
 },
 {
 "Param_Name": "job_id",
 "DefaultValue": "45",
 "RegEx": "[a-zA-z]+[0-9]+",
 "ProximityList": "",
 "IsPasswordParam": false,
 "CustomScriptIds": "",
 "Param_Fields": [
 {
 "FieldName": "Description",
 "ParseOrder": "regex",
 "IndexValue": 1
 }
 ]
 },
 {
 "Param_Name": "snow_incident_id",
 "DefaultValue": "INC000",
 "RegEx": "[a-zA-z]+[0-9]+",
 "ProximityList": "",
 "IsPasswordParam": false,
 "CustomScriptIds": "",
 "Param_Fields": [
 {
 "FieldName": "Description",
 "ParseOrder": "regex",
 "IndexValue": 1
 }
 ]
 },
 {
 "Param_Name": "target_host",
 "DefaultValue": "10.1.160.107",
 "RegEx": "[a-zA2]+[0-9]+",
 "ProximityList": "",
 "IsPasswordParam": false,
 "CustomScriptIds": "",
 "Param_Fields": [
 {
 "FieldName": "Description",
 "ParseOrder": "regex",
 "IndexValue": 1
 }
 ]
 },
 {
 "Param_Name": "time_out",
 "DefaultValue": "10",
 "RegEx": "[a-zA-z]+[0-9]+",
 "ProximityList": "",
 "IsPasswordParam": false,
 "CustomScriptIds": "",
 "Param_Fields": [
 {
 "FieldName": "Description",
 "ParseOrder": "regex",
 "IndexValue": 1
 }
 ]
 },
 {
 "Param_Name": "backup_name",
 "DefaultValue": "test4",
 "RegEx": "[a-zA-z]+[0-9]+",
 "ProximityList": "",
 "IsPasswordParam": false,
 "CustomScriptIds": "",
 "Param_Fields": [
 {
 "FieldName": "Description",
 "ParseOrder": "regex",
 "IndexValue": 1
 }
 ]
 }
 ]
 },
 "Status": "Success",
 "Message": "Runbook recommended successfully."
}

Parameters Returned in API result.


Column	Column type	Value	Remarks
Count	integer	1	Total count of recommended runbooks
Result	json	Runbook details	Details of the recommended runbook, including parameters
Status	String	Success/Fail	This field provides status
Message	String	Message	This field provides Message