Skip to main content
All CollectionsWrk Action LibraryKoBoToolbox
Retrieve submission from KoBoToolbox
Retrieve submission from KoBoToolbox
Wrk Product avatar
Written by Wrk Product
Updated over a month ago

Retrieve submission from KoBoToolbox.

Application

  • KoBoToolbox

Inputs (what you have)

Name

Description

Data Type

Required?

Example

Connected Account

The connected account to use for the request

Connected Account

Yes

Form ID

Form ID (e.g. aSAvYreNzVEkrWg5Gdcvg)

Text (Short)

Yes

Submission ID

Submission ID (number, e.g. 245128)

Text (Short)

Yes

Download attachments?

Whether to download submitted attachments

True/False

No

Attachments naming scheme

Predefined Choice List

No

Fields to retrieve

Comma-separated list of fields to retrieve (e.g. _submission_time,_submitted_by). If left blank, all fields are retrieved

Text (Long)

No

File size

Attachment size to retrieve, if multiple versions are available

Predefined Choice List

No

Multiselect mask

Comma-separated list of wildcard-style selectors for fields that should be treated as multiselect fields, i.e. parsed as arrays

Text (Long)

No

Number mask

Comma-separated list of wildcard-style selectors for fields that should be treated as numbers

Text (Long)

No

Reformat?

Whether to apply some reformatting to the submission data, such as parsing GeoJSON coordinates

True/False

No

Sort

Sort predicates, in MongoDB JSON format (e.g. {"_submission_time":1})

Text (Long)

No

Outputs (what you get)

Name

Description

Data Type

Required?

Example

JSON Output

JSON output returned by the API

Text (Long)

No

Outcomes

Name

Description

Success

This status is selected if the job has successfully completed.

Unsuccessful

This status is selected if the job has completed unsuccessfully.

Requirements

  • N/A

Did this answer your question?