Kapitel 14 GET POST

updateRecordings – Metadaten aktualisieren

Der Endpunkt updateRecordings ermöglicht es Ihnen, Metadaten zu einer oder mehreren bestehenden Aufzeichnungen hinzuzufügen, zu ändern oder zu entfernen. Dies ist nützlich, um Aufzeichnungen nach dem Ende eines Meetings zu kennzeichnen — zum Beispiel durch Hinzufügen eines Präsentatornamens, einer Kategorie oder einer Kurskennung — ohne die Aufzeichnung selbst erneut zu verarbeiten.

Endpunkt

GET/POST https://api-guide.bbbserver.com/bigbluebutton/api/updateRecordings?<parameter>&checksum=replace-with-checksum

Sowohl die Methoden GET als auch POST werden unterstützt. Bei Verwendung von POST senden Sie die Parameter als application/x-www-form-urlencoded im Request-Body.

Erforderliche Parameter

Parameter Typ Beschreibung
recordID String Erforderlich. Eine durch Kommas getrennte Liste von Aufzeichnungs-IDs, deren Metadaten aktualisiert werden sollen. Sie können mehrere Aufzeichnungen in einem einzelnen Aufruf aktualisieren, indem Sie die IDs durch Kommas trennen.

Optionale Parameter

Parameter Typ Beschreibung
meta_<key> String Ein oder mehrere Metadaten-Schlüssel-Wert-Paare. Ein nicht-leerer Wert setzt oder aktualisiert den Metadateneintrag. Ein leerer Wert entfernt den Metadateneintrag vollständig. Der Schlüsselname folgt demselben Format wie im Aufruf create.

So funktionieren Metadaten-Aktualisierungen

Übergeben Sie einen oder mehrere meta_<key>-Parameter mit einem nicht-leeren Wert, um den entsprechenden Metadateneintrag zu setzen oder zu aktualisieren.

Übergeben Sie einen meta_<key>-Parameter mit einem leeren Wert, um diesen Metadateneintrag zu entfernen.

Alle vorhandenen Metadateneinträge, die nicht im Aufruf enthalten sind, bleiben unverändert.

Beispielanfrage

Metadaten setzen

GET https://api-guide.bbbserver.com/bigbluebutton/api/updateRecordings
    ?recordID=replace-with-recording-id
  &meta_Presenter=Max+Mustermann
  &meta_category=FINANCE
    &checksum=replace-with-checksum

Metadaten entfernen

GET https://api-guide.bbbserver.com/bigbluebutton/api/updateRecordings
    ?recordID=replace-with-recording-id
  &meta_category=
    &checksum=replace-with-checksum

POST-Anfrage mit cURL

curl --request POST \
    --url "https://api-guide.bbbserver.com/bigbluebutton/api/updateRecordings" \
  --header "Content-Type: application/x-www-form-urlencoded" \
    --data "recordID=replace-with-recording-id&meta_Presenter=Max+Mustermann&meta_category=FINANCE&checksum=replace-with-checksum"

Beispielantwort

Erfolg

<response>
  <returncode>SUCCESS</returncode>
  <updated>true</updated>
</response>

Fehler — Fehlende recordID

<response>
  <returncode>FAILED</returncode>
  <messageKey>missingParamRecordID</messageKey>
  <message>You must specify a recordID.</message>
</response>

Fehler — Aufzeichnung nicht gefunden

<response>
  <returncode>FAILED</returncode>
  <messageKey>notFound</messageKey>
  <message>We could not find a recording with that recordID.</message>
</response>

Fehlerantworten

Nachrichtenschlüssel Beschreibung
checksumError Die checksum ist ungültig oder entspricht nicht dem erwarteten Wert.
missingParamRecordID Der erforderliche Parameter recordID wurde nicht angegeben.
notFound Es wurde keine Aufzeichnung mit der angegebenen ID gefunden. Der Server durchsucht nur published- und unpublished-Aufzeichnungen — gelöschte Aufzeichnungen können nicht aktualisiert werden.

bbbserver.de Hinweise

bbbserver.de: Der Endpunkt updateRecordings ist auf nicht verfügbarbbbserver.de. Metadaten müssen während des Aufrufs create mit meta_-Parametern gesetzt werden und können nach der Erstellung des Meetings nicht mehr geändert werden.

Tipps

Kombinieren Sie updateRecordings mit dem Endpunkt getRecordings, um ein durchsuchbares Aufzeichnungsarchiv zu erstellen. Fügen Sie Metadaten wie den Namen des Präsentierenden, die Abteilung oder das Semester hinzu und verwenden Sie dann den Filter meta_ in getRecordings, um Aufzeichnungen anhand dieser Felder abzurufen.

  • Sie können mehrere Aufzeichnungen gleichzeitig aktualisieren, indem Sie eine kommagetrennte Liste von IDs an den Parameter recordID übergeben.
  • Vorhandene Metadateneinträge, die im Aufruf nicht erwähnt werden, bleiben unverändert — Sie müssen nicht jedes Mal alle Metadaten erneut senden.
  • Um einen bestimmten Metadateneintrag zu entfernen, übergeben Sie den Schlüssel mit einem leeren Wert. Dies ist die einzige Möglichkeit, einzelne Metadatenfelder zu löschen.
  • Das Format des Metadatenschlüssels ist identisch mit dem im Aufruf create verwendeten: meta_yourKeyName=yourValue.

Häufig gestellte Fragen

Ja. Übergeben Sie eine kommagetrennte Liste von Aufzeichnungs-IDs an den Parameter recordID. Dieselben Metadatenänderungen werden in einem einzigen Aufruf auf alle angegebenen Aufzeichnungen angewendet.

Sie bleiben unverändert. Der Endpunkt updateRecordings ändert nur die Metadateneinträge, die Sie ausdrücklich in der Anfrage angeben. Alle anderen bestehenden Metadaten bleiben erhalten.

Übergeben Sie den Metadatenschlüssel mit einem leeren Wert. Zum Beispiel entfernt meta_category= (ohne Wert nach dem Gleichheitszeichen) den Metadateneintrag category aus der Aufzeichnung.

Nein. Der Server sucht nur nach Aufzeichnungen in den Zuständen published und unpublished. Gelöschte Aufzeichnungen können nicht gefunden oder aktualisiert werden. Sie erhalten einen Fehler notFound, wenn die Aufzeichnung gelöscht wurde.

Nein. Der Endpunkt updateRecordings ist auf bbbserver.de nicht implementiert. Auf dieser Plattform müssen Metadaten während des anfänglichen Aufrufs create gesetzt werden und können danach nicht mehr geändert werden.