n8n-nodes-base
Version:
Base nodes of n8n
73 lines (69 loc) • 2.8 kB
text/typescript
/**
* KoBoToolbox Node - Version 1
* Discriminator: resource=submission, operation=get
*/
interface Credentials {
koBoToolboxApi: CredentialReference;
}
/** Get a form */
export type KoBoToolboxV1SubmissionGetParams = {
resource: 'submission';
operation: 'get';
/**
* Form ID (e.g. aSAvYreNzVEkrWg5Gdcvg). Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code/expressions/">expression</a>.
*/
formId?: string | Expression<string>;
/**
* Submission ID (number, e.g. 245128)
*/
submissionId?: string | Expression<string> | PlaceholderValue;
/**
* Options
* @default {}
*/
options?: {
/** Whether to download submitted attachments
* @default false
*/
download?: boolean | Expression<boolean>;
/** Attachments Naming Scheme
* @displayOptions.show { download: [true] }
* @default sequence
*/
binaryNamingScheme?: 'sequence' | 'question' | Expression<string>;
/** Prefix for name of the binary property to which to write the attachments. An index starting with 0 will be added. So if name is "attachment_" the first attachment is saved to "attachment_0"
* @displayOptions.show { download: [true], binaryNamingScheme: ["sequence"] }
* @default attachment_
*/
dataPropertyAttachmentsPrefixName?: string | Expression<string> | PlaceholderValue;
/** Comma-separated list of fields to retrieve (e.g. _submission_time,_submitted_by). If left blank, all fields are retrieved.
*/
fields?: string | Expression<string> | PlaceholderValue;
/** Attachment size to retrieve, if multiple versions are available
* @displayOptions.show { download: [true] }
* @default download_url
*/
version?: 'download_url' | 'download_small_url' | 'download_medium_url' | 'download_large_url' | Expression<string>;
/** Comma-separated list of wildcard-style selectors for fields that should be treated as multiselect fields, i.e. parsed as arrays.
* @default select_*
*/
selectMask?: string | Expression<string> | PlaceholderValue;
/** Comma-separated list of wildcard-style selectors for fields that should be treated as numbers
* @default n_*, f_*
*/
numberMask?: string | Expression<string> | PlaceholderValue;
/** Whether to apply some reformatting to the submission data, such as parsing GeoJSON coordinates
* @default false
*/
reformat?: boolean | Expression<boolean>;
/** Sort predicates, in MongoDB JSON format (e.g. {"_submission_time":1})
*/
sort?: IDataObject | string | Expression<string>;
};
};
export type KoBoToolboxV1SubmissionGetNode = {
type: 'n8n-nodes-base.koBoToolbox';
version: 1;
credentials?: Credentials;
config: NodeConfig<KoBoToolboxV1SubmissionGetParams>;
};