Erste Schritte mit Adobe Connect Web Services

Lernen Sie die Hauptkonzepte und die Grundlagen für die ersten Schritte in Adobe Connect Web Services APIs kennen.

Für den Einstieg in Adobe Connect Web Services müssen Sie sich mit drei Hauptkonzepten vertraut machen:

  • Prinzipale, also Benutzer und Gruppen

  • SCOs, also Shareable Content Objects für Meetings, Kurse und unzählige weitere Inhalte, die auf Adobe Connect erstellt werden können. SCOs (ausgesprochen Sko, der sich mit schneien) sind mit der branchenüblichen SCORM-Spezifikation (Shareable Content Object Reference Model) kompatibel und können mit einem Learning Management System (LMS) verwendet werden.

  • Berechtigungen, also die Aktionen, die die Prinzipale für Objekte ausführen können

In diesem Kapitel werden die grundlegenden Aufgaben beschrieben, die Sie mit Web Services erledigen können, unabhängig von den Adobe Connect-Anwendungen, für die Sie eine Lizenz besitzen. Bei vielen Aufgaben wird erläutert, wie Sie sie in einem Browser ausführen. Wenn Sie den Aufruf von einer Anwendung aus vornehmen möchten, übersetzen Sie die XML-Anforderung in Ihre Arbeitssprache (ein Beispiel für Java™ finden Sie unter Senden von XML-Anforderungen).

Eine principal-id suchen

Ein Prinzipal ist ein Benutzer oder eine Gruppe mit einer definierten Berechtigung für die Interaktion mit einem SCO auf dem Server. Sie können Benutzer und Gruppen für Ihre Organisation erstellen und deren Berechtigungen ändern.

Adobe Connect bietet auch integrierte Gruppen: Administratoren, begrenzte Administratoren, Autoren, Schulungsverwalter, Veranstaltungsverwalter, Teilnehmer, Meetingveranstalter und Seminarveranstalter. Sie können integrierten Gruppen Benutzer und Gruppen hinzufügen, aber die Berechtigungen integrierter Gruppen nicht ändern.

Hinweis:

Welche integrierten Gruppen verfügbar sind, hängt von Ihrem Konto ab.

Jeder Adobe Connect-Benutzer und jede Gruppe verfügt über eine principal-id. In einigen API-Aufrufen wird das Attribut principal-id als group-id oder user-id bezeichnet, damit es von anderen Werten unterschieden werden kann. Der Wert der ID eines Benutzers oder einer Gruppe ist immer gleich, unabhängig vom Namen.

Die principal-id eines Benutzers oder einer Gruppe abrufen

  1. Rufen Sie principal-list mit einem Filter auf:

     https://example.com/api/xml?action=principal-list&filter-name=jazz doe

    Geben Sie nach Möglichkeit filter-name, filter-login oder filter-email an, sodass genau übereinstimmende Einträge zurückgegeben werden. Die Option filter-like-name kann die Serverleistung beeinträchtigen und sollte nach Möglichkeit nicht verwendet werden.

  2. Analysieren Sie die principal-Elemente in der Antwort auf die principal-id:

     <principal principal-id=&quot;2006282569&quot; account-id=&quot;624520&quot; type=&quot;user&quot; 
             has-children=&quot;false&quot; is-primary=&quot;false&quot; is-hidden=&quot;false&quot;> 
         <name>jazz doe</name>  
         <login>jazzdoe@example.com</login>  
         <email>jazzdoe@newcompany.com</email>  
     </principal>

Die principal-id des aktuellen Benutzers abrufen

  1. Rufen Sie common-info auf, nachdem der Benutzer sich angemeldet hat:

     https://example.com/api/xml?action=common-info
  2. Analysieren Sie Benutzerelemente in der Antwort auf die user-id:

     <user user-id=&quot;2007124930&quot; type=&quot;user&quot;> 
             <name>jazz doe</name>  
             <login>jazz@doe.com</login>  
     </user>

    Hier wird principal-id als user-id bezeichnet, weil sie immer für einen Benutzer steht, der bei Adobe Connect authentifiziert ist. Eine Gruppe kann sich nicht beim Server anmelden. Sie können den Wert für user-id als principal-id in anderen Aktionen übergeben.

Prinzipale oder Gäste auflisten

Ein Prinzipal mit dem Wert user für type ist ein registrierter Adobe Connect-Benutzer, ein Benutzer mit dem Wert guest für type hat dagegen einen Meetingraum als Gast betreten. Der Server erfasst Informationen zum Gast und weist dem Gast eine principal-id zu.

