nodes/generated

Interface KoBoToolboxNodeParameters

Source
interface KoBoToolboxNodeParameters {
    binaryPropertyName?: string;
    download?: boolean;
    endDate?: string;
    fileId?: string;
    fileMode?: "url" | "binary";
    fileUrl?: string;
    filterJson?: string;
    filters?: { filter?: string };
    filterType?: "none" | "json";
    formId?: string;
    hookId?: string;
    limit?: number;
    logId?: string;
    operation?:
        | "create"
        | "get"
        | "getAll"
        | "delete"
        | "redeploy"
        | "getLogs"
        | "retryAll"
        | "retryOne"
        | "getValidation"
        | "setValidation";
    options?: | {
        sort?: {
            value: {
                descending?: boolean;
                ordering?: | "name"
                | "asset_type"
                | "date_modified"
                | "owner__username"
                | "subscribers_count";
            };
        };
    }
    | {
        binaryNamingScheme?: "sequence"
        | "question";
        dataPropertyAttachmentsPrefixName?: string;
        download?: boolean;
        fields?: string;
        numberMask?: string;
        reformat?: boolean;
        selectMask?: string;
        sort?: string;
        version?:
            | "download_url"
            | "download_small_url"
            | "download_medium_url"
            | "download_large_url";
    };
    resource?: "file"
    | "form"
    | "hook"
    | "submission";
    returnAll?: boolean;
    startDate?: string;
    status?: "" | "1" | "2" | "0";
    submissionId?: string;
    validationStatus?:
        | "validation_status_approved"
        | "validation_status_not_approved"
        | "validation_status_on_hold";
}

Properties§

§readonly binaryPropertyName?: string

Name of the binary property to write the file into Default: "data"

§readonly download?: boolean

Whether to download the file content into a binary property

§readonly endDate?: string

Maximum date for the hook log to retrieve

§readonly fileId?: string

Uid of the file (should start with "af" e.g. "afQoJxA4kmKEXVpkH6SYbhb"

§readonly fileMode?: "url" | "binary"

Default: "binary"

§readonly fileUrl?: string

HTTP(s) link to the file to upload

§readonly filterJson?: string
§readonly filters?: { ... }

Default: {}

§readonly filterType?: "none" | "json"

Default: "none"

§readonly formId?: string

Form ID (e.g. aSAvYreNzVEkrWg5Gdcvg). Choose from the list, or specify an ID using an expression. Type options: {"loadOptionsMethod":"loadForms"}

§readonly hookId?: string

Hook ID (starts with h, e.g. hVehywQ2oXPYGHJHKtqth4)

§readonly limit?: number

Max number of results to return Default: 1000 Type options: {"maxValue":3000}

§readonly logId?: string

Hook log ID (starts with hl, e.g. hlSbGKaUKzTVNoWEVMYbLHe)

§readonly operation?:
    | "create"
    | "get"
    | "getAll"
    | "delete"
    | "redeploy"
    | "getLogs"
    | "retryAll"
    | "retryOne"
    | "getValidation"
    | "setValidation"

Default: "get"

§readonly options?:
    | {
        sort?: {
            value: {
                descending?: boolean;
                ordering?: | "name"
                | "asset_type"
                | "date_modified"
                | "owner__username"
                | "subscribers_count";
            };
        };
    }
    | {
        binaryNamingScheme?: "sequence"
        | "question";
        dataPropertyAttachmentsPrefixName?: string;
        download?: boolean;
        fields?: string;
        numberMask?: string;
        reformat?: boolean;
        selectMask?: string;
        sort?: string;
        version?:
            | "download_url"
            | "download_small_url"
            | "download_medium_url"
            | "download_large_url";
    }

Default: {}

§readonly resource?: "file" | "form" | "hook" | "submission"

Default: "submission"

§readonly returnAll?: boolean

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

§readonly startDate?: string

Minimum date for the hook log to retrieve

§readonly status?: "" | "1" | "2" | "0"

Only retrieve logs with a specific status

§readonly submissionId?: string

Submission ID (number, e.g. 245128)

§readonly validationStatus?:
    | "validation_status_approved"
    | "validation_status_not_approved"
    | "validation_status_on_hold"

Desired Validation Status