Sign in
Flows

List Flows

Return Flows path headers

head/flows

Query parameters

source_idstring

A Universally Unique Identifier (UUID) as defined in RFC9562

Filter on Source 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.

Filter on Flows that overlap the given timerange.

format'urn:x-nmos:format:video' | 'urn:x-tam:format:image' | 'urn:x-nmos:format:audio' | 'urn:x-nmos:format:data' | 'urn:x-nmos:format:multi' uri

Identifies the content format for a Flow or Source using a URN string

Filter on Flow format.

codecstring

A Mime Type without parameters as defined in RFC2045 and RFC7231

Filter on Flow codec.

profile_idstring

A Universally Unique Identifier (UUID) as defined in RFC9562

Filter on Profile identifier.

labelstring

Filter on Flows that have the given label.

reverse_orderboolean

Return Flows in reverse order.

sort_by'created' | 'metadata_updated' | 'label'

Parameter to sort Flows by. created and metadata_updated sort most recent first by default. label sorts alphabetically by default. Sorting may be reversed using the reverse_order query parameter. Assume created if not set. For resources where the selected parameter is unset, id shall be used. Resources using this fallback shall be sorted after those that aren't by default, and before when reverse_order is true.

status'awaiting_content' | 'ingesting' | 'replication_in_progress' | 'closed_complete'

The current ingest status of a Flow. Available values are as follows. awaiting_content - Flow is expecting, but not currently receiving content. ingesting - Content is currently being ingested. replication_in_progress - Content is currently being ingested to this Flow from another Service Instance via a replication process. closed_complete - Flow is complete and will not receive any more content. NOTE: Because this parameter is maintained/updated by a Client, the value of this parameter is only indicative and not authoritative. If the Client ingesting the content becomes unavailable, it may leave this parameter in an incorrect state. Clients should aim to tidy up this state appropriately once they recover. Service Implementers MAY consider adding more active management of the status of Flows to mitigate Clients failing to tidy up on completion/failure, as part of more general lifecycle management capability, in line with the approach described for retention management. But Clients should not assume such capability.

Filter on Flows on the value of status.

tag.{name}string

A list of tag values, formatted for use in query string parameters

Filter on flows that have a tag named {name} with a value in the given comma-seperated list of values. The {name} and the value MUST be URL encoded where special characters are present. Where the tag's value is a string, at least one of the given values will match. Where the tag's value is an array, at least one value in the array will match at least one of the given values. Partial string matches of the values are not valid.

tag_exists.{name}boolean

Filter on Flows that have a tag named {name} regardless of value. {name} MUST be URL encoded where special characters are present. If set to true then the presence of the tag is filtered for. If set to false then its absence is. If left out then no filtering on tag presence is performed.

frame_widthinteger

Filter on video Flows that have the given frame width.

frame_heightinteger

Filter on video Flows that have the given frame height.

init_segmentsboolean

Filter Flows on the value of init_segments.

collected_by_idsstring

A list of Universally Unique Identifiers (UUIDs) as defined in RFC9562, formatted for use in query string parameters, or an empty string. An empty value selects resources that are not in any collection.

Filter on Flows by the Flow Collection(s) that collect them, given as a comma-separated list of Flow IDs. Returns Flows whose collected_by includes at least one of the given Flow IDs. An empty value (collected_by_ids=) returns only Flows that are not collected by any Flow, i.e. top-level Flows with no collected_by value.

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

Changes