Nearly identical to Activity view in the Console graphical interface (multi-step Smart Transfers will show up as multiple individual items each with its own ID).

Request (GET)

An Example URL

https://console.asperasoft.com/aspera/console/api/transfers?from=2013-01-01%2012:00:00&to=2013-01-01%2013:00:00&filter1=status&comp1=eq&val1=inactive

Query Parameters

  • from - UTC Date/Time, "2013-02-28 12:00:00"
  • to - UTC Date/Time, "2013-02-28 12:30:00", if blank current time will be used
  • additional_filters
    • filter1 (field to filter against: started_at | stopped_at | status | transfer_name | contact | filename)
    • comp1 (comparison to use:  contain | eq | gt | gte | in | lt | lte | is_not_null | is_null | match_re | neq | start_with)
    • val1 (value to compare with, e.g.: "running")
    • filter2 (all filters are joined by AND)

Comparator Descriptions

contain
contains (only valid for text fields, not filenames)
eq
equals
gt
greater than (or alphabetically after, for text fields)
gte
greater than or equal to
in
is one of a list of values (separate values with commas)
is_not_null
is not null
is_null
is null
lt
less than (or alphabetically before, for text fields)
lte
less than or equal to
match_re
matches regular expression (only valid for text fields, not allowed for filename)
neq
not equal to
start_with
starts with (only valid for text fields)

Filter Requirements

  • 'from' is required
  • 'to' is optional if 'from' is less than 24 hours ago, otherwise it is required and must be no later than 'from' + 24 hours
  • All datetimes are interpreted as UTC unless time zone is specifically included in the parameter, e.g. "2013-02-28 14:00 -0800". However, it is recommended that you convert datetimes to UTC and then pass them to the API without the timezone (e.g. "2013-02-28 22:00")
  • All query parameters must be URL encoded. For example,  spaces replaced with "%20"
  • Certain filter specifications are not allowed due to performance considerations. For example,  filter = 'filename' and comp =  'match_re'

Reply

If Success; an Array with the list of transfers represented by hashes and containing summary information on each one is returned. An example of this Array is seen below. If Error, a description of the problem will be returned if available.

 
Video player

Video

×