Bölüm 14 GET POST

updateRecordings – Meta Verileri Güncelle

updateRecordings uç noktası, mevcut bir veya daha fazla kaydın meta verilerini eklemenize, değiştirmenize veya kaldırmanıza olanak tanır. Bu, toplantı sona erdikten sonra kayıtları etiketlemek için kullanışlıdır — örneğin, sunum yapan kişinin adını, bir kategoriyi veya bir ders tanımlayıcısını, kaydın kendisini yeniden işlemeye gerek kalmadan eklemek için.

Uç Nokta

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

Hem GET hem de POST yöntemleri desteklenir. POST kullanırken, parametreleri istek gövdesinde application/x-www-form-urlencoded olarak gönderin.

Gerekli Parametreler

Parametre Tür Açıklama
recordID String Gerekli. Meta verisi güncellenmesi gereken kayıt kimliklerinin virgülle ayrılmış listesi. Kimlikleri virgülle ayırarak tek bir çağrıda birden fazla kaydı güncelleyebilirsiniz.

İsteğe Bağlı Parametreler

Parametre Tür Açıklama
meta_<key> String Bir veya daha fazla meta veri anahtar-değer çifti. Boş olmayan bir değer, meta veri girdisini ayarlar veya günceller. Boş bir değer, meta veri girdisini tamamen kaldırır. Anahtar adı, create çağrısında kullanılan biçimle aynıdır.

Meta Veri Güncellemeleri Nasıl Çalışır

İlgili meta veri girdisini ayarlamak veya güncellemek<key> için boş olmayan bir değerle bir veya daha fazla meta_ parametresi geçin.

Bu meta veri girdisini kaldırmak<key> için meta_ parametresini boş bir değerle geçin.

Çağrıya dahil edilmeyen mevcut meta veri girdileri değişmeden kalır.

Örnek İstek

Meta Veri Ayarlama

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

Meta Veri Kaldırma

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

cURL ile POST İsteği

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"

Örnek Yanıt

Başarılı

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

Hata — recordID eksik

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

Hata — Kayıt Bulunamadı

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

Hata Yanıtları

Mesaj Anahtarı Açıklama
checksumError checksum geçersiz veya beklenen değerle eşleşmiyor.
missingParamRecordID Gerekli recordID parametresi sağlanmadı.
notFound Belirtilen kimliğe sahip bir kayıt bulunamadı. Sunucu yalnızca published ve unpublished kayıtları arar — silinmiş kayıtlar güncellenemez.

bbbserver.de Notlar

bbbserver.de: updateRecordings uç noktası üzerinde kullanılamazbbbserver.de. Meta veriler, create çağrısı sırasında meta_ parametreleri kullanılarak ayarlanmalıdır ve toplantı oluşturulduktan sonra değiştirilemez.

İpuçları

Aranabilir bir kayıt arşivi oluşturmak için updateRecordings ile getRecordings uç noktasını birleştirin. Sunucu adı, departman veya dönem gibi meta veriler ekleyin, ardından kayıtları bu alanlara göre getirmek için getRecordings içinde meta_ filtresini kullanın.

  • recordID parametresine virgülle ayrılmış bir kimlik listesi vererek birden fazla kaydı aynı anda güncelleyebilirsiniz.
  • Çağrıda belirtilmeyen mevcut meta veri girişleri olduğu gibi kalır — her seferinde tüm meta verileri yeniden göndermeniz gerekmez.
  • Belirli bir meta veri girişini kaldırmak için anahtarı boş bir değerle gönderin. Tek tek meta veri alanlarını silmenin tek yolu budur.
  • Meta veri anahtar biçimi, create çağrısında kullanılanla aynıdır: meta_yourKeyName=yourValue.

Sıkça Sorulan Sorular

Evet. recordID parametresine virgülle ayrılmış bir kayıt kimliği listesi verin. Aynı meta veri değişiklikleri, tek bir çağrıda belirtilen tüm kayıtlara uygulanır.

Değişmeden kalırlar. updateRecordings uç noktası yalnızca istekte açıkça dahil ettiğiniz meta veri girdilerini değiştirir. Diğer tüm mevcut meta veriler korunur.

Meta veri anahtarını boş bir değerle gönderin. Örneğin, meta_category= (eşittir işaretinden sonra değer olmadan) kayıttan category meta veri girdisini kaldırır.

Hayır. Sunucu yalnızca published ve unpublished durumlarındaki kayıtları arar. Silinmiş kayıtlar bulunamaz veya güncellenemez. Kayıt silinmişse notFound hatası alırsınız.

Hayır. updateRecordings uç noktası bbbserver.de üzerinde uygulanmamıştır. Bu platformda meta veriler, ilk create çağrısı sırasında ayarlanmalıdır ve sonrasında değiştirilemez.