Sign in
Sources

List Sources

List the Sources registered in the TAMS service instance and their details.

get/sources

Query parameters

labelstring

Filter on Sources that have the given label.

reverse_orderboolean

Return Sources in reverse order.

sort_by'created' | 'updated' | 'label'

Parameter to sort Sources by. created and 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.

tag.{name}string

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

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

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 Source format.

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 Sources by the Source Collection(s) that collect them, given as a comma-separated list of Source IDs. Returns Sources whose collected_by includes at least one of the given Source IDs. An empty value (collected_by_ids=) returns only Sources that are not collected by any Source, i.e. top-level Sources 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

idstring required

A Universally Unique Identifier (UUID) as defined in RFC9562

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 required

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

labelstring

Freeform string label for the Source. This should be a very short, human-readable label that may be displayed in listings of Sources.

descriptionstring

Freeform text describing the Source. This should be a human-readable description that may be showed in detailed views of Sources. The description should be longer and more detailed than label.

created_bystring

A string identifier for the entity that created the Source. Service implementations SHOULD set suitable default values for created_by based on the principal accessing the systems.

updated_bystring

A string identifier for the entity that updated the Source metadata most recently. Service implementations SHOULD set suitable default values for updated_by based on the principal accessing the system.

createdstring date-time

The date-time the Source was created in a given context, e.g. in the service instance. Service implementations SHOULD ignore this if given in a PUT request, and instead manage it internally

updatedstring date-time

The date-time the Source metadata was last updated in a given context, e.g. in the service instance. Service implementations SHOULD ignore this if given in a PUT request, and instead manage it internally

tagsTags

Key is a freeform string. Value is a freeform string, or an array of freeform strings.

collected_byUuid[]

Sources that reference this Source to include it in a collection. This attribute is intended to be read-only. Service implementations SHOULD ignore this if given in a PUT request, and instead manage it internally. Source collections can be inferred from Flow collection definitions.

Changes