Replace a job’s plan

PUT

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

PUT

/v1/jobs/:jobId/plan

1 curl -X PUT https://api.x.flatfile.com/v1/jobs/us_jb_YOUR_ID/plan \
2      -H "X-Disable-Hooks: true" \
3      -H "Authorization: Bearer <token>" \
4      -H "Content-Type: application/json" \
5      -d '{
6   "fieldMapping": [
7     {
8       "sourceField": {
9         "type": "string",
10         "key": "firstName"
11       },
12       "destinationField": {
13         "type": "string",
14         "key": "firstName",
15         "label": "First Name"
16       }
17     },
18     {
19       "sourceField": {
20         "type": "string",
21         "key": "lastName"
22       },
23       "destinationField": {
24         "type": "string",
25         "key": "lastName",
26         "label": "Last Name"
27       }
28     }
29   ],
30   "fileId": "us_fl_YOUR_ID",
31   "jobId": "us_jb_YOUR_ID",
32   "unmappedDestinationFields": [
33     {
34       "destinationField": {
35         "type": "string",
36         "key": "email",
37         "label": "Email"
38       }
39     }
40   ],
41   "unmappedSourceFields": [
42     {
43       "sourceField": {
44         "type": "string",
45         "key": "email"
46       }
47     }
48   ]
49 }'

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 }

Update a job’s entire execution plan

Path parameters

jobIdstringRequired

ID of job to return

Request

This endpoint expects an object.

fieldMappinglist of objectsRequired

fileIdstringRequired

File ID

jobIdstringRequired

Pipeline Job ID

unmappedDestinationFieldslist of objectsRequired

unmappedSourceFieldslist of objectsRequired

programIdstringOptional

Response

This endpoint returns an object.

dataobject

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

Path parameters

Headers

Request

Response