UpdateRunbookStatus

Update Runbook Status

API UpdateRunbookStatus
Purpose To update the status of runbook.
API URL https://<API URL>:<API Port>/iAutomateAPI/Request/UpdateRunbookStatus/<OrgID>
Authentication type Basic
Method Type PUT
Example: URL>:<API Port>/iAutomateAPI/Request/UpdateRunbookStatus/1

Input JSON:

{
"JobId": 1,
"TicketNumber": "XXXXXXXX ", 
 "RbaInteractionId": "XXXXXXXX ",
 "RbaStatusCode": "1",
 "RbaStatusMessage": "iAutomate update",
"Option1": "optional value",
"Option2": "optional value",
"Option3": "optional value",
"Option4": "optional value"
}

Parameters Required in Request Body of API

Column Column type Expected/sample Value Remarks
JobId int 1 The id for the ExecuteRunbook job of the organization with ID mentioned in API URL
TicketNumber string XXXXXXXX The number of the ticket for which update needs to be sent.
RbaInteractionId string XXXXXXXX The interaction ID generated for the ticket process.
RbaStatusCode string 1 Refer below table.
RbaStatusMessage string test The message from the RBA tool while updating a ticket.
Option1 string optional This is an optional value which can be used to send extra information by Tool to store in iAutomate
Option2 string optional This is an optional value which can be used to send extra information by Tool to store in iAutomate
Option3 string optional This is an optional value which can be used to send extra information by Tool to store in iAutomate
Option4 string optional This is an optional value which can be used to send extra information by Tool to store in iAutomate

RbaStatusCode:

Figure 1. Runbook Status
Column Column type Value Remarks
statusCode int
  • 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