Sign in

v1

latestOpenAPI 3.1.02026-08-04222461539.5 KB
jobs

Create a job

post/jobs

Headers

Authorizationstring required

Bearer authentication

X-Disable-Hooks'true' required

Request body

type'file' | 'workbook' | 'sheet' | 'space' | 'document' | 'app' | 'agent' | 'autobuild' | 'onboarding' required

The type of job

operationstring required

the type of operation to perform on the data. For example, "export".

sourcestring required

The id of a file, workbook, sheet, or app

destinationstring

Workbook ID

trigger'manual' | 'immediate'

The type of trigger to use for this job

status'created' | 'planning' | 'scheduled' | 'ready' | 'executing' | 'complete' | 'failed' | 'canceled' | 'waiting'

the status of the job

progressinteger

the progress of the job. Whole number between 0 and 100

fileIdstring

File ID

mode'foreground' | 'background' | 'toolbarBlocking' | 'hidden'

the mode of the job

inputobject

Input parameters for this job type.

outcomeobject

Outcome summary of job.

resultobject

Information computed during job execution can be stored here

infostring

Current status of job in text

managedboolean

Indicates if Flatfile is managing the control flow of this job or if it is being manually tracked.

environmentIdstring

Environment ID

partinteger

The part number of this job

partDataobject

The data for this part of the job

partExecution'sequential' | 'parallel'
parentIdstring

Pipeline Job ID

predecessorIdsTypeCommonsJobId[]

The ids of the jobs that must complete before this job can start

metadataobject

Additional metadata for the job

Response

Response with status 200