create_ad_hoc_audit_and_run_with_name

This API is available in Guardium V9.5 and later.

REST API syntax

This API is available as a REST service with the POST method. Call this API as follows: 
POST https://[Guardium hostname or IP address]:8443/restAPI/ad_hoc_audit_and_run_once

GuardAPI syntax

create_ad_hoc_audit_and_run_with_name parameter=value

Parameters

Parameter Value type Description
changeParIfExist Boolean Required. Indicates whether to update the task parameters if the process exists. Valid values:
  • 0 (false)
  • 1 (true)
emailContentType Integer The type of content to send to users on the sendToEmails list. Valid values:
  • 0: PDF
  • 1: CSV
includeUserReceiver Boolean Create a receiver for the logged-in user. Valid values:
  • 0 (false)
  • 1 (true)
isForReportRunOnce Boolean Required. Valid values:
  • 0 (false)
  • 1 (true)
processNamePar String If not blank, create a process with the specified name.
reportName String Required. For valid values, call create_ad_hoc_audit_and_run_with_name from the command line with --help=true.
sendToEmails String All task parameters and their values concatenated with the characters ^^.

For example:

PAR1=Val1^^PAR2=Val2^^

You can leave a parameter empty. For example, to leave PAR2 empty: PAR1=VAL1^^PAR2=^^PAR3=VAL3^^
taskParameter String All task parameters and their values concatenated with the characters ^^.

For example:

PAR1=Val1^^PAR2=Val2^^

You can leave a parameter empty. For example, to leave PAR2 empty: PAR1=VAL1^^PAR2=^^PAR3=VAL3^^
templateName String For valid values, call create_ad_hoc_audit_and_run_with_name from the command line with --help=true.
ticketAssignToGroup String If ticketReceiver is set to 1 (true), create an external ticket, assign the ticket to the specified group name or ID, and send the ticket to the external ticketing system (ServiceNow).
ticketAssignToMember String If ticketReceiver is set to 1 (true), create an external ticket, assign the ticket to the specified member name or ID, and send the ticket to the external ticketing system (IBM Resilient).
ticketAssignToUser String If ticketReceiver is set to 1 (true), create an external ticket, assign the ticket to the specified user name or ID, and send the ticket to the external ticketing system (ServiceNow).
ticketReceiver Boolean If set to 1, add a receiver of type Ticket to the audit process result. When the audit process runs, Guardium creates a ticket and attaches the audit process result (as a PDF). Valid values:
  • 0 (false)
  • 1 (true)

Default = 0 (false)
writeToSyslog Boolean Valid values:
  • 0 (false)
  • 1 (true)

Default = 0 (false)