Update a job | Flatfile | API Reference

1 from flatfile import Flatfile 2 from flatfile.jobs import EmptyObject 3 4 client = Flatfile( 5 token="YOUR_TOKEN", 6 ) 7 client.jobs.update( 8 job_id="us_jb_YOUR_ID", 9 config=EmptyObject(), 10 status="complete", 11 progress=100, 12 )

1 { 2 "data": { 3 "createdAt": "2023-10-30T20:04:28.556Z", 4 "createdBy": "us_usr_YOUR_ID", 5 "id": "us_jb_YOUR_ID", 6 "operation": "submitAction", 7 "source": "us_wb_YOUR_ID", 8 "type": "workbook", 9 "updatedAt": "2023-10-30T20:04:32.075Z", 10 "config": {}, 11 "destination": "us_wb_YOUR_ID", 12 "environmentId": "us_env_YOUR_ID", 13 "fileId": "us_fl_YOUR_ID", 14 "finishedAt": "2023-10-30T20:04:32.074Z", 15 "info": "Starting job to submit action to webhook.site", 16 "input": {}, 17 "managed": true, 18 "mode": "foreground", 19 "outcome": { 20 "message": "Data was successfully submitted to Webhook.site. Go check it out at https://example.site/example." 21 }, 22 "progress": 100, 23 "startedAt": "2023-10-30T20:04:29.453Z", 24 "status": "complete", 25 "subject": { 26 "type": "resource", 27 "id": "us_wb_YOUR_ID" 28 }, 29 "trigger": "immediate" 30 } 31 }

Path parameters

jobIdstringRequired

The id of the job to patch

Request

This endpoint expects an object.

configobjectOptional

statusenumOptional

the status of the job

progressintegerOptional

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

outcomeAcknowledgedAtdatetimeOptional

the time that the job’s outcome has been acknowledged by a user

infostringOptional

Current status of job in text

metadatamap from strings to anyOptional

Additional metadata for the job

Response

This endpoint returns an object.

dataobject

A single unit of work that will execute asynchronously

Path parameters

Headers

Request

Response