Excel Office365connector v1 R7 | OneTeg Documentation

Version 1 Revision 7

Connector Overview: This page documents all 13 actions for the Excel Office365connector v1 R7.

General (11)

POST Copy File

/drives/{driveId}/items/{itemId}/copy

Copies an existing file in a OneDrive or SharePoint drive to another directory. Use this when you need to duplicate a spreadsheet template for new inputs.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Driveid`	The unique identifier of the drive containing the source file.
`Itemid`	The unique identifier of the file to be copied.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Name`	The new file name, including the extension, to assign to the copy.

GET Get File Details

/me/drive/root:/{fileName}

Retrieves the metadata and properties of a file in the user's root drive directory using its file name.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Filename`	The name of the file to locate, including its extension.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get Folders

/me/drive/root/children

Retrieves the list of child items and folders located in the root directory of the user's drive.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`$filter`	An OData filter string used to restrict the returned collection of folders.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get Item By Id

/drives/{driveId}/items/{itemId}

Retrieves the metadata of a specific drive item by identifying both the drive and the item ID.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Driveid`	The unique identifier of the target drive.
`Itemid`	The unique identifier of the file or folder item.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get Used Range

/me/drive/root:/{work_book_name}:/workbook/worksheets/{sheetId}/usedRange

Gets the worksheet's used range, which represents the smallest block of cells that contains data or formatting.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Work Book Name`	The name of the Excel workbook in the root drive directory.
`Sheetid`	The unique identifier or name of the worksheet.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get Worksheet Id

/me/drive/items/{item_id}/workbook/worksheets/{sheet_name}

Retrieve details of a specific worksheet in an Excel workbook stored in OneDrive.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Item Id`	The unique identifier of the workbook item.
`Sheet Name`	The name or ID of the worksheet.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get a folder

/drives/{DriveID}/root:/{path}

Retrieves folder details using the drive identifier and the relative path of the folder.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Driveid`	The unique identifier of the drive containing the folder.
`Path`	The relative path to the folder from the drive root.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get drive Id

/sites/{siteId}/drives

Retrieves the list of drives available inside a specified SharePoint site.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Siteid`	The unique identifier of the SharePoint site.
`Response Type`	The response format expected from the API (e.g. application/json).

GET List Worksheets In a Workbook

/me/drive/root:/{work_book_name}:/workbook/worksheets

Retrieves a collection of all worksheets contained within a specified Excel workbook.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Work Book Name`	The name of the Excel file located in your root drive directory.
`Response Type`	The response format expected from the API (e.g. application/json).

PATCH Patch Worksheet

/me/drive/root:/{work_book_name}:/workbook/worksheets/{sheetId}/{range}

Updates a specific range of cells inside an Excel worksheet with new values or formatting.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Work Book Name`	The name of the Excel workbook file.
`Sheetid`	The unique identifier or name of the worksheet.
`Range`	The range address of the cells to modify, such as A1:B10.
`Workbook-session-id`	The active session identifier for maintaining workbook state across requests.
`Prefer`	Optional preference header to control server response options, such as respond-async.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Values`	A multi-dimensional array of values to insert into the specified cell range.

GET Search Files

/me/drive/root/{query}

Searches for files and folders containing a specified search query in the user's root drive.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Query`	The text search query to match against file and folder names.
`Response Type`	The response format expected from the API (e.g. application/json).

Session

POST Close Session

/me/drive/items/{item_id}/workbook/closeSession

Close Session

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Item Id-test`	The unique identifier of the workbook item whose session is closing.
`Workbook-session-id`	The active workbook session identifier to terminate.
`Response Type`	The response format expected from the API (e.g. application/json).

Table

POST Add Table Rows

/me/drive/root:/{work_book_name}:/workbook/tables/{id}/rows/add

Add Table Rows

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Work Book Name`	The name of the Excel workbook containing the table.
`Id`	The unique identifier or name of the table to add rows to.
`Workbook-session-id`	The active session identifier for maintaining consistent state.
`Prefer`	Optional preference header to configure request behavior, such as return=representation.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Values`	A two-dimensional array representing the rows of data to append.