Export database forms

Exports all forms in a database or folder to an Excel workbook.

Starting the job

This operation is a long-running batch job. You must first submit a request to start the job.

POST https://www.activityinfo.org/resources/jobs

Request body

object
type	string	The type of the job to start. Must be `"exportDatabaseForms"`	required
descriptor	object		required
databaseId	string	The id of the database containing the forms to export.	required
folderId	string	Optionally, the folder or form to include in the export. If ommitted, then all forms in the database will be included.	optional
format	string	The format of the table structure.Values: LONG All forms are exported in one long table. Each quantity appears its own row, and text fields, single select fields, and reference field keys appear in columns. WIDE Forms are exported one form per sheet, with each record in a new row. Each field is in its own column.	required
fileFormat	string	The file format.Values: XLSX Office Open XML .xlsx file. DOCX Office Open XML .docx file. PDF Adobe Portable Document Format (PDF) TEXT UTF-8 encoded text file, with rows seperated by newline characters ('\n') and columns seperated by the INFORMATION SEPARATOR control character (U+001F). Can only be used for a single form, or for database forms exported using the LONG format.	required
filter	string	A formula that is applied to each form to filter the resulting records.	optional
includeBlanks	boolean	True if the export should include rows for blank quantities. Only applies to the LONG format.	required
utcOffset	integer	The time zone to use for time values, as an offset from Universal Coordinate Time (UTC) in minutes,	required

Getting the job status

The result of this first call provides a job id that you can use to poll for status:

GET https://www.activityinfo.org/resources/jobs/{jobId}

curl -X GET https://www.activityinfo.org/resources/jobs/ahBlfmFjdGl2aXR5aW5mb2V1chALEgNKb2IYgICAzd390wkM \
  -u anything:APITOKEN \
  -H 'Content-type: application/json' \
  --data-binary @- << EOF
{
  "id": "ahBlfmFjdGl2aXR5aW5mb2V1chALEgNKb2IYgICAzd390wkM",
  "state": "STARTED"
}
EOF

Successful result

When the job state transitions to "COMPLETED", the status object will include the result:

object
id	string	The id of the job	required
state	string	`"COMPLETED"`	required
result	object		required
filename	string	The filename of the export.	required
downloadUrl	string	The URL that can be used to download the result.	required

Next item

Export form