This page defines common query parameters that can be used when querying an aa:time-based resource.
end
A frame number (integer). Only segments that are within the time range ending at the given frame number in the asset are returned. This includes segments that are only partially in that range.
lang
Specifies the language or locale for localizable information, if supported. The value must be a must be a valid IETF BCP 47 language tag.
-
If missing or empty, labels for language "en" will be returned.
-
If there is no label for the given language tag, the response will automatically fall back to another label (usually the English one), but return it with the given language tag. Example: If the caller asks for ?lang=fr and there is no French label, then the response will contain "fr" as language tag, but a fallback label as value:
{
"labels": {
"fr": "English label"
}
}layers
A comma-separated list of layers that shall be returned. If the query parameter is missing or empty, all layers are returned.
segmentids
A comma-separated list of segment IDs. Only segments with the given IDs are returned. If not given or the list is empty: return all segments.
start
A frame number (integer). Only segments that are within the time range starting at the given frame number in the asset are returned. This includes segments that are only partially in that range.
username
Login name of a user. Only segments that were created by the user with login name Bob are returned. If not given, all segments are returned. This query parameter may be ignored by some systems.