Alle Prinzipale auf dem Server auflisten

  1. Rufen Sie principal-list ohne Parameter auf:

     https://example.com/api/xml?action=principal-list

    Dieser Aufruf gibt alle Adobe Connect-Benutzer zurück. Sie müssen also mit einer umfangreichen Antwort rechnen.

  2. Analysieren Sie die principal-Elemente in der Antwort auf die gewünschten Werte:

     <principal principal-id=&quot;2006282569&quot; account-id=&quot;624520&quot; type=&quot;user&quot; 
             has-children=&quot;false&quot; is-primary=&quot;false&quot; is-hidden=&quot;false&quot;> 
         <name>jazz doe</name>  
         <login>jazzdoe@example.com</login>  
         <email>jazzdoe@newcompany.com</email>  
     </principal>

Alle Gäste auf dem Server auflisten

  1. Rufen Sie report-bulk-users auf und filtern Sie nach dem Typ „guest“:

     https://example.com/api/xml?action=report-bulk-users&filter-type=guest
  2. Analysieren Sie die row-Elemente in der Antwort:

     <row principal-id=&quot;51157227&quot;> 
         <login>joy@acme.com</login>  
         <name>joy@acme.com</name>  
         <email>joy@acme.com</email>  
         <type>guest</type>  
     </row>

Alle Benutzer auflisten, die einem bestimmten Verwalter unterstellt sind

Wenn Sie principal-info mit einer principal-id aufrufen, zeigt die Antwort den Prinzipal. Wenn der Prinzipal als Benutzer fungiert, dem ein Verwalter in Adobe Connect zugewiesen ist, zeigt die Antwort auch Daten zum Verwalter des Prinzipals in einem manager-Element:

 <manager account-id=&quot;624520&quot; disabled=&quot;&quot; has-children=&quot;false&quot; is-hidden=&quot;false&quot; is-primary=&quot;false&quot; principal-id=&quot;2006282569&quot;        type=&quot;user&quot;> 
     <ext-login>jazzdoe@example.com</ext-login>  
     <login>jazzdoe@example.com</login>  
     <name>jazz doe</name>  
     <email>joy@example.com</email>  
     <first-name>jazz</first-name>  
     <last-name>doe</last-name>  
     <x-2006293620>23456</x-2006293620>  
     <x-2007017651>chicago</x-2007017651>  
 </manager>

Sie können die principal-id des Verwalters in principal-list angeben und damit alle Benutzer abrufen, die dem Verwalter zugewiesen sind.

  1. Rufen Sie die principal-list auf und filtern Sie nach der manager-id:

     https://example.com/api/xml?action=principal-list    &filter-manager-id=2006282569
  2. Analysieren Sie die Antwort auf die principal-Elemente:

     <principal principal-id=&quot;2006258745&quot; account-id=&quot;624520&quot; type=&quot;user&quot; has-children=&quot;false&quot; is-primary=&quot;false&quot; is-hidden=&quot;false&quot; manager-id=&quot;2006282569&quot;> 
         <name>Pat Lee</name>  
         <login>plee@mycompany.com</login>  
         <email>plee@mycompany.com</email>  
     </principal>

Erstellen von Benutzern

Zum Erstellen eines neuen Benutzers benötigen Sie Administratorrechte. Adobe empfiehlt, einen Benutzer zu erstellen, der zur admins-Gruppe für Ihre Anwendung gehört, und mit diesem Benutzer die API-Aufrufe auszuführen, für die Administratorrechte erforderlich sind.

Einen neuen Benutzer erstellen und eine Begrüßungs-E-Mail senden

  1. Melden Sie sich in Ihrer Anwendung als Administratorbenutzer an.

    Unter Anmelden über eine Anwendung finden Sie verschiedene Verfahren zur Anmeldung.

  2. Rufen Sie principal-update mit mindestens den folgenden Parametern auf:

     https://example.com/api/xml?action=principal-update 
             &first-name=jazz&last-name=doe&login=jazz99@doe.com&password=hello 
             &type=user&send-email=true&has-children=0&email=jazz99@doe.com

    Der Wert für type muss user lauten, has-children muss gleich 0 oder false sein, send-email muss true sein und email muss eine gültige E-Mail-Adresse enthalten.

    Der Server sendet eine Begrüßungs-E-Mail mit Anmeldedaten an die E-Mail-Adresse des Benutzers.

  3. Analysieren Sie das principal-Element in der Antwort auf die principal-id des Benutzers:

     <principal type=&quot;user&quot; principal-id=&quot;2007184341&quot; has-children=&quot;0&quot; 
             account-id=&quot;624520&quot;> 
         <login>jammdoe@example.com</login>  
         <ext-login>jammdoe@example.com</ext-login>  
         <name>jamm doe</name>  
     </principal>

