Kapitel 14 GET POST

updateRecordings – Opdater metadata

updateRecordings-endpointet giver dig mulighed for at tilføje, ændre eller fjerne metadata på en eller flere eksisterende optagelser. Dette er nyttigt til at mærke optagelser efter et møde er afsluttet — for eksempel ved at tilføje et præsentatørnavn, en kategori eller en kursusidentifikator — uden at genbehandle selve optagelsen.

Endepunkt

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

Både GET- og POST-metoder understøttes. Ved brug af POST skal parametre sendes som application/x-www-form-urlencoded i request body.

Obligatoriske parametre

Parameter Type Beskrivelse
recordID String Påkrævet. En kommasepareret liste over optagelses-id'er, hvis metadata skal opdateres. Du kan opdatere flere optagelser i ét kald ved at adskille id'erne med kommaer.

Valgfrie parametre

Parameter Type Beskrivelse
meta_<key> String Et eller flere metadata-nøgle-værdi-par. En ikke-tom værdi sætter eller opdaterer metadata-posten. En tom værdi fjerner metadata-posten helt. Nøglens navn følger samme format som i create-kaldet.

Sådan fungerer metadataopdateringer

Send en eller flere meta_<key>-parametre med en ikke-tom værdi for at angive eller opdatere den tilsvarende metadatapost.

Send en meta_<key>-parameter med en tom værdi for at fjerne den metadatapost.

Eventuelle eksisterende metadataposter, der ikke er med i kaldet, forbliver uændrede.

Eksempel på anmodning

Angivelse af metadata

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

Fjernelse af metadata

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

POST-request med 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"

Eksempelsvar

Succes

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

Fejl — manglende recordID

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

Fejl — Optagelse ikke fundet

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

Fejlsvar

Beskednøgle Beskrivelse
checksumError checksum er ugyldig eller matcher ikke den forventede værdi.
missingParamRecordID Den påkrævede parameter recordID blev ikke angivet.
notFound Der blev ikke fundet nogen optagelse med det angivne ID. Serveren søger kun i published- og unpublished-optagelser — slettede optagelser kan ikke opdateres.

bbbserver.de Bemærkninger

bbbserver.de: updateRecordings-endpointet er ikke tilgængeligt på bbbserver.de. Metadata skal angives under create-kaldet ved hjælp af meta_-parametre og kan ikke ændres efter mødet er oprettet.

Tips

Kombinér updateRecordings med endpointet getRecordings for at opbygge et søgbart optagelsesarkiv. Tilføj metadata som præsentatørens navn, afdeling eller semester, og brug derefter filteret meta_ i getRecordings til at hente optagelser efter disse felter.

  • Du kan opdatere flere optagelser på én gang ved at sende en kommasepareret liste af ID'er til parameteren recordID.
  • Eksisterende metadatafelter, som ikke nævnes i kaldet, forbliver uændrede — du behøver ikke at sende alle metadata igen hver gang.
  • For at fjerne et bestemt metadatafelt skal du sende nøglen med en tom værdi. Dette er den eneste måde at slette individuelle metadatafelter på.
  • Formatet for metadata-nøglen er identisk med det, der bruges i create-kaldet: meta_yourKeyName=yourValue.

Ofte stillede spørgsmål

Ja. Send en kommasepareret liste over optagelses-ID'er til parameteren recordID. De samme metadataændringer bliver anvendt på alle angivne optagelser i ét enkelt kald.

De forbliver uændrede. updateRecordings-endpointet ændrer kun de metadata-poster, du eksplicit inkluderer i requesten. Alle andre eksisterende metadata bevares.

Send metadata-nøglen med en tom værdi. For eksempel vil meta_category= (uden nogen værdi efter lighedstegnet) fjerne metadata-posten category fra optagelsen.

Nej. Serveren søger kun efter optagelser i tilstandene published og unpublished. Slettede optagelser kan ikke findes eller opdateres. Du modtager en notFound-fejl, hvis optagelsen er blevet slettet.

Nej. updateRecordings-endpointet er ikke implementeret på bbbserver.de. På den platform skal metadata angives under det oprindelige create-kald og kan ikke ændres bagefter.