AWaws-samples
Sources

Source Details

Changed on

Returns Source metadata.

get/sources/{sourceId}

Request

  • Base URL
    http://localhost:4010
  • URL
    http://localhost:4010/sources/{sourceId}
  • Auth
    • HTTP bearer
    • or API key in query parameter access_token
    • or HTTP basic

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