add_available_test_notes
Add custom descriptions to vulnerability assessment test results. As an example, add a custom risk score for your test to a user-defined field. Then, use the Query-Report builder to add the custom field to your custom report. You can then view the custom risk score when you generate the custom report.
This API is available in Guardium v11.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/available_test_notesGuardAPI syntax
add_available_test_notes parameter=valueParameters
| Parameter | Value type | Description |
|---|---|---|
| datasourceType | String | Required. For valid values, call add_available_test_notes from the command line with --help=true.
|
| override | Boolean | Valid values:
Default = 1 (true) |
| testDescription | String | Required. |
| userDefinedNotes | String | Custom comment. |
| userDefinedReferenceOne | String | Custom comment. |
| userDefinedReferenceTwo | String | Custom comment. |
Example
The following example adds custom_notes and custom_reference_text to va_test:
grdapi add_available_test_notes testDescription="va_test" datasourceType="MS SQL SERVER" userDefinedNotes="custom_notes" userDefinedReferenceOne="custom_reference_text"