Verwalten von Sitzungen und Persistenz in Excel

  • Artikel

Wenn Ihre Anwendung mehr als einen oder zwei Aufrufe an die Excel-API in Microsoft Graph ausführen muss, erstellen Sie eine Sitzung, und übergeben Sie die Sitzungs-ID bei jeder Anforderung. Das Vorhandensein einer Sitzungs-ID in den Anforderungen stellt sicher, dass Sie die Excel-API auf die effizienteste Weise verwenden.

Excel-APIs können in einem der drei folgenden Modi aufgerufen werden:

  • Persistente Sitzung: Alle an der Arbeitsmappe vorgenommenen Änderungen werden in der Arbeitsmappe beibehalten (gespeichert). Dies ist die effizienteste und leistungsfähigste Möglichkeit zur Verwendung der Excel-API.

  • Nicht persistente Sitzung: Von der API vorgenommene Änderungen werden nicht am Quellspeicherort gespeichert. Stattdessen behält der Excel-Back-End-Server eine temporäre Kopie der Datei bei, welche die während dieser API-Sitzung vorgenommenen Änderungen enthält. Wenn die Excel-Sitzung abläuft, gehen die Änderungen verloren. Dieser Modus eignet sich für Apps, die Analysen durchführen oder die Ergebnisse einer Berechnung oder eines Diagrammbilds abrufen, aber nicht den Dokumentstatus betreffen.

  • Sitzungslos: Die API-Aufrufe übergeben keine Sitzungs-ID. Die Excel-Server müssen die Kopie der Arbeitsmappe des Servers für jeden Vorgang suchen. Dies ist keine effiziente Methode zum Aufrufen der Excel-API. Sie eignet sich jedoch für bestimmte Arten von isolierten Anforderungen.

Um die Sitzung in der API darzustellen, verwenden Sie den workbook-session-id: {session-id}-Header.

Hinweis

Der Sitzungsheader ist nicht erforderlich, damit eine Excel-API funktioniert. Die Verwendung des Sitzungsheaders wird jedoch empfohlen, um die Leistung zu verbessern. Wenn Sie keinen Sitzungsheader verwenden, werden die während des API-Aufrufs vorgenommenen Änderungen in der Datei gespeichert.

Anforderungstypen

Die vorgeschlagene Fehlerbehandlung für Excel-APIs basiert auf Anforderungstyp, Fehlercode und status Code. Im Folgenden sind die Anforderungstypen aufgeführt:

  • CreateSession-Anforderung: Wird verwendet, um entweder eine persistente oder eine nicht persistente Sitzung zu erstellen. Bei einer erfolgreichen Antwort wird die Sitzungs-ID in der Id-Eigenschaft im Antworttext zurückgegeben. Weitere Informationen finden Sie unter Erstellen einer Sitzung.
  • Sitzungsbehaftete Anforderung: Nachfolgende Anforderungen, die einer CreateSession-Anforderung folgen. Sie enthalten in der Regel einen workbook-session-id: {session-id} Header. Die Ausnahme ist eine Abfrage status Anforderung, die das Zeitintensive Vorgangsmuster verwendet. Weitere Informationen finden Sie unter Arbeiten mit APIs, deren Abschluss sehr lange dauert.
  • Sitzungslose Anforderung: Wird im Sitzungslosen Modus verwendet. Diese Anforderungen verfügen nicht über einen workbook-session-id: {session-id} Header.

Nächste Schritte

Informationen zum Erstellen und Verwenden von Sitzungen finden Sie unter Erstellen von Sitzungsreferenzen.

Verwandte Inhalte