Ressourcentyp „workbook“

Artikel
06/24/2023

Namespace: microsoft.graph

Das Objekt auf oberster Ebene, das dazugehörige Arbeitsmappenobjekte, z. B. Arbeitsblätter, Tabellen, Bereiche usw., enthält.

Methoden

Methode	Rückgabetyp	Beschreibung
Create	workbookSessionInfo	Erstellen Sie eine Arbeitsmappensitzung, um eine dauerhafte oder nicht-beständige Sitzung zu starten.
Sitzung schließen	Keine	Schließen Sie eine vorhandene Sitzung.
Sitzung aktualisieren	Keine	Aktualisieren Sie eine vorhandene Sitzung.

Eigenschaften

Keine.

Beziehungen

Beziehung	Typ	Beschreibung
Kommentare	workbookComment-Auflistung	Stellt eine Auflistung von Kommentaren in einer Arbeitsmappe dar.
names	workbookNamedItem-Auflistung	Stellt eine Auflistung von arbeitsmappenbezogenen benannten Elementen (benannte Bereiche und Konstanten) dar. Schreibgeschützt.
operations	workbookOperation-Auflistung	Der Status von Arbeitsmappenoperationen. Das Abrufen einer „operations“-Auflistung wird nicht unterstützt, Sie können aber den Status von lange dauernden Vorgängen abrufen, wenn der `Location`-Header in der Antwort zurückgegeben wird. Schreibgeschützt.
Tabellen	workbookTable-Auflistung	Stellt eine Auflistung der mit der Arbeitsmappe verknüpften Tabellen dar. Schreibgeschützt.
worksheets	workbookWorksheet-Auflistung	Stellt eine Auflistung der mit der Arbeitsmappe verknüpften Arbeitsblätter dar. Schreibgeschützt.

Funktionen

Excel-Funktionen: Sie können eine Arbeitsmappenfunktion mit der Syntax POST /me/drive/root/workbook/functions/{function-name} aufrufen. Geben Sie dabei die Funktionsargumente in Form eines JSON-Objekts im Text an. Der berechnete value der Funktion sowie alle Zeichenfolgen des Typs error werden im Funktionsergebnisobjekt zurückgegeben. Wird für den Wert errornull zurückgegeben, bedeutet das, dass die Funktion erfolgreich ausgeführt wurde.

Eine vollständige Liste der unterstützten Funktionen finden Sie hier. Die Namen der einzelnen Parameter sowie die Datentypen finden Sie in der Funktionssignatur.

Wichtige Hinweise:

Der Eingabebereichsparameter wird über ein Bereichsobjekt definiert, nicht über eine Bereichsadresszeichenfolge.
Der Indexparameter startet die Indexierung bei 1; die in den meisten anderen APIs genutzte Indexierung ab 0 wird nicht verwendet.

Beispiel: SVERWEIS

In einer Excel-Tabelle verwendet die vlookup-Funktion die folgenden Argumente an:

Der Wert, den Sie nachschlagen möchten, auch das Nachschlagewert bezeichnet.
Der Bereich, in dem sich der Nachschlagewert befindet. Denken Sie daran, dass sich der Nachschlagewert immer in der ersten Spalte des Bereichs für SVERWEIS befinden muss, um ordnungsgemäß zu funktionieren. Wenn sich der Nachschlagewert beispielsweise in Zelle C2 befindet, sollte der Bereich mit C beginnen.
Die Spaltennummer im Bereich, die den Rückgabewert enthält. Wenn Sie z. B. B2: D11 als Bereich angeben, sollten Sie B als erste Spalte, C als zweite Spalte usw. zählen.
Optional können Sie TRUE angeben, wenn Sie eine ungefähre Übereinstimmung wünschen, oder FALSE, wenn Sie eine genaue Übereinstimmung des Rückgabewerts möchten. Wenn Sie nichts angeben, ist der Standardwert immer TRUE oder eine ungefähre Übereinstimmung.

Innerhalb einer Zelle sieht die vlookup-Funktion folgendermaßen aus:

= SVERWEIS (Nachschlagewert, Bereich mit dem Nachschlagewert, Spaltennummer im Bereich mit dem Rückgabewert, geben Sie optional TRUE für eine ungefähre Übereinstimmung oder FALSE für eine genaue Übereinstimmung an)

(Sehen Sie sich die Dokumentation für die SVERWEIS-Excel-Funktion an.)

Im folgenden Beispiel sehen Sie, wie Sie die vlookup-Funktion aufrufen und diese Parameter mit der Excel-REST-API weitergeben.

Anforderung:

POST https://graph.microsoft.com/beta/me/drive/root:/book1.xlsx:/workbook/functions/vlookup
content-type: Application/Json 
authorization: Bearer {access-token} 
workbook-session-id: {session-id}

{
    "lookupValue": "Temperature",
    "tableArray": { "Address": "Sheet1!E1:G5" },
    "colIndexNum": 2,
    "rangeLookup": false
}

Antwort:

HTTP code: 200 OK
content-type: application/json;odata.metadata 

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#workbookFunctionResult",
    "@odata.type": "#microsoft.graph.workbookFunctionResult",
    "@odata.id": "/users('f6d92604-4b76-4b70-9a4c-93dfbcc054d5')/drive/root/workbook/functions/vlookup()",
    "error": null,
    "value": "28.3"
}

Beispiel: median

In einer Excel-Tabelle verwendet die median-Funktion ein Array eines oder mehrerer Eingabebereiche.

Innerhalb einer Zelle sieht die median-Funktion folgendermaßen aus:

=MEDIAN(A2:A6)

(Sehen Sie sich die Dokumentation für die MEDIAN-Excel-Funktion an.)

Im folgenden Beispiel sehen Sie, wie Sie die median-Funktion und einen oder mehrere Eingabebereiche mit der Excel-REST-API aufrufen.

Anforderung:

POST https://graph.microsoft.com/beta/me/drive/root:/book1.xlsx:/workbook/functions/median
content-type: Application/Json 
authorization: Bearer {access-token} 
workbook-session-id: {session-id}

{
   "values":[
      {
         "address":"Sheet2!A1:A5"
      },
      {
         "address":"Sheet2!B1:B5"
      }
   ]
}

Antwort:

HTTP code: 200 OK
content-type: application/json;odata.metadata 

{
  "@odata.context": "https://graph.microsoft.com/beta/$metadata#workbookFunctionResult",
  "@odata.type": "#microsoft.graph.workbookFunctionResult",
  "@odata.id": "/users('2abcad6a-2fca-4b6e-9577-e358a757d77d')/drive/root/workbook/functions/median()",
  "error": null,
  "value": 30
}

JSON-Darstellung

{
  "names": [{"@odata.type": "microsoft.graph.workbookNamedItem"}],
  "tables": [{"@odata.type": "microsoft.graph.workbookTable"}],
  "worksheets": [{"@odata.type": "microsoft.graph.workbookWorksheet"}]
}

Teilen über