Report Object
Reports are the middle-level objects housed under a client and contain report details. The Report object does not hold a list of findings, but each finding includes the ID of a report.
Report Table
The following table explains the fields and data types stored for a report. Fields are presented in alphabetical order by object field name.
| object field name | description | data type |
|---|---|---|
name | name of affected assets | dict {str, {AFFECTED ASSET Object} |
status | status of report | string ["Draft", "Ready For Review", "In Review", "Approved", "Published"] |
includeEvidence | identifies if the report includes evidence | Boolean |
report_id | the UUID of the report | integer |
client_id | client that the report belongs to | integer |
doc_type | field in database to identify object | "report": DB type identifier |
reportType | type of report | "default" |
tags | any tags associated with the report | string array |
custom_field | custom field(s) added to a report | array[ { "label": str, "value": str } ] |
custom_fields | container for fields used to track information about the report executive summary narratives; id (narrative UUID), label (title of narrative), tags (any tags applied to narrative), text (narrative content), isFromNarrativesDB (null/true value identifying if the content is from NarrativesDB). | array[ { "id": str, "label": str, "tags": array[str], "text": str, "isFromNarrativesDB": null or true |
template | if the report did not use the default template, the custom report UUID is listed | string || null: UUID of report template |
start_date | date report was started | null: Zulu date time format |
end_date | date report was closed | null: Zulu date time format |
fields_template | if the report did not use the default fields template, the custom fields template UUID is listed | string || null: UUID of fields/finding template |
exec_summary | a container field that contains any custom fields created for the report | { "custom_fields": array[ { "id": str: CUID of report narrative, "label": str, "tags": array[str], "text": str, } ] } |
isTrackChanges | defines if the rich-text field track changes feature is turned on at the report level (a value of "true" means it is turned on, while a value of "false" means it is turned off and track changes is done per rich-text field) | null or true |
Report Structure
The report object stored in the database is a nested JSON object. Below is a screenshot and sample downloadable file that displays the structure of database objects.
Last updated