Einen neuen Benutzer ohne Angabe einer E-Mail-Adresse als Anmelde-ID erstellen

  1. Navigieren Sie in Adobe Connect Central zu „Administration > Benutzer und Gruppen > Anmelde- und Kennwortrichtlinien bearbeiten“. Unter „E-Mail-Adresse für Anmeldung verwenden“ muss die Option „Nein“ eingestellt sein.

  2. Melden Sie sich in Ihrer Anwendung als Administratorbenutzer an.

  3. Rufen Sie principal-update auf und erstellen Sie den neuen Benutzer. Übergeben Sie dabei sowohl den Parameter login als auch den Parameter email:

     https://example.com/api/xml?action=principal-update&first-name=jazz 
         &last-name=doe&login=jazz&email=jazzdoe@company.com 
         &password=nothing&type=user&has-children=0
  4. Analysieren Sie die Antwort auf die principal-id des neuen Benutzers:

     <principal type=&quot;user&quot; principal-id=&quot;2007184341&quot; has-children=&quot;0&quot; 
                 account-id=&quot;624520&quot;> 
         <login>jazzdoe@example.com</login>  
         <ext-login>jazzdoe@example.com</ext-login>  
         <name>jazz doe</name>  
     </principal>

    In der Antwort hat ext-login standardmäßig denselben Wert wie login, bis sich der Benutzer erfolgreich über die externe Authentifizierung anmeldet (siehe Anmelden über HTTP-Header-Authentifizierung).

Benutzer aktualisieren

Die Informationen der erstellten Benutzer müssen häufig nachträglich aktualisiert werden. Sollen die Standardfelder aktualisiert werden, die Adobe Connect für die Benutzer definiert, rufen Sie principal-update mit der principal-id des Benutzers auf. Die Standardfelder umfassen email, login, first-name und last-name.

Wenn Sie benutzerdefinierte Felder für den Prinzipal definiert haben, aktualisieren Sie diese Felder mit acl-field-update.

Zum Aktualisieren der Benutzer benötigen Sie Administratorrechte. Ihre Anwendung muss sich daher zuerst als Benutzer bei der admins-Gruppe anmelden. Sie können sich nicht als der betreffende Benutzer anmelden und den Benutzer dann das eigene Profil aktualisieren lassen.

Standardbenutzerinformationen aktualisieren

  1. Melden Sie sich als Administratorbenutzer an.

  2. Rufen Sie principal-list mit einem Filter auf und ermitteln Sie die principal-id (siehe Suchen einer principal-id).

  3. Rufen Sie principal-update auf und aktualisieren Sie den Benutzer:

     https://example.com/api/xml?action=principal-update 
         &principal-id=2006282569&email=jazzdoe@newcompany.com
  4. Analysieren Sie die Antwort auf den Statuscode ok.

Benutzerdefinierte Feldwerte für einen Benutzer aktualisieren

  1. Melden Sie sich als Administratorbenutzer an.

  2. Rufen Sie custom-fields auf und ermitteln Sie die field-id des benutzerdefinierten Felds:

     https://example.com/api/xml?action=custom-fields
  3. Rufen Sie die zu aktualisierende principal-id, sco-id oder account-id ab.

    Dieser Wert ist die acl-id, die Sie an acl-field-update übergeben.

  4. Rufen Sie acl-field-update auf und aktualisieren Sie den Wert des benutzerdefinierten Felds:

     https://example.com/api/xml?action=acl-field-update&field-id=x-2007396975&acl-id=2006258745&value=44444

Erstellen von benutzerdefinierten Feldern

Benutzerdefinierte Felder sind zusätzliche Datenfelder, die Sie definieren. Mit custom-field-update können Sie bis zu acht benutzerdefinierte Felder für einen Prinzipal oder ein SCO definieren.

Wenn Sie ein benutzerdefiniertes Feld definiert haben, können Sie dessen Wert standardmäßig entweder in Adobe Connect Central bearbeiten oder custom-field-update aufrufen und den Wert dort festlegen.

Soll der Wert nur über die API aktualisiert werden, rufen Sie custom-field-update mit dem Parameter object-type=object-type-read-only auf.

