Haivision Media Platform
Haivision Media Platform
Breadcrumbs

Edit Source Metadata

Edits the metadata for the source.

Authorizations: Sources - EDIT

Requests 

PUT /apis/sources/:sourceId/metadata
[{
 "name": "calypso:creator",
 "field": [
  {
    "fieldType": "STRING",
    "valueString": "haiadmin7"
  }]
},
{
  "name": "calypso:category:Locations",
  "field": [
   {
     "fieldType": "STRING",
     "valueString": "Montreal"
   }]
}]


Parameters

Property

JSON Type

Property Type

Description

name

String

Optional

Name of metadata

field

Array of objects (fields) for these possible structures:

{ "fieldType": "STRING",
"valueString": "value"}
{ "fieldType": "INT32",
"valueInt32": -14}
{ "fieldType": "UINT32",
"valueUint32": 42}

Optional

Content of metadata. See (4.1) Fields.

Response

Success

{
  "data": [
   {
    "name": "calypso:creator",
    "field": [
     {
      "fieldType": "STRING",
      "valueString": "haiadmin7"
     }]
   },
   {
    "name": "calypso:category:Locations",
    "field": [
     {
      "fieldType": "STRING",
      "valueString": "Montreal"
     }]
   }]
}


Error

Code

Payload

 Description

400

{"code":"010001", "name":"InputValidation",
"message":<Error message>,
"httpStatusCode":400}

Supplied data was insufficient or incorrect.

404

{"code":"040009", "name":"SourceNotFound",
"message":"Source not found",
"httpStatusCode":404}

Source with UUID sourceId not found.