nodes/generated

Interface MicrosoftExcelV2NodeParameters

Source


interface MicrosoftExcelV2NodeParameters {
    additionalFields?: { name?: string };
    applyTo?: "All" | "Formats" | "Contents";
    authentication?:
        | "microsoftEntraServicePrincipalApi"
        | "microsoftExcelOAuth2Api"
        | "microsoftOAuth2Api";
    columnToMatchOn?: string;
    data?: string;
    dataMode?: "define"
    | "raw"
    | "autoMap";
    dataProperty?: string;
    dataStartRow?: number;
    driveTarget?: { mode: "id"; value: string };
    fieldsUi?: {
        values: { column?: string; fieldValue?: string }[];
    };
    filters?: | { fields?: string }
    | { column?: unknown[]; fields?: string };
    hasHeaders?: boolean;
    keyRow?: number;
    limit?: number;
    lookupColumn?: string;
    lookupValue?: string;
    operation?:
        | "getAll"
        | "update"
        | "append"
        | "upsert"
        | "clear"
        | "deleteTable"
        | "lookup"
        | "deleteWorksheet"
        | "readRows"
        | "convertToRange"
        | "getColumns"
        | "getRows"
        | "addWorksheet"
        | "deleteWorkbook"
        | "addTable";
    options?: | {
        dataProperty: string;
        index?: number;
        rawData?: boolean;
    }
    | { returnAllMatches?: boolean }
    | { dataProperty: string; rawData?: boolean }
    | {
        dataProperty: string;
        fields?: string;
        rawData?: boolean;
    }
    | {
        dataProperty: string;
        fields?: string;
        rawData?: boolean;
        updateAll?: boolean;
    }
    | {
        appendAfterSelectedRange?: boolean;
        dataProperty: string;
        rawData?: boolean;
        updateAll?: boolean;
    };
    range?: string;
    rawData?: boolean;
    resource?: "table"
    | "worksheet"
    | "workbook";
    resourceTarget?: "user" | "drive";
    returnAll?: boolean;
    selectRange?: "manual" | "auto";
    table?: { mode: "id" | "list"; value: string };
    useRange?: boolean;
    userTarget?: { mode: "id"; value: string };
    valueToMatchOn?: string;
    workbook?: { mode: "id" | "list"; value: string };
    worksheet?: { mode: "id" | "list"; value: string };
}

Properties§

§readonly additionalFields?: { ... }

Default: {}

§readonly applyTo?: "All" | "Formats" | "Contents"

Default: "All"

§readonly authentication?:
    | "microsoftEntraServicePrincipalApi"
    | "microsoftExcelOAuth2Api"
    | "microsoftOAuth2Api"

Default: "microsoftExcelOAuth2Api"

§readonly columnToMatchOn?: string

Choose from the list, or specify an ID using an expression Type options: {"loadOptionsDependsOn":["worksheet.value","workbook.value","range"],"loadOptionsMethod":"getWorksheetColumnRow"}

§readonly data?: string

Raw values for the specified range as array of string arrays in JSON format

§readonly dataMode?: "define" | "raw" | "autoMap"

Default: "define"

§readonly dataProperty?: string

The name of the property into which to write the RAW data Default: "data"

§readonly dataStartRow?: number

Relative to selected 'Range', first row index is 0 Default: 1 Type options: {"minValue":0}

§readonly driveTarget?: { ... }

The drive the Service Principal should act on. Evaluated per input item — an expression can target a different drive for each item. Operations that write all rows in one request (append, update, upsert) use the first item's target. Default: {"mode":"id","value":""}

§readonly fieldsUi?: { ... }

Default: {} Type options: {"multipleValues":true}

§readonly filters?:
    | { fields?: string }
    | { column?: unknown[]; fields?: string }

Default: {}

§readonly hasHeaders?: boolean

Whether the range has column labels. When this property set to false Excel will automatically generate header shifting the data down by one row. Default: true

§readonly keyRow?: number

Relative to selected 'Range', first row index is 0 Type options: {"minValue":0}

§readonly limit?: number

Max number of results to return Default: 100 Type options: {"minValue":1,"maxValue":500}

§readonly lookupColumn?: string

The name of the column in which to look for value

§readonly lookupValue?: string

The value to look for in column

§readonly operation?:
    | "getAll"
    | "update"
    | "append"
    | "upsert"
    | "clear"
    | "deleteTable"
    | "lookup"
    | "deleteWorksheet"
    | "readRows"
    | "convertToRange"
    | "getColumns"
    | "getRows"
    | "addWorksheet"
    | "deleteWorkbook"
    | "addTable"

Default: "append"

§readonly options?:
    | {
        dataProperty: string;
        index?: number;
        rawData?: boolean;
    }
    | { returnAllMatches?: boolean }
    | { dataProperty: string; rawData?: boolean }
    | {
        dataProperty: string;
        fields?: string;
        rawData?: boolean;
    }
    | {
        dataProperty: string;
        fields?: string;
        rawData?: boolean;
        updateAll?: boolean;
    }
    | {
        appendAfterSelectedRange?: boolean;
        dataProperty: string;
        rawData?: boolean;
        updateAll?: boolean;
    }

Default: {}

§readonly range?: string

The range of cells that will be converted to a table

§readonly rawData?: boolean

Whether the data should be returned RAW instead of parsed into keys according to their header

§readonly resource?: "table" | "worksheet" | "workbook"

Default: "workbook"

§readonly resourceTarget?: "user" | "drive"

Which drive the Service Principal should act on (app-only has no personal drive) Default: "user"

§readonly returnAll?: boolean

Whether to return all results or only up to a given limit

§readonly selectRange?: "manual" | "auto"

Default: "auto"

§readonly table?: { ... }

Default: {"mode":"list","value":""}

§readonly useRange?: boolean
§readonly userTarget?: { ... }

The user whose drive the Service Principal should act on. Evaluated per input item — an expression can target a different user for each item. Operations that write all rows in one request (append, update, upsert) use the first item's target. Default: {"mode":"id","value":""}

§readonly valueToMatchOn?: string
§readonly workbook?: { ... }

Default: {"mode":"list","value":""}

§readonly worksheet?: { ... }

Default: {"mode":"list","value":""}