Get a job's execution plan

GET

Returns a single job’s execution plan

Path parameters

jobIdstringRequired

ID of job to return

Headers

X-Disable-Hooks"true"RequiredDefaults to true

Response

This endpoint returns an object.

dataobject

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

GET

1 curl https://api.x.flatfile.com/v1/jobs/us_jb_YOUR_ID/plan \
2      -H "X-Disable-Hooks: true" \
3      -H "Authorization: Bearer <token>"

200Retrieved

1 {
2   "data": {
3     "job": {
4       "createdAt": "2023-10-30T20:04:28.556Z",
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     "plan": {
32       "fieldMapping": [
33         {
34           "sourceField": {
35             "type": "string",
36             "key": "firstName"
37           },
38           "destinationField": {
39             "type": "string",
40             "key": "firstName",
41             "label": "First Name"
42           },
43           "preview": [
44             "John",
45             "Suzy",
46             "Joe"
47           ],
48           "metadata": {
49             "certainty": "absolute",
50             "confidence": 1,
51             "source": "exact"
52           }
53         },
54         {
55           "sourceField": {
56             "type": "string",
57             "key": "lastName"
58           },
59           "destinationField": {
60             "type": "string",
61             "key": "lastName",
62             "label": "Last Name"
63           },
64           "preview": [
65             "Smith",
66             "Que",
67             "Montana"
68           ],
69           "metadata": {
70             "certainty": "absolute",
71             "confidence": 1,
72             "source": "exact"
73           }
74         }
75       ],
76       "unmappedSourceFields": [],
77       "unmappedDestinationFields": []
78     }
79   }
80 }

Built with

1	curl https://api.x.flatfile.com/v1/jobs/us_jb_YOUR_ID/plan \
2	-H "X-Disable-Hooks: true" \
3	-H "Authorization: Bearer <token>"

1	{
2	"data": {
3	"job": {
4	"createdAt": "2023-10-30T20:04:28.556Z",
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	"plan": {
32	"fieldMapping": [
33	{
34	"sourceField": {
35	"type": "string",
36	"key": "firstName"
37	},
38	"destinationField": {
39	"type": "string",
40	"key": "firstName",
41	"label": "First Name"
42	},
43	"preview": [
44	"John",
45	"Suzy",
46	"Joe"
47	],
48	"metadata": {
49	"certainty": "absolute",
50	"confidence": 1,
51	"source": "exact"
52	}
53	},
54	{
55	"sourceField": {
56	"type": "string",
57	"key": "lastName"
58	},
59	"destinationField": {
60	"type": "string",
61	"key": "lastName",
62	"label": "Last Name"
63	},
64	"preview": [
65	"Smith",
66	"Que",
67	"Montana"
68	],
69	"metadata": {
70	"certainty": "absolute",
71	"confidence": 1,
72	"source": "exact"
73	}
74	}
75	],
76	"unmappedSourceFields": [],
77	"unmappedDestinationFields": []
78	}
79	}
80	}