Create a job

POST

Request

This endpoint expects an object.
typeenumRequired
The type of job
operationstringRequired
the type of operation to perform on the data. For example, "export".
sourcestringRequired
The id of a file, workbook, sheet, or app
destinationstringOptional
The id of the workbook where extracted file data will be sent
trigger"manual" or "immediate"Optional
Allowed values: manualimmediate
the type of trigger to use for this job
statusenumOptional
the status of the job
progressintegerOptional
the progress of the job. Whole number between 0 and 100
fileIdstringOptional
File ID
modeenumOptional
Allowed values: foregroundbackgroundtoolbarBlocking
the mode of the job
inputmap from strings to anyOptional
Input parameters for this job type.
subjectobjectOptional
Subject parameters for this job type.
outcomemap from strings to anyOptional
Outcome summary of job.
infostringOptional
Current status of job in text
managedbooleanOptional
Indicates if Flatfile is managing the control flow of this job or if it is being manually tracked.
environmentIdstringOptional
The id of the environment this job belongs to
partintegerOptional
The part number of this job
partDatamap from strings to anyOptional
The data for this part of the job
partExecution"sequential" or "parallel"Optional
Allowed values: sequentialparallel
The execution mode for this part of the job
parentIdstringOptional
The id of the parent job
predecessorIdslist of stringsOptional
The ids of the jobs that must complete before this job can start
metadatamap from strings to anyOptional
Additional metadata for the job
configobjectOptionalDeprecated

Response

This endpoint returns an object
dataobject
A single unit of work that will execute asynchronously