Categories: Productivity and Collaboration

Type: microsoftExcel/v1

Connections

Version: 1

OAuth2 Authorization Code

Properties

Connection Setup

Create OAuth 2.0 Application

Creation of OAuth 2.0 application is documented here.

Grant Necessary Permissions

1. Open the Azure Portal: https://portal.azure.com/
2. Click on App registrations.
3. Click on All applications.
4. Click on application you want to connect to Microsoft Excel.
5. Click on API permissions.
6. Click on Microsoft Graph (1).
7. Select following scopes:
   • Files.ReadWrite
   • offline_access
8. After selecting all the scopes click on Update permissions

Actions

Append Row

Name: appendRow

Append a row of values to an existing worksheet.

Properties

Example JSON Structure

{
  "label" : "Append Row",
  "name" : "appendRow",
  "parameters" : {
    "workbookId" : "",
    "worksheetName" : "",
    "isTheFirstRowHeader" : false,
    "row" : { }
  },
  "type" : "microsoftExcel/v1/appendRow"
}

Output

The output for this action is dynamic and may vary depending on the input parameters. To determine the exact structure of the output, you need to execute the action.

Find Workbook ID

To find the Workbook ID, click here.

Find Worksheet Name

To find the Worksheet name, click here.

Clear Worksheet

Name: clearWorksheet

Clear a worksheet of all values.

Properties

Example JSON Structure

{
  "label" : "Clear Worksheet",
  "name" : "clearWorksheet",
  "parameters" : {
    "workbookId" : "",
    "worksheetName" : "",
    "isTheFirstRowHeader" : false
  },
  "type" : "microsoftExcel/v1/clearWorksheet"
}

Output

This action does not produce any output.

Find Workbook ID

To find the Workbook ID, click here.

Find Worksheet Name

To find the Worksheet name, click here.

Delete Row

Name: deleteRow

Delete row on an existing sheet.

Properties

Example JSON Structure

{
  "label" : "Delete Row",
  "name" : "deleteRow",
  "parameters" : {
    "workbookId" : "",
    "worksheetName" : "",
    "rowNumber" : 1
  },
  "type" : "microsoftExcel/v1/deleteRow"
}

Output

This action does not produce any output.

Find Workbook ID

To find the Workbook ID, click here.

Find Worksheet Name

To find the Worksheet name, click here.

Find Row by Number

Name: findRowByNum

Get row values from the worksheet by the row number.

Properties

Example JSON Structure

{
  "label" : "Find Row by Number",
  "name" : "findRowByNum",
  "parameters" : {
    "workbookId" : "",
    "worksheetName" : "",
    "isTheFirstRowHeader" : false,
    "rowNumber" : 1
  },
  "type" : "microsoftExcel/v1/findRowByNum"
}

Output

The output for this action is dynamic and may vary depending on the input parameters. To determine the exact structure of the output, you need to execute the action.

Find Workbook ID

To find the Workbook ID, click here.

Find Worksheet Name

To find the Worksheet name, click here.

Update Row

Name: updateRow

Update a row in an existing worksheet.

Properties

Example JSON Structure

{
  "label" : "Update Row",
  "name" : "updateRow",
  "parameters" : {
    "workbookId" : "",
    "worksheetName" : "",
    "rowNumber" : 1,
    "isTheFirstRowHeader" : false,
    "updateWholeRow" : false,
    "row" : { }
  },
  "type" : "microsoftExcel/v1/updateRow"
}

Output

The output for this action is dynamic and may vary depending on the input parameters. To determine the exact structure of the output, you need to execute the action.

Find Workbook ID

To find the Workbook ID, click here.

Find Worksheet Name

To find the Worksheet name, click here.

Triggers

New Row

Name: newRow

Triggers when a new row is added.

Type: POLLING

Properties

Output

The output for this action is dynamic and may vary depending on the input parameters. To determine the exact structure of the output, you need to execute the action.

JSON Example

{
  "label" : "New Row",
  "name" : "newRow",
  "parameters" : {
    "workbookId" : "",
    "worksheetName" : "",
    "isTheFirstRowHeader" : false
  },
  "type" : "microsoftExcel/v1/newRow"
}

Find Workbook ID

To find the Workbook ID, click here.

Find Worksheet Name

To find the Worksheet name, click here.

What to do if your action is not listed here?

If this component doesn't have the action you need, you can use Custom Action to create your own. Custom Actions empower you to define HTTP requests tailored to your specific requirements, allowing for greater flexibility in integrating with external services or APIs.

To create a Custom Action, simply specify the desired HTTP method, path, and any necessary parameters. This way, you can extend the functionality of your component beyond the predefined actions, ensuring that you can meet all your integration needs effectively.

Additional Instructions

How to find Workbook ID

Via API

Use the GET https://graph.microsoft.com/v1.0/me/drive/items/root/search(q='.xlsx') endpoint.

How to find Worksheet Name

To find a Worksheet Name, open the workbook. Below the worksheet you will find a bar with worksheet names.