Sign in
Sources

List Sources

List the Sources registered in the store and their details.

get/sources

Query parameters

labelstring

Filter on Sources that have the given label.

tag.{name}string

Filter on Sources that have a tag named {name} and with the given value. The {name} could contain escaped characters to allow it to be used in a URL.

tag_exists.{name}boolean

Filter on Sources that have a tag named {name} regardless of value. The {name} could contain escaped characters to allow it to be used in a URL. 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-nmos:format:audio' | 'urn:x-nmos:format:data' | 'urn:x-nmos:format:multi'

Identifies the content format for a flow or source using a URN string.

Filter on source format.

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. Implementations should ensure a consistent sort order is applied to pages of results.

limitinteger

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

Response

idstring required

Source identifier

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

The primary content type URN for the Source.

labelstring

Freeform string label for the Source

descriptionstring

Freeform text describing the Source

created_bystring

A string identifier for the entity that created the Source. Implementations SHOULD set suitable default values for created_by based on the principal accessing the system, and MAY permit clients to edit the value, subject to suitable permissions-based limitations.

updated_bystring

A string identifier for the entity that updated the Source metadata most recently. Implementations SHOULD set suitable default values for updated_by based on the principal accessing the system, and MAY permit clients to edit the value, subject to suitable permissions-based limitations.

createdstring date-time

The date-time the Source was created in a given context, e.g. in the store. 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 store. Implementations SHOULD ignore this if given in a PUT request, and instead manage it internally

tagsTags

Key value is a freeform string.

collected_bystring[]

Sources that reference this Source to include it in a collection. This attribute is intended to be read-only. 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