Ein benutzerdefiniertes Feld definieren und für einen Benutzer festlegen

  1. Erstellen Sie zunächst das Feld mit custom-field-update:

     https://example.com/api/xml?action=custom-field-update 
         &object-type=object-type-principal&permission-id=manage 
         &account-id=624520&name=Location&comments=adobe%20location 
         &field-type=text&is-required=true&is-primary=false&display-seq=9

    Im Feld name wird der Feldname in der Form definiert, wie er in Ihrer Anwendung angezeigt werden soll. Beachten Sie also die richtige Schreibweise und die Groß-/Kleinschreibung. Das benutzerdefinierte Feld in diesem Beispiel ist für alle Adobe Connect-Prinzipale definiert.

  2. Analysieren Sie das field-Element in der Antwort auf die field-id:

     <field field-id=&quot;2007184366&quot; object-type=&quot;object-type-principal&quot; 
             display-seq=&quot;9&quot; account-id=&quot;624520&quot; is-primary=&quot;false&quot;  
             permission-id=&quot;manage&quot; is-required=&quot;true&quot; field-type=&quot;text&quot;> 
     <comments>test</comments>  
     <name>Country</name>  
     </field>
  3. Rufen Sie die principal-id des Benutzers ab (siehe Suchen der principal-id).

  4. Rufen Sie acl-field-update auf und legen Sie den Wert des Felds fest. Übergeben Sie hierzu eine field-id, die principal-id des Benutzers als acl-id sowie einen Wert:

     https://example.com/api/xml?action=acl-field-update 
         &acl-id=2006258745&field-id=2007017474&value=San%20Francisco
  5. Analysieren Sie die Antwort auf den Statuscode ok.

Gruppen erstellen

Zum Hinzufügen von Benutzern zu Gruppen müssen Sie principal-update als Administratorbenutzer Ihrer Anwendung aufrufen.

Einen Benutzer zu einer Gruppe hinzufügen

  1. Melden Sie sich als Administratorbenutzer Ihrer Anwendung an.

  2. (Optional) Wenn der Benutzer noch nicht vorhanden ist, erstellen Sie den Benutzer mit principal-update.

     https://example.com/api/xml?action=principal-update 
         &first-name=jazzwayjazz&last-name=doe&login=jazz@doe.com 
         &password=nothing&type=user&has-children=0
  3. (Optional) Analysieren Sie die Antwort auf die principal-id.

  4. Wenn der Benutzer bereits vorhanden ist, rufen Sie principal-list auf und ermitteln Sie die principal-id des Benutzers:

     https://example.com/api/xml?action=principal-list&filter-type=user
  5. Analysieren Sie die Antwort auf die principal-id:

     <principal principal-id=&quot;5611980&quot; account-id=&quot;624520&quot; type=&quot;user&quot;  
             has-children=&quot;false&quot; is-primary=&quot;false&quot; is-hidden=&quot;false&quot;> 
         <name>Joy Black</name>  
         <login>joy@acme.com</login>  
         <email>joy@acme.com</email>  
     </principal>
  6. Rufen Sie principal-list erneut auf und ermitteln Sie die principal-id der Gruppe:

     https://example.com/api/xml?action=principal-list&filter-type=group
  7. Rufen Sie group-membership-update mit is-member=true auf und fügen Sie den Benutzer der Gruppe hinzu:

     https://example.com/api/xml?action=group-membership-update 
         &group-id=4930296&principal-id=2006258745&is-member=true
    • Die principal-id ist die principal-id des Benutzers.

    • Die group-id die principal-id der Gruppe.

    • Der Parameter is-member muss true lauten.

Überprüfen, ob ein bestimmter Benutzer zu einer Gruppe gehört

  1. Rufen Sie principal-list mit einer group-id, mit filter-is-member sowie mit einem Filter auf, der den Prinzipal identifiziert:

     https://example.com/api/xml?action=principal-list&group-id=624523 
             &filter-is-member=true&filter-like-name=bob
  2. Analysieren Sie die Antwort auf ein principal-Element. Eine erfolgreiche Antwort sieht in etwa wie folgt aus:

     <principal-list> 
         <principal principal-id=&quot;624660&quot; account-id=&quot;624520&quot; type=&quot;user&quot;  
                 has-children=&quot;false&quot; is-primary=&quot;false&quot; is-hidden=&quot;false&quot;> 
             <name>Bill Jones</name>  
             <login>bjones@acme.com</login>  
             <email>bjones@acme.com</email>  
             <is-member>true</is-member>  
         </principal> 
     </principal-list>

    Wenn der Benutzer kein Gruppenmitglied ist, ist das Element principal-list leer:

     <?xml version=&quot;1.0&quot; encoding=&quot;utf-8&quot; ?>  
     <results> 
         <status code=&quot;ok&quot; />  
         <principal-list />  
     </results>

