AWaws-samples
Profiles

Profile Backend Information

Changed on

List of Profiles supported by the store instance for use when creating flows.

get/service/profiles

Request

  • Base URL
    http://localhost:4010
  • URL
    http://localhost:4010/service/profiles
  • Auth
    • HTTP bearer
    • or API key in query parameter access_token
    • or HTTP basic

Query parameters

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

codecstring

A Mime Type without parameters as defined in RFC2045 and RFC7231

Filter on Profile codec.

labelstring

Filter on Profiles that have the given label.

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

labelstring

Freeform string label for the Profile.

descriptionstring

Freeform text describing the Profile.

created_bystring

A string identifier for the entity that created the Profile. 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.

createdstring date-time

The date-time the Profile 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.

tagsTags

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

Changes