File query by Job run

Get file query by Job run id

Returns file query details by Job run id.

get/filequery/byjobrun/{jobRunId}

Request

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

Path parameters

jobRunIdstring required

jobRunId

Response

Successful response

idnumber required

File query id

job_run_idnumber required

Job run id. Files can be queried on active job runs only except for script jobs.

statusstring required

File query status

errorstring required

File query error

start_timenumber required

File query start time

finish_timenumber required

File query finish time

filesnumber required

Number of files to show in result. Required for type "by_file_path" and "by_statuses"

file_pathstring

Show files by specified path. Required for type "by_file_path"

file_regexstring

Filter files by specified regex. For type "by_statuses"

periodnumber

Show deleted files for last N hours. Default value is 24. For type "by_statuses". "file_status_settings.deleted" must be enabled

file_status_settingsobject

Show files with specified statuses. Requried for type "by_statuses"

file_status_settings.cant_sync_nowboolean required

Show files that cannot be synced now.

file_status_settings.deletedboolean required

Show deleted files (see "period" parameter).

file_status_settings.downloadedboolean required

Show downloaded files

file_status_settings.in_queueboolean required

Show files in queue

Changes

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