Type de ressource Classeur

Workbook resource type

Le classeur est l’objet de niveau supérieur qui contient des objets connexes tels que des feuilles de calcul, des tableaux, des plages, etc.Workbook is the top level object which contains related workbook objects such as worksheets, tables, ranges, etc.

Représentation JSONJSON representation

Voici une représentation JSON de la ressourceHere 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"}]
}

PropriétésProperties

AucunNone

MéthodesMethods

MéthodeMethod Type renvoyéReturn Type DescriptionDescription
Créer une sessionCreate Session workbookSessionInfoworkbookSessionInfo Créez une session de classeur pour démarrer une session permanente ou non permanente.Create a workbook session to start a persistent or non-persistent session.
Fermer la sessionClose Session AucunNone Fermez une session existante.Close an existing session.
Actualiser la sessionRefresh Session AucunNone Actualisez une session existante.Refresh an existing session.

RelationsRelationships

RelationRelationship TypeType DescriptionDescription
nomsnames Collection WorkbookNamedItemWorkbookNamedItem collection Représente une collection d’éléments nommés portant sur le classeur (appelés plages et constantes). En lecture seule.Represents a collection of workbook scoped named items (named ranges and constants). Read-only.
tableaux
tables Collection WorkbookTableWorkbookTable collection Représente une collection de tableaux associés au classeur. En lecture seule.Represents a collection of tables associated with the workbook. Read-only.
feuilles de calcul
worksheets Collection WorkbookWorksheetWorkbookWorksheet collection Représente une collection de feuilles de calcul associées au classeur. En lecture seule.Represents a collection of worksheets associated with the workbook. Read-only.

FonctionsFunctions

Fonctions Excel : Appellent une fonction de classeur en utilisant la syntaxe POST /workbook/functions/{function-name} et en fournissant les arguments de fonction dans le corps à l’aide d’un objet JSON.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. L’élément value résultant de la fonction et les chaînes error sont renvoyés dans l’objet de résultat de la fonction.The function's resulting value and any error strings are returned in the function result object. La valeur error « null » indique que la fonction a été exécutée.The error value of null indicates successful execution of the function.

La liste complète des fonctions prises en charge est disponible ici. Reportez-vous à la signature de fonction pour les types de données et les noms de paramètres spécifiques.The complete list of supported functions are listed here. Refer to the function signature for specific parameter names and data types.

Remarques importantes :Important notes:

  • Le paramètre d’entrée de plage est fourni à l’aide d’un objet de plage au lieu de la chaîne d’adresse de plage.The range input parameter is supplied using a range object instead of the range address string.
  • Le paramètre d’index est indexé sur 1 contrairement à l’index 0 utilisé dans la plupart des API.The index parameter is 1-indexed unlike the 0-index used in most of the APIs.

Exemple : vlookupExample: vlookup

Dans une feuille de calcul Excel, la fonction vlookup accepte les arguments suivants :In an Excel spreadsheet, the vlookup function takes the following arguments:

  1. La valeur que vous souhaitez rechercher, également appelée valeur de recherche.The value you want to look up, also called the lookup value.
  2. La plage dans laquelle se trouve la valeur de recherche.The range where the lookup value is located. N’oubliez pas que la valeur de recherche doit toujours apparaître dans la première colonne de la plage pour que RECHERCHEV fonctionne correctement. Remember that the lookup value should always be in the first column in the range for VLOOKUP to work correctly. Par exemple, si la valeur de recherche se trouve dans la cellule C2, votre plage doit commencer par C.For example, if your lookup value is in cell C2 then your range should start with C.
  3. Le numéro de colonne dans la plage qui contient la valeur renvoyée.The column number in the range that contains the return value. Par exemple, si vous spécifiez la plage B2:D11, vous devez compter B comme la première colonne, C comme la deuxième, et ainsi de suite.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. Si vous le souhaitez, vous pouvez spécifier TRUE pour obtenir une correspondance approximative ou FALSE pour obtenir une correspondance exacte par rapport à la valeur renvoyée.Optionally, you can specify TRUE if you want an approximate match or FALSE if you want an exact match of the return value. Si vous n’indiquez rien, la valeur par défaut sera toujours TRUE, soit une correspondance approximative.If you don't specify anything, the default value will always be TRUE or approximate match.

Dans une cellule, la fonction vlookup se présente comme suit :Inside a cell, the vlookup function looks like this:

=RECHERCHEV (valeur de recherche, plage contenant la valeur de recherche, numéro de colonne dans la plage contenant la valeur renvoyée, éventuellement spécifier TRUE pour obtenir une correspondance approximative ou FALSE pour une correspondance exacte) =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)

(Consultez la documentation relative à la fonction RECHERCHEV dans Excel.)(See the documentation for the VLOOKUP Excel function.)

L’exemple ci-dessous indique comment appeler la fonction vlookup et comment transmettre ces paramètres avec l’API REST Excel.The example below shows how to call the vlookup function and pass these parameters with the Excel REST API.

Demande :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
}

Réponse :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"
}

Exemple : medianExample: median

Dans une feuille de calcul Excel, la fonction median accepte une matrice d’une ou plusieurs plages d’entrées.In an Excel spreadsheet, the median function takes an array of one or more input ranges.

Dans une cellule, la fonction median se présente comme dans cet exemple :Inside a cell, the median function looks like this example:

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

(Consultez la documentation relative à la fonction MEDIANE dans Excel.)(See the documentation for the MEDIAN Excel function.)

L’exemple ci-dessous indique comment appeler la fonction median, ainsi qu’une ou plusieurs plages d’entrées avec l’API REST Excel.The example below shows how to call the median function and one or more input ranges with the Excel REST API.

Demande :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" },
      ] 
}

Réponse :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
}