v1

latestOpenAPI 3.1.0Apache 2.02026-07-178042197.1 KB
FlowSegments

List Flow Segments

Return Flow Segments path headers

head/flows/{flowId}/segments

Query parameters

object_idstring

Filter on Object identifier.

timerangestring

A timerange of timestamps. It is represented using one or two timestamps with inclusivity and exclusivity markers.

E.g.

  • [0:0_10:0) represents 10 seconds of media starting at timestamp 0:0 and ending before 10:0.
  • (5:0_ represents a timerange starting after 5:0 and to eternity.
  • _ without timestamps or inclusivity markers represents "eternity" (i.e. the entire timeline).
  • () without timestamps represents "never" (i.e. a range of zero length in no particular position).
  • [1694429247:0_1694429248:0) is a 1 second TAI timerange starting at 2023-09-11T10:46:50.0Z UTC.
  • [1694429247:0] is an instantaneous TAI timerange at 2023-09-11T10:46:50.0Z UTC. This is equivalent to [1694429247:0_1694429247:0]. The short syntax is preferred due to ease of identification as instantaneous. Instantaneous TimeRanges cannot use exclusive markers (i.e. ( or )).
  • A [ or ] indicates that bound is inclusive, and a ( or ) indicates that bound is exclusive.

Details of the format can be found in the Timestamps in TAMS application note.

Return only the results that partially or wholly overlap the timerange specified.

reverse_orderboolean

Return Segments in reverse time order.

verbose_storageboolean

Include storage metadata in get_urls in the response. When verbose_storage is false only url, presigned, and label will be included in get_urls and init_object.get_urls.

accept_get_urlsstring

A list of Object GET URL Labels, formatted for use in query string parameters

A comma separated list of labels of Flow Segment get_urls and init_object.get_urls to include in the response. Omitting accept_get_urls will result in no filtering of get_urls or init_object.get_urls. An empty accept_get_urls results in get_urls and init_object.get_urls being empty or omitted in the response. Flow Segment get_urls and init_object.get_urls with no label will only be returned if accept_get_urls is omitted. Without get_urls, the response from the service could be substantially faster if it is not required to generate a large number of pre-signed URLs for example. Where multiple filter query parameters are provided, the returned get_urls and init_object.get_urls will match all filters.

accept_storage_idsstring

A list of Universally Unique Identifiers (UUIDs) as defined in RFC9562, formatted for use in query string parameters

A comma separated list of storage_ids of Flow Segment get_urls and init_object.get_urls to include in the response. Omitting accept_storage_ids, or providing an empty accept_storage_ids will result in no filtering of get_urls or init_object.get_urls. Flow Segment get_urls and init_object.get_urls with no storage ID will only be returned if accept_storage_ids is omitted or empty. A full list of available storage_ids may be found at the /service/storage-backends endpoint. Where multiple filter query parameters are provided, the returned get_urls and init_object.get_urls will match all filters.

presignedboolean

If set to true, only presigned URLs (i.e. those whos presigned property is true) will be returned in get_urls and init_object.get_urls in the response. If set to false, only non-presigned URLs (i.e. those whos presigned property is false) will be returned in get_urls and init_object.get_urls. If omitted, both presigned and non-presigned URLs will be returned. If presigned is set to false, the response from the service could be substantially faster if it is not required to generate a large number of pre-signed URLs. Where multiple filter query parameters are provided, the returned get_urls and init_object.get_urls will match all filters.

include_object_timerangeboolean

If set to true, the underlying object's timerange should appear in the response. Assume false if omitted.

pagestring

Opaque string used by backend to access a specific page of results. Clients should read the next URL from the Link header returned with responses, or use value of the returned X-Paging-NextKey header. If not supplied, the first page is accessed. Service implementations should ensure a consistent sort order is applied to pages of results.

limitinteger

Restrict the response to the specified number of results. Service implementations may specify their own default and maximum for the limit

Response

string required