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       "spaceId": "us_sp_YOUR_ID",
25       "startedAt": "2023-10-30T20:04:29.453Z",
26       "status": "complete",
27       "subject": {
28         "type": "resource",
29         "id": "us_wb_YOUR_ID"
30       },
31       "trigger": "immediate"
32     },
33     "plan": {
34       "fieldMapping": [
35         {
36           "sourceField": {
37             "type": "string",
38             "key": "firstName"
39           },
40           "destinationField": {
41             "type": "string",
42             "key": "firstName",
43             "label": "First Name"
44           },
45           "preview": [
46             "John",
47             "Suzy",
48             "Joe"
49           ],
50           "metadata": {
51             "certainty": "absolute",
52             "confidence": 1,
53             "source": "exact"
54           }
55         },
56         {
57           "sourceField": {
58             "type": "string",
59             "key": "lastName"
60           },
61           "destinationField": {
62             "type": "string",
63             "key": "lastName",
64             "label": "Last Name"
65           },
66           "preview": [
67             "Smith",
68             "Que",
69             "Montana"
70           ],
71           "metadata": {
72             "certainty": "absolute",
73             "confidence": 1,
74             "source": "exact"
75           }
76         }
77       ],
78       "unmappedSourceFields": [],
79       "unmappedDestinationFields": []
80     }
81   }
82 }

Returns a single job's execution plan

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

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

Authentication

Path parameters

Headers

Response