Ressourcentyp „workbook“Workbook resource type

Die Arbeitsmappe ist das Objekt auf oberster Ebene , das dazugehörige Arbeitsmappenobjekte wie z. B. Arbeitsblätter, Tabellen, Bereiche usw. enthält.Workbook is the top level object which contains related workbook objects such as worksheets, tables, ranges, etc.

JSON-DarstellungJSON representation

Es folgt eine JSON-Darstellung der Ressource.Here is a JSON representation of the resource

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

EigenschaftenProperties

KeineNone

MethodenMethods

MethodeMethod RückgabetypReturn Type BeschreibungDescription
Create SessionCreate Session workbookSessionInfoworkbookSessionInfo Erstellen Sie eine Arbeitsmappensitzung, um eine dauerhafte oder nicht-beständige Sitzung zu starten.Create a workbook session to start a persistent or non-persistent session.
Close SessionClose Session KeineNone Schließen Sie eine vorhandene Sitzung.Close an existing session.
Refresh SessionRefresh Session KeineNone Aktualisieren Sie eine vorhandene Sitzung.Refresh an existing session.

BeziehungenRelationships

BeziehungRelationship TypType BeschreibungDescription
namesnames WorkbookNamedItem -AuflistungWorkbookNamedItem collection Stellt eine Auflistung der benannten Elemente des Arbeitsmappenbereichs dar (benannte Bereiche und Konstanten). Schreibgeschützt.Represents a collection of workbook scoped named items (named ranges and constants). Read-only.
Tabellentables WorkbookTable -AuflistungWorkbookTable collection Stellt eine Auflistung der mit der Arbeitsmappe verknüpften Tabellen dar. Schreibgeschützt.Represents a collection of tables associated with the workbook. Read-only.
worksheetsworksheets WorkbookWorksheet -AuflistungWorkbookWorksheet collection Stellt eine Auflistung der mit der Arbeitsmappe verknüpften Arbeitsblätter dar. Schreibgeschützt.Represents a collection of worksheets associated with the workbook. Read-only.

FunktionenFunctions

Excel-Funktionen: Sie können eine Arbeitsmappenfunktion mit der Syntax POST /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 error null zurückgegeben, bedeutet das, dass die Funktion erfolgreich ausgeführt wurde.Excel functions: Invoke a workbook function using the syntax POST /workbook/functions/{function-name} and providing the function argument(s) in the body using a JSON object. The function's resulting value and any error strings are returned in the function result object. The error value of null indicates successful execution of the function.

Eine vollständige Liste der unterstützten Funktionen finden Sie hier. Die Namen der einzelnen Parameter sowie die Datentypen finden Sie in der Funktionssignatur.The complete list of supported functions are listed here. Refer to the function signature for specific parameter names and data types.

Wichtige Hinweise:Important notes:

  • Der Eingabebereichsparameter wird über ein Bereichsobjekt definiert, nicht über eine Bereichsadresszeichenfolge.The range input parameter is supplied using a range object instead of the range address string.
  • Der Indexparameter startet die Indexierung bei 1; die in den meisten anderen APIs genutzte Indexierung ab 0 wird nicht verwendet.The index parameter is 1-indexed unlike the 0-index used in most of the APIs.

Beispiel: SVERWEISExample: vlookup

In einer Excel-Tabelle verwendet die vlookup-Funktion die folgenden Argumente an:In an Excel spreadsheet, the vlookup function takes the following arguments:

  1. Der Wert, den Sie nachschlagen möchten, auch das Nachschlagewert bezeichnet.The value you want to look up, also called the lookup value.
  2. Der Bereich, in dem sich der Nachschlagewert befindet.The range where the lookup value is located. Denken Sie daran, dass sich der Nachschlagewert immer in der ersten Spalte des Bereichs für SVERWEIS befinden muss, um ordnungsgemäß zu funktionieren.Remember that the lookup value should always be in the first column in the range for VLOOKUP to work correctly. Wenn sich der Nachschlagewert beispielsweise in Zelle C2 befindet, sollte der Bereich mit C beginnen.For example, if your lookup value is in cell C2 then your range should start with C.
  3. Die Spaltennummer im Bereich, die den Rückgabewert enthält.The column number in the range that contains the return value. Wenn Sie z. B. B2: D11 als Bereich angeben, sollten Sie B als erste Spalte, C als zweite Spalte usw. zählen.For example, if you specify B2: D11 as the range, you should count B as the first column, C as the second, and so on.
  4. 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.Optionally, you can specify TRUE if you want an approximate match or FALSE if you want an exact match of the return value. Wenn Sie nichts angeben, ist der Standardwert immer TRUE oder eine ungefähre Übereinstimmung.If you don't specify anything, the default value will always be TRUE or approximate match.

Innerhalb einer Zelle sieht die vlookup-Funktion folgendermaßen aus:Inside a cell, the vlookup function looks like this:

= 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)=VLOOKUP(lookup value, range containing the lookup value, the column number in the range containing the return value, optionally specify TRUE for approximate match or FALSE for an exact match)

(Sehen Sie sich die Dokumentation für die SVERWEIS-Excel-Funktion an.)(See the documentation for the VLOOKUP Excel function.)

Im folgenden Beispiel sehen Sie, wie Sie die vlookup-Funktion aufrufen und diese Parameter mit der Excel-REST-API weitergeben.The example below shows how to call the vlookup function and pass these parameters with the Excel REST API.

Anforderung:Request:

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:Response:

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: medianExample: median

In einer Excel-Tabelle verwendet die median-Funktion ein Array eines oder mehrerer Eingabebereiche.In an Excel spreadsheet, the median function takes an array of one or more input ranges.

Innerhalb einer Zelle sieht die median-Funktion folgendermaßen aus:Inside a cell, the median function looks like this example:

=MEDIAN(A2:A6)=MEDIAN(A2:A6)

(Sehen Sie sich die Dokumentation für die MEDIAN-Excel-Funktion an.)(See the documentation for the MEDIAN Excel function.)

Im folgenden Beispiel sehen Sie, wie Sie die median-Funktion und einen oder mehrere Eingabebereiche mit der Excel-REST-API aufrufen.The example below shows how to call the median function and one or more input ranges with the Excel REST API.

Anforderung:Request:

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:Response:

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
}