Get a job’s execution plan

GET

https://api.x.flatfile.com/v1/jobs/:jobId/plan

GET

/v1/jobs/:jobId/plan

1 from flatfile import Flatfile
2 
3 client = Flatfile(
4     token="YOUR_TOKEN",
5 )
6 client.jobs.get_execution_plan(
7     job_id="us_jb_YOUR_ID",
8 )

Try it

200Example0

1 {
2   "data": {
3     "job": {
4       "createdAt": "2023-10-30T20:04:28.556Z",
5       "createdBy": "us_usr_YOUR_ID",
6       "id": "us_jb_YOUR_ID",
7       "operation": "submitAction",
8       "source": "us_wb_YOUR_ID",
9       "type": "workbook",
10       "updatedAt": "2023-10-30T20:04:32.075Z",
11       "config": {},
12       "destination": "us_wb_YOUR_ID",
13       "environmentId": "us_env_YOUR_ID",
14       "fileId": "us_fl_YOUR_ID",
15       "finishedAt": "2023-10-30T20:04:32.074Z",
16       "info": "Starting job to submit action to webhook.site",
17       "input": {},
18       "managed": true,
19       "mode": "foreground",
20       "outcome": {
21         "message": "Data was successfully submitted to Webhook.site. Go check it out at https://example.site/example."
22       },
23       "progress": 100,
24       "startedAt": "2023-10-30T20:04:29.453Z",
25       "status": "complete",
26       "subject": {
27         "type": "resource",
28         "id": "us_wb_YOUR_ID"
29       },
30       "trigger": "immediate"
31     },
32     "plan": {
33       "fieldMapping": [
34         {
35           "sourceField": {
36             "type": "string",
37             "key": "firstName"
38           },
39           "destinationField": {
40             "type": "string",
41             "key": "firstName",
42             "label": "First Name"
43           },
44           "preview": [
45             "John",
46             "Suzy",
47             "Joe"
48           ],
49           "metadata": {
50             "certainty": "absolute",
51             "confidence": 1,
52             "source": "exact"
53           }
54         },
55         {
56           "sourceField": {
57             "type": "string",
58             "key": "lastName"
59           },
60           "destinationField": {
61             "type": "string",
62             "key": "lastName",
63             "label": "Last Name"
64           },
65           "preview": [
66             "Smith",
67             "Que",
68             "Montana"
69           ],
70           "metadata": {
71             "certainty": "absolute",
72             "confidence": 1,
73             "source": "exact"
74           }
75         }
76       ],
77       "unmappedSourceFields": [],
78       "unmappedDestinationFields": []
79     }
80   }
81 }

Returns a single job’s execution plan

Path parameters

jobIdstringRequired

ID of job to return

Response

This endpoint returns an object.

dataobject

The job/plan tuple that contains the full plan and the jobs status

Path parameters

Headers

Response