Virima API Specification - RunBookService Services

The requests documented in this section are directed to RunBookService resources, which represent .

Contents

1 editRunBook POST Interface
2 editRunBookTasks POST Interface
3 getAllRunBookTasks GET Interface
4 deleteMultipleRunbookTask POST Interface
5 getAllEmptyRunBookTasks GET Interface
6 updateAndMarkRunbookTask POST Interface
7 executeRunBook GET Interface
8 getRunBookTaskById GET Interface
9 resetPassword POST Interface

editRunBook POST Interface

Method: POST

Relative URL: runbook/edit-runbook

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
runbookInfo	RunBook

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

EDITRUNBOOK 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":2147483647,
   "runBookName":"?",
   "description":"?",
   "lastModifiedOn":?,
   "createdOn":?,
   "uniqueId":"?",
   "archive":?,
   "lastModifiedBy": {
         "id":1536028071,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "createdBy": {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }
}

Example Response:

{
   "id":1351597695,
   "response":"?"
}

editRunBookTasks POST Interface

Method: POST

Relative URL: runbook/edit-runbook-tasks/run-book-id

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
arrayOfTasks	ArrayOfRunBookTask

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

EDITRUNBOOKTASKS 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":319882380,
   "runBookTask":[
      {
         "id":2147483647,
         "taskName":"?",
         "commandType":"?",
         "command":"?",
         "timeOut":"?",
         "cascadeOnError":?,
         "cascadeOnSuccess":?,
         "waitTime":"?",
         "host":"?",
         "client":"?",
         "taskOrder":?,
         "probe":?,
         "lastModifiedOn":?,
         "createdOn":?,
         "uniqueId":"?",
         "archive":?,
         "runBook": {
               "id":181313480,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            }
      }   ]
}

Example Response:

{
   "id":2147483647,
   "response":"?"
}

getAllRunBookTasks GET Interface

Method: GET

Relative URL: runbook/get-all-runbook-task/run-book-id

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

{
   "id":2147483647,
   "response":"?"
}

deleteMultipleRunbookTask POST Interface

Method: POST

Relative URL: runbook/delete-multiple-runbook-tasks

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
listOfIds	RecordList

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

DELETEMULTIPLERUNBOOKTASK 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":35415466,
   "scanId":?,
   "workflowId":?,
   "fromSACM":?,
   "customerId":"?",
   "userId":"?",
   "startTime":"?",
   "idList":[
      {
         "id":1011016666,
         "flag":?
      }   ]
}

Example Response:

{
   "id":2147483647,
   "response":"?"
}

getAllEmptyRunBookTasks GET Interface

Method: GET

Relative URL: runbook/get-all-empty-runbook-task/run-book-id

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

{
   "id":2147483647,
   "response":"?"
}

updateAndMarkRunbookTask POST Interface

Method: POST

Relative URL: runbook/update-mark-runbook-tasks/run-book-id/id/module

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
arrayOfTasks	ArrayOfRunBookTask

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

UPDATEANDMARKRUNBOOKTASK 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":2147483647,
   "runBookTask":[
      {
         "id":2147483647,
         "taskName":"?",
         "commandType":"?",
         "command":"?",
         "timeOut":"?",
         "cascadeOnError":?,
         "cascadeOnSuccess":?,
         "waitTime":"?",
         "host":"?",
         "client":"?",
         "taskOrder":?,
         "probe":?,
         "lastModifiedOn":?,
         "createdOn":?,
         "uniqueId":"?",
         "archive":?,
         "runBook": {
               "id":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            }
      }   ]
}

Example Response:

{
   "id":837625577,
   "response":"?"
}

executeRunBook GET Interface

Method: GET

Relative URL: runbook/execute-runbook/run-book-id/incident-id/module/workflow-id

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

{
   "id":152164725,
   "response":"?"
}

getRunBookTaskById GET Interface

Method: GET

Relative URL: runbook/get-runbook-task-by-id/run-book-id

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

{
   "id":2147483647,
   "response":"?"
}

resetPassword POST Interface

Method: POST

Relative URL: runbook/reset-password

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
resetPassword	ResetADPassword

Response Structure:

Field Name	Type	Description
resp	Response

Example Request:

RESETPASSWORD 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "email":"?",
   "instance":"?",
   "requestId":"?",
   "customerId":"?",
   "taskId":"?"
}

Example Response:

{
   "id":2147483647,
   "response":"?"
}