RATS Common Query-String Arguments
A number of query-string arguments can be applied when retrieving an atom feed for any RATS resource.
Date/time of resource creation or update
When retrieving a list of RATS resource instances, they can be filtered by date using the following query-string arguments:
- created_before : show only resource instances created before this date
- created_after : show only resource instances created after this date
- updated_before : show only resource instances updated before this date
- updated_after : show only resource instances updated after this date
The value for these arguments should always be a string formatted as YYYY-MM-DDThh:mm:ss (e.g. 1997-07-16T19:20:30). The date part is required, the time part is optional (e.g. 1997-07-16 is also allowed). If the data or formatting is incorrect, RATS will ignore the query-string argument altogether.
The creation date refers to the moment RATS accepted the initial POST request, thus creating the resource instance. The update date of a resource instance is initially the same as its creation date, but it will be modified when the instance's data is later being changed (either by a subsequent POST or PUT request (e.g. profiles), or by RATS itself (e.g. jobs)).
Name / Filename
These query-string arguments allow filtering either a list of profile resources (input, output, format) based on their names, or a list of media resources (src, overlay, transc) based on their filenames.
- name : show only resource instances for which the (file)name matches this string exactly (case sensitive)
- iname : show only resource instances for which the (file)name matches this string exactly (case insensitive)
- name_has : show only resource instances for which part of the (file)name matches this string (case sensitive)
- iname_has : show only resource instances for which part of the (file)name matches this string (case insensitive)
Certain profile resources (input, output, format) may have two different owners:
- private profiles are created by a specific RATS user and are only accessible by this user
- system profiles are created by Rambla and are accessible by all users
The 'owner' query-string argument determines which kind of profiles are included in a list of resources. This argument can have 3 possible values:
- ?owner=self (default): only private profiles are returned in the resource list
- ?owner=sys : only system profiles are returned in the resource list
- ?owner=all : both system profiles and private profiles are returned in the resource list
Note: when using the 'owner' query-string argument 'all', 'self' or 'sys' for the RATS format resource, formats for adaptive streaming purposes will not be returned. To retrieve formats for adaptive streaming (created by Rambla and you) use the 'adaptive' argument instead.
When retrieving a list of media resources (src, overlay, transc), the extension argument can also be used for filtering resource instances based on the filename's extension. The full extension should be passed as the argument's value (e.g. to get all transcoded flv files -> "http://rats.cdn01.rambla.be/transc/?extension=flv").