Parse
| API | SaveParseData |
|---|---|
| Purpose | To save the ticket details for parse. |
| API URL | https://<API URL>:<API Port>//v2/parse/orgentityid/{orgentityid} |
| Authentication type | Basic /Token |
| Method Type | Post |
Request Format:
{
"ModuleId": "string",
"RunbookName": "string",
"RunbookToolId": 0,
"Description": "string",
"Parameters": [
{
"Param_Name": "string",
"DefaultValue": "string",
"RegEx": "string",
"ProximityList": "string",
"IsPasswordParam": true,
"CustomScriptIds": "string",
"Param_Fields": [
{
"FieldName": "string",
"ParseOrder": "string",
"IndexValue": 0
}
]
}
]
}Parameters Required in Request body of API:
| Column | Column Type | Mandatory | Expected/Sample value | Remarks |
|---|---|---|---|---|
| ModuleId | String | Yes | "1" | Module ID for the associated module (e.g., Incident Management, etc.) |
| RunbookName | String | Yes | "MyRunbook" | Name of the runbook |
| RunbookToolId | Integer | Yes | 1 | ID of the runbook tool |
| Description | String | No | "Runbook description" | Description of the runbook |
| Parameters | Array | No | Array of parameter objects | |
| Param_Name | String | No | "param1" | Name of the parameter |
| DefaultValue | String | No | "defaultValue" | Default value for the parameter |
| RegEx | String | No | "[0-9]+" | Regular expression for parameter validation |
| ProximityList | String | No | "value1,value2" | Comma-separated list of proximity values |
| IsPasswordParam | Boolean | No | true | Indicates if the parameter is a password (true/false) |
| CustomScriptIds | String | No | "script1,script2" | Comma-separated list of custom script IDs |
| Param_Fields | Array | No | Array of parameter field objects | |
| FieldName | String | No | "Description" | Name of the field to parse |
| ParseOrder | String | No | "regex" | Order in which parsing should occur (e.g., "regex", "index") |
| IndexValue | Integer | No | 0 | Index value for parsing |
Output:
{
"Count": 1,
"Result": {
"ModuleId": "1",
"RunbookToolId": 0,
"RunbookName": "Backup_and_restore_IIS",
"IsScheduleNow": "Y",
"ParamValues": [
{
"RunbookParam": "choice",
"RunbookParamDefaultValue": "2",
"IsPasswordParam": "False"
},
{
"RunbookParam": "job_id",
"RunbookParamDefaultValue": "45",
"IsPasswordParam": "False"
},
{
"RunbookParam": "snow_incident_id",
"RunbookParamDefaultValue": "INC000",
"IsPasswordParam": "False"
},
{
"RunbookParam": "target_host",
"RunbookParamDefaultValue": "xx.x.xxx.xxx",
"IsPasswordParam": "False"
},
{
"RunbookParam": "time_out",
"RunbookParamDefaultValue": "10",
"IsPasswordParam": "False"
},
{
"RunbookParam": "backup_name",
"RunbookParamDefaultValue": "test4",
"IsPasswordParam": "False"
}
]
},
"Status": "Success",
"Message": "Runbook parsed successfully."
}Parameters Returned in API result.
| Column | Column type | Value | Remarks |
|---|---|---|---|
| Count | integer | 1 | Total count of parsed runbooks |
| Result | json | Runbook details | Details of the parsed runbook, including parameters |
| Status | String | Success/Fail | This field provide status |
| Message | String | Message | This field provides Message |