Überprüfen, welche Benutzer zu einer Gruppe gehören

  1. Zum Ermitteln der principal-id der Gruppe rufen Sie principal-list mit Filtern auf:

     https://example.com/api/xml?action=principal-list&filter-type=group 
             &filter-name=developers

    Mit filter-type und filter-name sollte principal-list eine eindeutige Übereinstimmung zurückgeben.

  2. Analysieren Sie die Antwort auf die principal-id:

     <principal principal-id=&quot;2007105030&quot; account-id=&quot;624520&quot;  
             type=&quot;group&quot; has-children=&quot;true&quot; is-primary=&quot;false&quot;  
             is-hidden=&quot;false&quot;> 
         <name>developers</name>  
         <login>developers</login>  
         <is-member>false</is-member>  
     </principal>
  3. Rufen Sie principal-list erneut auf, diesmal mit der principal-id als group-id und filter-is-member=true:

     https://example.com/api/xml?action=principal-list&group-id=2007105030 
             &filter-is-member=true
  4. Analysieren Sie die Antwort auf die principal-Elemente:

     <principal principal-id=&quot;5698354&quot; account-id=&quot;624520&quot; type=&quot;group&quot;  
                 has-children=&quot;true&quot; is-primary=&quot;false&quot; is-hidden=&quot;false&quot;> 
         <name>Bob Jones</name>  
         <login>bobjones@acme.com</login>  
         <is-member>true</is-member>  
     </principal>

Alle Gruppen auflisten, zu denen ein Benutzer gehört

  1. Rufen Sie principal-list mit der principal-id und filter-is-member=true auf:

     https://example.com/api/xml?action=principal-list 
         &principal-id=2006258745&filter-is-member=true
  2. Analysieren Sie die Antwort auf die principal-Elemente:

     <principal principal-id=&quot;5698354&quot; account-id=&quot;624520&quot; type=&quot;group&quot;  
                 has-children=&quot;true&quot; is-primary=&quot;false&quot; is-hidden=&quot;false&quot;> 
         <name>Bob Jones</name>  
         <login>bobjones@acme.com</login>  
         <is-member>true</is-member>  
     </principal>

SCOs suchen

Alle Objekte in Adobe Connect sind Shareable Content Objects oder kurz SCOs. Das Wort Shareable stammt aus Lernmanagementsystemen, in denen Inhalte zu Kurse oder Lehrpläne kombiniert und zwischen den Kursen oder Lehrplänen ausgetauscht werden.

Auf dem Server kann ein SCO ein beliebiges Inhaltsobjekt sein, das mit anderen Inhaltsobjekten zu einem Kurs oder Studienplan kombiniert wird. Kurse, Lehrpläne, Präsentationen und andere Inhaltstypen sind SCOs. Meetings, Veranstaltungen, Ordner, Strukturen, Links, Grafikdateien und andere Objekte sind ebenfalls SCOs.

Jedes SCO weist eine eindeutige Ganzzahlkennung auf, eine sogenannte sco-id. Die sco-id ist auf dem gesamten Server eindeutig. Bei einem gehosteten Konto von Adobe Connect ist die sco-id in allen Konten eindeutig.

Jedem SCO ist außerdem ein Typ zugewiesen, z. B. content, course, meeting usw. Die Werte für sco-id und type finden Sie in der Antwort aus sco-info oder anderen Aktionen:

 <sco account-id=&quot;624520&quot; disabled=&quot;&quot; display-seq=&quot;0&quot; folder-id=&quot;2006258747&quot; 
         icon=&quot;producer&quot; lang=&quot;en&quot; max-retries=&quot;&quot; sco-id=&quot;2006334909&quot; 
         source-sco-id=&quot;&quot; type=&quot;content&quot; version=&quot;1&quot;>

Merkmale von SCOs

