V2
Save Schedule Runbook
| API | SaveScheduleRunbook |
|---|---|
| Purpose | To schedule the runbook through API |
| API URL | https://<API URL>:<API Port>/v2/serviceRequests/orgentityid/{orgentityid} |
| Authentication type | Basic |
| Method Type | Post |
|
Request Format: |
|
Parameters Required in Request Body of API
| Column | Column Type | Mandatory | Expected/Sample value | Remarks |
|---|---|---|---|---|
| OrgId | String | Yes | 5 | This field contains the Organization ID |
| ModuleId | String | Yes | 4 | This field contains the Module ID |
| RunbookToolId | String | Yes | 3 | This field contains the Runbook Tool ID |
| RunbookId | String | Yes | 7611 | This field contains the Runbook ID |
| RunbookScheduleId | String | Yes | 19532 | This field contains the Runbook Schedule ID |
| FrequencyId | String | Yes | 3 | This field contains the valid Frequency ID if IsRecurring = Y else it contains -1 |
| ScheduleMinute | String | Yes | 5 | This field contains the valid Scheduled Minutes if IsRecurring = Y else it contains -1 |
| ScheduleHour | String | Yes | 2 | This field contains the valid Scheduled Hours if IsRecurring = Y else it contains -1 |
| DaysofWeek | String | Yes | 1 | This field contains the valid Days of Week if IsRecurring = Y else it contains -1 |
| DateofMonth | String | Yes | 2 | This field contains the valid Date of the Month if IsRecurring = Y else it contains -1 |
| IsActive | String | Yes | Y/N | This field is used to check if it active or not |
| RunDate | String | Yes | 2099-01-01T10:10:10 | This field contains the valid Run Date if IsRecurring = N else it contains null |
| IsRecurring | String | Yes | Y/N | This field contains whether it will be recurring more than once |
| TimeOutPeriod | String | Yes | 10Min | This field contains the time out period |
| ActivityCode | String | Yes | INSERT | This field contains the activity code |
| ParamValues | String | Yes | [{"RunbookParamId":"18547","RunbookParam":"ComputerName","RunbookParamDefaultValue":"SRVAT0046","IsPasswordParam":"Text"}] | This field contains the Parameter values |
Output:
{
"Id": "XXXXXXXX ",
"Status": "Success",
"Message": "Manage Schedule Runbook inserted successfully";
}Parameters Returned in Response of API
| Column | Column type | Value | Remarks |
|---|---|---|---|
| Id | string | XXXXXXXX | This field provide unique number for reference |
| Status | string | Success/Fail | This field provides the status |
| Message | string | Manage Schedule Runbook inserted successfully | Success /fail message |