Watch Folders events can be monitored by sending GET requests to /v3/events/{category}.

These requests can include a filter query to limit events by item/location and state, with the format

filter={name}::{operator}::{expression}

Filter Names and Expressions

The {name} value can be an event statistic, such as creation_time, or a characteristic of the file or drop, as shown in the following table:

Name Description Expressions
data.type The file type
  • REGULAR – a regular file
  • WRAPPER – a package
  • GROWING – a growing file
  • WRAPPER_CANDIDATE – a file that seems to be a package but is not yet stable
  • UNDETERMINED – a file that was just created and is not yet processed
data.local.state The state of the file on the local side
  • INITIAL – the file is not yet proceesed
  • ABSENT – the file was detected by asperawatchd but was not found when processing
  • PRESENT – the file is present and ready for processing
  • UNCERTAIN – a lookup in the file system is required to determine the file’s local state
  • NEVER_APPEARED – the file is referenced by a package but does not exist in the file system
  • DISAPPEARED_BEFORE_COOL_OFF – the file disappeared during cool-off
  • UNSATISFIED_DEPENDENCY – the file references another file that has an error or does not exist
  • ILLEGAL – the file is a package but the content is invalid
  • UNDEFINED – see the remote state to get the local state
  • TRANSFER_FINISHED – the file was transferred
data.local.post_state The state of post-processing on the local system
  • POST_INITIAL – post-processing not yet started on the file
  • POST – the file is in post-processing
  • POST_FINISHED – post-processing on the file completed successfully
  • POST_FAILED – post-processing on the file failed permanently
data.remote.state The state of the file on the remote side
  • INITIAL – the file is not yet proceesed
  • TRANSFERRING – the file is transferring
  • TRANSFER_FINISHED – the file was transferred
  • TRANSFER_RETRY_INCRMENT – the file transfer failed and is being retried; the retry counter is incremented
  • TRANSFER_RETRY – the file transfer failed and is being retried
  • TRANSFER_POSTPONED – the file transfer is postponed
  • TRANSFER_FAILED – the file transfer failed permanently on the destination
  • TRANSFER_FAILED_TO_START – the transfer failed to start due to an error on the local side
  • SKIPPED – the file was skipped because it already exists on the destination
  • UNDEFINED – see the local state to get the remote state
  • IGNORED – the file was skipped by ascp
  • ABORTED – the file was not transferred because the drop failed
data.remote.post_state The state of post-processing on the remote system
  • POST_INITIAL – post-processing not yet started on the file
  • POST – the file is in post-processing
  • POST_FINISHED – post-processing on the file completed successfully
  • POST_FAILED – post-processing on the file failed permanently
error Only added if an error occurred not applicable
data.state The state of the drop
  • PROCESSING – the files in the drop are transferring
  • POST_PROCESSING – the files transferred and are in post-processing
  • SUCCEEDED – the drop completed without errors
  • FAILED – the drop completed with errors
  • RETRY – the drop has errors and is being retried
data.parent_drop A drop that was retried

Filter Operators

  • eq – equal
  • neq – not equal
  • gt – greater than
  • gte – greater than or equal to
  • lt – less than
  • lte – less than or equal to

Filter Query Examples

Filters can be combined to be additive (AND) or exclusive (OR).

  • AND

    Connect multiple filters with “&”. For example:

    https://10.0.0.1:9092/v3/events/watchfolder?filter=data.local.state::eq::INITIAL&filter=creation_time::gt::2015-03-03
    
  • OR

    Separate multiple filters with “|”. For example:

    https://10.0.0.1:9092/v3/events/watchfolder?filter=data.local.state::eq::INITIAL|data.local.state::eq:PRESENT
    
  • Combinations of AND and OR
    https://10.0.0.1:9092/v3/events/watchfolder?filter=data.local.state::eq::INITIAL|data.local.state::eq::PRESENT&filter=creation_time::gt::2015-03-03