Sitzung erstellenCreate Session

Namespace: Microsoft. GraphNamespace: microsoft.graph

Verwenden Sie diese API zum Erstellen einer neuen Arbeitsmappensitzung.Use this API to create a new workbook session.

Excel-APIs können in einem der beiden folgenden Modi aufgerufen werden:Excel APIs can be called in one of two modes:

  1. Beständige Sitzung: Alle an der Arbeitsmappe vorgenommenen Änderungen werden gespeichert. Dies ist die übliche Vorgehensweise.Persistent session - All changes made to the workbook are persisted (saved). This is the usual mode of operation.
  2. Nicht beständige Sitzung: Die von der API vorgenommenen Ä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.Non-persistent session - Changes made by the API are not saved to the source location. Instead, the Excel backend server keeps a temporary copy of the file that reflects the changes made during that particular API session. When the Excel session expires, the changes are lost. This mode is useful for apps that need to do analysis or obtain the results of a calculation or a chart image, but not affect the document state.

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

Hinweis: Der Sitzungsheader ist für das Funktionieren einer Excel-API nicht erforderlich. 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.Note: The session header is not required for an Excel API to work. However, we recommend that you use the session header to improve performance. If you don't use a session header, changes made during the API call are persisted to the file.

FehlerbehandlungError Handling

Bei dieser Anforderung tritt gelegentlich der 504 HTTP-Fehler auf.This request might occasionally receive a 504 HTTP error. Sollte dieser Fehler auftreten, wiederholen Sie die Anforderung.The appropriate response to this error is to repeat the request.

BerechtigungenPermissions

Eine der nachfolgenden Berechtigungen ist erforderlich, um diese API aufrufen zu können. Weitere Informationen, unter anderem zur Auswahl von Berechtigungen, finden Sie im Artikel zum Thema Berechtigungen.One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

BerechtigungstypPermission type Berechtigungen (von der Berechtigung mit den wenigsten Rechten zu der mit den meisten Rechten)Permissions (from least to most privileged)
Delegiert (Geschäfts-, Schul- oder Unikonto)Delegated (work or school account) Files.ReadWriteFiles.ReadWrite
Delegiert (persönliches Microsoft-Konto)Delegated (personal Microsoft account) Nicht unterstütztNot supported.
AnwendungApplication Nicht unterstütztNot supported.

HTTP-AnforderungHTTP request

POST /workbook/createSession

AnforderungsheaderRequest headers

NameName BeschreibungDescription
AuthorizationAuthorization Bearer {token}. Erforderlich.Bearer {token}. Required.

AnforderungstextRequest body

Geben Sie im Anforderungstext eine JSON-Darstellung des WorkbookSessionInfo-Objekts an.In the request body, supply a JSON representation of WorkbookSessionInfo object.

AntwortResponse

Wenn die Methode erfolgreich verläuft, werden der Antwortcode 201 Created und ein WorkbookSessionInfo-Objekt im Antworttext zurückgegeben.If successful, this method returns 201 Created response code and WorkbookSessionInfo object in the response body.

BeispielExample

AnforderungRequest

Nachfolgend sehen Sie ein Beispiel der Anforderung.Here is an example of the request.

POST https://graph.microsoft.com/v1.0/me/drive/items/{id}/workbook/createSession
Content-type: application/json
Content-length: 52

{
  "persistChanges": true
}

Geben Sie im Anforderungstext eine JSON-Darstellung des WorkbookSessionInfo-Objekts an.In the request body, supply a JSON representation of WorkbookSessionInfo object.

AntwortResponse

Nachfolgend sehen Sie ein Beispiel der Antwort. Hinweis: Das hier gezeigte Antwortobjekt ist möglicherweise aus Platzgründen abgeschnitten. Von einem tatsächlichen Aufruf werden alle Eigenschaften zurückgegeben.Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call.

HTTP/1.1 201 Created
Content-type: application/json
Content-length: 52

{
  "id": "id-value",
  "persistChanges": true
}