Draft Runbook
| API | GetDraftRunbookData |
| Purpose | To get data of the Draft runbook. |
| API URL |
https://\<API URL\>:\<API Port\>//v2/runbook/draftrunbook/orgentityid/{orgentityid} |
| Authentication type | Basic /Token |
| Method Input | GET |
| Input Params in Query String: |
You can pass the following filters in the URL to get desired data:
|
Parameters Required in Request body of API
| Column | Column type | Remarks |
|---|---|---|
| orgentityid | string | The organization entity ID. |
| runbooktoolid | string | The runbook tool ID |
Output:
{
"Count": 1,
"Result": [
{
"RunbookUniqueName": "Windows_AnsibleAwx_servicetest",
"RunbookUserFriendlyName": "Windows_AnsibleAwx_servicetest",
"RunbookDescription": "Execute the master template on the ticket opened",
"CreatedDate": "2025-09-05T11:36:22.273",
"RBAToolRole": "Windows_AnsibleAwx_servicetest",
"TicketDescription": "Execute the master template on the ticket opened",
"GeneratedBy": "superadmin@hcl.com"
}
],
"Status": "Success",
"Message": "Draft runbooks retrieved successfully."
}Parameters Returned in API result.
| Column | Column type | Value | Remarks |
|---|---|---|---|
| Result | json | Runbook details | Runbook details |
| Status | String | Success/Fail | This field provide status |
| Message | String | Message | This field provides Message |