Wenn Sie die XML-Antworten verschiedener Aufrufe näher betrachten, fallen weitere Merkmale von SCOs ins Auge:

  • Die Kennung einer SCO wird in einigen Aktionen als sco-id bezeichnet, kann in anderen Aktionen aber auch als folder-id, acl-id oder ein anderer Name angegeben sein. Dies ist jeweils dieselbe eindeutige ID.

  • Auf jedes SCO können verschiedene Prinzipale zugreifen, entweder Benutzer oder Gruppen. Die jeweiligen Prinzipale, die auf ein SCO zugreifen können, werden in Zugriffssteuerungslisten oder ACLs definiert.

  • Jedes SCO hat eine eindeutige URL, die sich aus zwei Teilen zusammensetzt: einem Domänennamen (wie http://example.com) und einem URL-Pfad (wie /f2006123456/). Wenn Sie diese Teile verketten, entsteht die vollständige URL für den Zugriff auf das SCO.

  • Für jedes SCO gilt ein Navigationspfad, der die Position des SCO in der Ordnerhierarchie beschreibt.

  • Bei jedem SCO ist eine Berechtigung für jeden Prinzipal definiert, der darauf zugreifen kann.

  • Bestimmte SCOs umfassen Beschreibungsfelder mit Textzeichenfolgen, die Informationen über die SCO enthalten.

Sie müssen häufig die ID eines SCO oder andere Informationen darüber ermitteln. SCOs sind in einer bestimmten Ordnerhierarchie angeordnet. Aus den Namen der Ordner geht hervor, ob sie sich auf der obersten Ebene befinden und ob sie freigegebene oder benutzereigene Inhalte oder Vorlagen.

Wenn Sie sco-shortcuts aufrufen, wird eine Liste mit Ordnern zurückgegeben. Die Ordner weisen unterschiedliche Typen auf:

 <?xml version=&quot;1.0&quot; encoding=&quot;utf-8&quot; ?>  
 <results> 
     <status code=&quot;ok&quot; />  
     <shortcuts> 
         <sco tree-id=&quot;624530&quot; sco-id=&quot;2006258751&quot; type=&quot;my-meeting-templates&quot;> 
             <domain-name>http://example.com</domain-name>  
         </sco> 
         <sco tree-id=&quot;624530&quot; sco-id=&quot;2006258750&quot; type=&quot;my-meetings&quot;> 
             <domain-name>http://example.com</domain-name>  
         </sco> 
         <sco tree-id=&quot;624529&quot; sco-id=&quot;624529&quot; type=&quot;meetings&quot;> 
             <domain-name>http://example.com</domain-name>  
         </sco> 
         <sco tree-id=&quot;624530&quot; sco-id=&quot;624530&quot; type=&quot;user-meetings&quot;> 
             <domain-name>http://example.com</domain-name>  
         </sco> 
         ... 
     </shortcuts> 
 </results>

Die in diesem Beispiel gezeigten Ordner sind für Meetings vorgesehen; die Ordner für andere SCO-Arten sind ähnlich aufgebaut. In jedem Ordnertyp werden bestimmte Objekttypen mit bestimmten Zugriffsrechten gespeichert:

content, courses, meetings, events, seminars

Dies sind freigegebene Ordner, z. B. „Gemeinsame Meetings“, „Gemeinsame Schulung“ usw. Der Adobe Connect-Administrator hat Zugriff auf diesen Ordner. Der Administrator kann jedem Benutzer Verwaltungsberechtigungen zuweisen, aber nur Mitglieder der integrierten Gruppe, die dem Ordner zugeordnet ist, können neue Inhalte oder Meetings in diesem Ordner erstellen.

user-content, user-meetings, user-courses, user-events

Diese Ordner enthalten jeweils einen Ordner für jeden Benutzer, der Inhalte darin erstellen kann (z. B. einen Ordner für jeden Meetingveranstalter oder Schulungsentwickler).

my-courses, my-events, my-meetings, my-meeting-templates, my-content

Benutzer erstellen ihre eigenen Inhalte in diesen Ordnern und besitzen Verwaltungsberechtigungen für den Inhalt. Meetingveranstalter erstellen beispielsweise Meetings in ihrem Ordner my-meetings und besitzen Verwaltungsberechtigungen für diese Meetings.

shared-meeting-templates

Dieser Ordner befindet sich im Ordner „Freigegebene Meetings“, enthält Meetingvorlagen und erbt Berechtigungen von „Freigegebene Meetings“.

Sie können den Inhalt eines beliebigen Ordners auflisten und Informationen zu einem bestimmten SCO ermitteln. Wenn Sie nach einem SCO suchen müssen, aber die sco-id nicht kennen, navigieren Sie mit sco-shortcuts und sco-expanded-contents durch die Ordner. sco-search gibt nur bestimmte SCO-Typen zurück und sollte daher nicht verwendet werden.

Ein SCO suchen, wenn die sco-id bekannt ist

  1. Rufen Sie sco-shortcuts auf und ermitteln Sie eine Liste der Stammordner in Adobe Connect ab:

     https://example.com/api/xml?action=sco-shortcuts
  2. Analysieren Sie die Antwort auf den type des Stammordners, in dem sich das SCO logischerweise befinden würde, z. B. my-courses für einen Kurs, den der Benutzer erstellt hat.

  3. Analysieren Sie das resultierende sco-Element auf eine sco-id:

     <sco tree-id=&quot;4930295&quot; sco-id=&quot;2006258748&quot; type=&quot;my-courses&quot;> 
         <domain-name>http://example.com</domain-name>  
     </sco>
  4. Erstellen Sie einen Aufruf von sco-expanded-contents, mit dem der Inhalt des Ordners aufgelistet wird, und geben Sie nach Möglichkeit einen Filter für die exakte Übereinstimmung an:

     https://example.com/api/xml?action=sco-expanded-contents 
         &sco-id=2006258748&filter-name=All About Web Communities

    Sie haben mehrere Filteroptionen:

    • Filter mit genauer Übereinstimmung für name oder url-path (wie filter-name oder filter-url-path), wenn Sie den Namen oder die URL des SCO kennen.

    • Größer-als- oder Kleiner-als-Datumsfilter (filter-gt-date oder filter-lt-date) für date-begin, date-createdoder date-modified, wenn Sie eine dieser Datumsangaben kennen.

    • Partieller Namensfilter (wie filter-like-name), wenn Sie den genauen SCO-Namen nicht kennen. Dieser Filter kann allerdings die Systemleistung beeinträchtigen.

  5. Analysieren Sie die Antwort auf die sco-id:

     <sco depth=&quot;1&quot; sco-id=&quot;2006745671&quot; folder-id=&quot;2006258748&quot; type=&quot;folder&quot; 
             icon=&quot;folder&quot; lang=&quot;en&quot; source-sco-id=&quot;2006745669&quot; display-seq=&quot;0&quot; 
             source-sco-type=&quot;14&quot;> 
         <name>A Day in the Life Resources</name>  
         <url-path>/f28435879/</url-path>  
         <date-created>2006-06-12T14:47:59.903-07:00</date-created>  
         <date-modified>2006-06-12T14:47:59.903-07:00</date-modified>  
     </sco>

Informationen zu einem SCO abrufen

  1. Rufen Sie sco-info mit der sco-id auf:

     https://example.com/api/xml?action=sco-info&sco-id=2006745669
  2. Analysieren Sie die Antwort auf name, url-path oder einen anderen Wert:

     <sco account-id=&quot;624520&quot; disabled=&quot;&quot; display-seq=&quot;0&quot;  
             folder-id=&quot;2006258748&quot; icon=&quot;curriculum&quot; lang=&quot;en&quot; max-retries=&quot;&quot; 
             sco-id=&quot;2006745669&quot; source-sco-id=&quot;&quot; type=&quot;curriculum&quot; version=&quot;0&quot;> 
         <date-begin>2006-06-12T14:45:00.000-07:00</date-begin>  
         <date-created>2006-06-12T14:47:59.903-07:00</date-created>  
         <date-modified>2006-06-12T14:47:59.903-07:00</date-modified>  
         <name>A Day in the Life</name>  
         <url-path>/day/</url-path>  
     </sco>

URL für ein SCO erstellen

  1. Rufen Sie sco-shortcuts auf:

     https://example.com/api/xml?action=sco-shortcuts
  2. Analysieren Sie die Antwort auf den Wert für domain-name in einem beliebigen sco-Element:

     <sco tree-id=&quot;624530&quot; sco-id=&quot;2006258750&quot; type=&quot;my-meetings&quot;> 
         <domain-name>http://example.com</domain-name>  
     </sco>
  3. Rufen Sie sco-info mit der sco-id auf:

     https://example.com/api/xml?action=sco-info&sco-id=2006334909
  4. Analysieren Sie die Antwort auf den url-path:

     <sco account-id=&quot;624520&quot; disabled=&quot;&quot; display-seq=&quot;0&quot;  
             folder-id=&quot;2006258747&quot; icon=&quot;producer&quot; lang=&quot;en&quot;  
             max-retries=&quot;&quot; sco-id=&quot;2006334909&quot; source-sco-id=&quot;&quot;  
             type=&quot;content&quot; version=&quot;1&quot;> 
         <date-created>2006-05-11T12:00:02.000-07:00</date-created>  
         <date-modified>2006-05-16T15:22:25.703-07:00</date-modified>  
         <name>Test Quiz</name>  
         <url-path>/quiz/</url-path>  
         <passing-score>10</passing-score>  
         <duration>15100.0</duration>  
         <section-count>6</section-count>  
     </sco>

    Dem Wert für url-path ist je ein Schrägstrich voran- und nachgestellt. Sie können den url-path aus report-my-meetings, report-my-trainingoder einem anderen Aufruf, der diesen Wert zurückgibt, übernehmen.

  5. Verketten Sie den url-path mit dem domain-name:

     http://example.com/f2006258748/

Dateien herunterladen

Sie können ZIP-Dateien aus Adobe Connect auf den lokalen Computer eines Benutzers herunterladen. Eine ZIP-Datei ist ein SCO. Zum Herunterladen müssen Sie eine Download-URL für die ZIP-Datei erstellen, die in etwa wie folgt aussieht:

 http://server-domain/url-path/output/url-path.zip?download=zip

Der Domänenname Ihres Servers ist Ihnen in der Regel bekannt (z. B. example.com). Falls nicht, rufen Sie ihn mit sco-shortcuts ab.

Eine ZIP-Datei vom Server herunterladen

  1. Rufen Sie sco-shortcuts auf:

     https://example.com/api/xml?action=sco-shortcuts
  2. Extrahieren Sie alle Werte für domain-name aus der Antwort:

     http://example.com
  3. Rufen Sie sco-info mit der sco-id der ZIP-Datei auf:

     https://example.com/api/xml?action=sco-info&sco-id=2006258747

    Das SCO ist die gesamte ZIP-Datei.

  4. Analysieren Sie die Antwort auf das Element url-path:

     <sco account-id=&quot;624520&quot; disabled=&quot;&quot; display-seq=&quot;0&quot; folder-id=&quot;624522&quot; 
             icon=&quot;folder&quot; lang=&quot;en&quot; max-retries=&quot;&quot; sco-id=&quot;2006258747&quot;  
             source-sco-id=&quot;&quot; type=&quot;folder&quot; version=&quot;1&quot;> 
         <date-created>2006-04-18T10:21:47.020-07:00</date-created>  
         <date-modified>2006-04-18T10:21:47.020-07:00</date-modified>  
         <name>joy@acme.com</name>  
         <url-path>/f124567890/</url-path>  
     </sco>
  5. Erstellen Sie die Download-URL, z. B.:

     https://example.com/quiz/output/quiz.zip?download=zip

    Entfernen Sie in jedem Fall den nachgestellten Schrägstrich aus dem Wert für url-path, bevor Sie .zip anhängen (der entstehende Wert muss beispielsweise /quiz.zip lauten, nicht /quiz/.zip).

Prüfen Sie die Berechtigungen

Berechtigungen definieren, wie ein Prinzipal mit einem SCO interagieren kann.

Eine Berechtigungszuordnung, die die Berechtigungen eines Prinzipals für ein bestimmtes SCO angibt, wird als Zugriffssteuerungsliste oder ACL bezeichnet. Eine ACL umfasst drei Informationen:

  • Die ID eines Prinzipals (eine principal-id).

  • Die ID eines SCO, Kontos oder Prinzipals, für das bzw. den Aktionen ausgeführt werden. In Berechtigungsaufrufen ist dies dieacl-id. In anderen Aufrufen kann die ID als sco-id, account-id oder principal-id bezeichnet werden.

  • Ein Schlüsselwort für die Berechtigungsebene des Prinzipals (einer der gültigen Werte in permission-id).

Berechtigung eines Prinzipals für ein SCO überprüfen

  1. Rufen Sie permissions-info sowohl mit einer acl-id als auch mit einer principal-id auf:

     https://example.com/api/xml?action=permissions-info&acl-id=2006334909 
         &principal-id=2006258745

    Beim Überprüfen der Berechtigungen für ein SCO ist die acl-id eine sco-id. Die acl-id kann auch eine principal-id oder eine account-id sein.

  2. Analysieren Sie die Antwort auf eine permission-id:

     <?xml version=&quot;1.0&quot; encoding=&quot;utf-8&quot; ?>  
     <results> 
         <status code=&quot;ok&quot; />  
         <permission acl-id=&quot;2007035246&quot; permission-id=&quot;view&quot;  
                 principal-id=&quot;2006258745&quot; />  
     </results>

    Wenn ein Prinzipal keine explizite Berechtigung für das SCO besitzt (mit anderen Worten: permission-id=""), gelten die Berechtigungen des Prinzipals für das übergeordnete Objekt des SCO.

Berechtigungen alle Prinzipale für ein SCO überprüfen

  1. Rufen Sie permissions-info mit einer acl-id, aber ohne principal-id auf:

     https://example.com/api/xml?action=permissions-info&acl-id=2006293572
  2. Analysieren Sie die verschiedenen principal-Elemente jeweils auf Werte für permission-id:

     <principal principal-id=&quot;2596608&quot; is-primary=&quot;false&quot; type=&quot;user&quot;  
                     has-children=&quot;false&quot; permission-id=&quot;view&quot;> 
             <name>Jay Arnold</name>  
             <login>jay@example.com</login>  
     </principal>

    Die gültigen Berechtigungswerte werden in permission-id aufgelistet.

 Adobe

Schneller und einfacher Hilfe erhalten

Neuer Benutzer?