nodes/generated

Interface ItemListsV3NodeParameters

Source
interface ItemListsV3NodeParameters {
    aggregate?:
        | "aggregateIndividualFields"
        | "aggregateAllItemData";
    code?: string;
    compare?: | "allFields"
    | "allFieldsExcept"
    | "selectedFields";
    destinationFieldName?: string;
    fieldsToAggregate?: {
        fieldToAggregate: {
            fieldToAggregate?: string;
            outputFieldName?: string;
            renameField?: boolean;
        }[];
    };
    fieldsToCompare?: string;
    fieldsToExclude?: string;
    fieldsToInclude?: string;
    fieldsToSplitBy?: string;
    fieldsToSummarize?: {
        values: {
            aggregation?: | "append"
            | "max"
            | "average"
            | "concatenate"
            | "count"
            | "countUnique"
            | "min"
            | "sum";
            customSeparator?: string;
            field?: string;
            includeEmpty?: boolean;
            separateBy?: ""
            | "other"
            | ","
            | ", "
            | "\n"
            | " ";
        }[];
    };
    fieldToSplitOut?: string;
    include?: | "allFields"
    | "specifiedFields"
    | "allFieldsExcept"
    | "noOtherFields"
    | "allOtherFields"
    | "selectedOtherFields";
    keep?: "firstItems"
    | "lastItems";
    maxItems?: number;
    operation?:
        | "limit"
        | "removeDuplicates"
        | "sort"
        | "splitOutItems"
        | "summarize"
        | "concatenateItems";
    options?: | {
        disableDotNotation?: boolean;
        includeBinaries?: boolean;
        keepMissing?: boolean;
        keepOnlyUnique?: boolean;
        mergeLists?: boolean;
    }
    | {
        disableDotNotation?: boolean;
        removeOtherFields?: boolean;
    }
    | { disableDotNotation?: boolean }
    | {
        destinationFieldName?: string;
        disableDotNotation?: boolean;
        includeBinary?: boolean;
    }
    | {
        disableDotNotation?: boolean;
        outputFormat?: "separateItems"
        | "singleItem";
        skipEmptySplitFields?: boolean;
    };
    sortFieldsUi?: {
        sortField: {
            fieldName: string;
            order?: "ascending"
            | "descending";
        }[];
    };
    type?: "simple"
    | "random"
    | "code";
}

Properties§

Source§

readonly aggregate?: "aggregateIndividualFields" | "aggregateAllItemData"

Default: "aggregateIndividualFields"

Source§

readonly code?: string

Javascript code to determine the order of any two items Default: "// The two items to compare are in the variables a and b\n// Access the fields in a.json and b.json\n// Return -1 if a should go before b\n// Return 1 if b should go before a\n// Return 0 if there's no difference\n\nfieldName = 'myField';\n\nif (a.json[fieldName] < b.json[fieldName]) {\nreturn -1;\n}\nif (a.json[fieldName] > b.json[fieldName]) {\nreturn 1;\n}\nreturn 0;" Type options: {"alwaysOpenEditWindow":true,"editor":"jsEditor","rows":10}

Source§

readonly compare?: "allFields" | "allFieldsExcept" | "selectedFields"

The fields of the input items to compare to see if they are the same Default: "allFields"

Source§

readonly destinationFieldName?: string

The name of the output field to put the data in Default: "data"

Source§

readonly fieldsToAggregate?: {
    fieldToAggregate: {
        fieldToAggregate?: string;
        outputFieldName?: string;
        renameField?: boolean;
    }[];
}

Default: {"fieldToAggregate":[{"fieldToAggregate":"","renameField":false}]} Type options: {"multipleValues":true}

Source§

readonly fieldsToCompare?: string

Fields in the input to add to the comparison

Source§

readonly fieldsToExclude?: string

Source§

readonly fieldsToInclude?: string

Source§

readonly fieldsToSplitBy?: string

The name of the input fields that you want to split the summary by

Source§

readonly fieldsToSummarize?: {
    values: {
        aggregation?:
            | "append"
            | "max"
            | "average"
            | "concatenate"
            | "count"
            | "countUnique"
            | "min"
            | "sum";
        customSeparator?: string;
        field?: string;
        includeEmpty?: boolean;
        separateBy?: ""
        | "other"
        | ","
        | ", "
        | "\n"
        | " ";
    }[];
}

Default: {"values":[{"aggregation":"count","field":""}]} Type options: {"multipleValues":true}

Source§

readonly fieldToSplitOut?: string

The name of the input fields to break out into separate items. Separate multiple field names by commas. For binary data, use $binary.

Source§

readonly include?:
    | "allFields"
    | "specifiedFields"
    | "allFieldsExcept"
    | "noOtherFields"
    | "allOtherFields"
    | "selectedOtherFields"

Default: "allFields"

Source§

readonly keep?: "firstItems" | "lastItems"

When removing items, whether to keep the ones at the start or the ending Default: "firstItems"

Source§

readonly maxItems?: number

If there are more items than this number, some are removed Default: 1 Type options: {"minValue":1}

Source§

readonly operation?:
    | "limit"
    | "removeDuplicates"
    | "sort"
    | "splitOutItems"
    | "summarize"
    | "concatenateItems"

Default: "splitOutItems"

Source§

readonly options?:
    | {
        disableDotNotation?: boolean;
        includeBinaries?: boolean;
        keepMissing?: boolean;
        keepOnlyUnique?: boolean;
        mergeLists?: boolean;
    }
    | {
        disableDotNotation?: boolean;
        removeOtherFields?: boolean;
    }
    | { disableDotNotation?: boolean }
    | {
        destinationFieldName?: string;
        disableDotNotation?: boolean;
        includeBinary?: boolean;
    }
    | {
        disableDotNotation?: boolean;
        outputFormat?: "separateItems"
        | "singleItem";
        skipEmptySplitFields?: boolean;
    }

Default: {}

Source§

readonly sortFieldsUi?: {
    sortField: {
        fieldName: string;
        order?: "ascending" | "descending";
    }[];
}

The fields of the input items to compare to see if they are the same Default: {} Type options: {"multipleValues":true}

Source§

readonly type?: "simple" | "random" | "code"

The fields of the input items to compare to see if they are the same Default: "simple"