REresilio
Reports building

Create Report

Create Report.

post/reports

Request

  • Base URL
    https://localhost:8446/api/v2
  • Auth
    API key in header Authorization

Query parameters

wait_for_eventsboolean

Optional flag. If this parameter is present and true (equal true or 1), the Report will only start building when Job Run is finished and all events are delivered. Example: /reports?wait_for_events=true, /reports?wait_for_events=0

Request body

job_run_idnumber required

id of Job Run to create Report for.

paramsobject

Report parameters.

params.fromnumber

Report will only include file events created later than params.from. If not provided, default value is Job Run start time.

params.tonumber

Report will only include file events created earlier than params.to. If not provided and Job run is finished or wait_for_events is True, default value is Job Run finish time. If not provided and Job run is not finished and wait_for_events is False, default value is current timestamp.

params.agent_idsnumber

List of Agent ids. Only events from Agents ids in this list will be included in the Report. If at least one destination Agent is included into Report, all source Agents will be included in the Report as well. If at least one Agent from cluster group is included into Report, all Agents from this cluster group will be included in the Report as well. If not provided, all Agents will be included in the Report. Report building is supported for up to 300 Agents.

params.file_event_entity_typestring

List of file event entry types. Only events with entry types in this list will be included in the Report. If not provided, all file event entry types will be included in the Report. Possible values: file - files, including empty ones, folder - folders, symlink - symlinks, stream - streams, unknown - entities that could not have been identified. Agents earlier than 4.2.0 Report all entities as unknown.

params.files_extobject

Report files extension info by file type

params.files_ext.allstring

All file extension. File will include info about all entities. If not provided, the file will not be created.

params.files_ext.indexed_on_sourcestring

Indexed on source file extension. File will include info about entities indexed on source. If not provided, the file will not be created.

params.files_ext.deleted_on_sourcestring

Deleted on source file extension file extension. File will include info about entities deleted on source. If not provided, the file will not be created.

params.files_ext.archived_on_sourcestring

Archived on source file extension. File will include info about entities archived on source. If not provided, the file will not be created.

params.files_ext.skipped_on_sourcestring

Skipped on source file extension. File will include info about entities skipped on source. If not provided, the file will not be created.

params.files_ext.delivered_to_all_destinationsstring

Delivered to all destinations file extension. File will include info about entities delivered to all destinations. If not provided, the file will not be created.

params.files_ext.not_delivered_to_destinationstring

Not delivered to destination file extension. File will include info about entities not delivered to at least one destination. If not provided, the file will not be created.

Response

Successful response

idnumber required

Report id

job_idstring required

Job id

job_run_idnumber required

Job run id

report_typestring required

Report type.

start_timenumber required

Report start time. Null if Report is not started yet.

finish_timenumber required

Report finish time. Null if Report is not finished yet.

created_atnumber required

Report creation time.

created_bystring required

Username of the user who created the Report.

statusstring required

Report status. Possible values: created - Report is created, waiting_for_job_run_finish - Report is waiting for job run finish, waiting_for_events - Report is waiting for events, in_queue - Report is in queue, in_progress - Report is in progress, aborting - Report is aborting, aborted - Report is aborted, completed - Report is completed.

paramsobject required

Report parameters.

params.fromnumber required

Report will only include file events created later than params.from.

params.tonumber required

Report will only include file events created earlier than params.to.

params.agent_idsnumber required

List of Agent ids. Only events from Agents ids in this list will be included in the Report.

params.file_event_entity_typestring required

List of file event entry types. Only events with entry types in this list will be included in the Report.

params.files_extobject

Report files extension info by file type

params.files_ext.allstring

All file extension. File will include info about all entities.

params.files_ext.indexed_on_sourcestring

Indexed on source file extension. File will include info about entities indexed on source.

params.files_ext.deleted_on_sourcestring

Deleted on source file extension. File will include info about entities deleted on source.

params.files_ext.archived_on_sourcestring

Archived on source file extension. File will include info about entities archived on source.

params.files_ext.skipped_on_sourcestring

Skipped on source file extension. File will include info about entities skipped on source.

params.files_ext.delivered_to_all_destinationsstring

Delivered to all destinations file extension. File will include info about entities delivered to all destinations.

params.files_ext.not_delivered_to_destinationstring

Not delivered to all destinations file extension. File will include info about entities not delivered to at least one destination.

resultobject

Report result.

result.stepstring

Report step. Appears once Report building has started.

result.progressnumber

Report progress in percent. Appears once Report building has started.

result.errorstring

Report error message.

result.allobject

Entities count that are (will be) included in report file all.

result.all.filenumber

Count of file entities.

result.all.foldernumber

Count of folder entities.

result.all.symlinknumber

Count of symlink entities.

result.all.streamnumber

Count of stream entities.

result.all.unknownnumber

Count of unknown entities.

result.indexed_on_sourceobject

Entities count that are (will be) included in report file indexed_on_source. The contents of this object are the same as for result.all.

result.deleted_on_sourceobject

Entities count that are (will be) included in report file deleted_on_source. The contents of this object are the same as for result.all.

result.archived_on_sourceobject

Entities count that are (will be) included in report file archived_on_source. The contents of this object are the same as for result.all.

result.skipped_on_sourceobject

Entities count that are (will be) included in report file skipped_on_source. The contents of this object are the same as for result.all.

result.delivered_to_all_destinationsobject

Entities count that are (will be) included in report file delivered_to_all_destinations. The contents of this object are the same as for result.all.

result.not_delivered_to_destinationobject

Entities count that are (will be) included in report file not_delivered_to_destination. The contents of this object are the same as for result.all.

Changes

No recorded changes to this operation across all 1 revision of this API.