Update a job's plan

PATCH

Update one or more individual fields on a job’s execution plan

Path parameters

jobIdstringRequired

ID of job to return

Headers

X-Disable-Hooks"true"Required

Request

This endpoint expects an object.

fileIdstringRequired

File ID

jobIdstringRequired

Pipeline Job ID

fieldMappinglist of objectsOptional

programIdstringOptional

unmappedDestinationFieldslist of objectsOptional

unmappedSourceFieldslist of objectsOptional

Response

This endpoint returns an object.

dataobject

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

PATCH

1 curl -X PATCH https://api.x.flatfile.com/v1/jobs/:jobId/plan \
2      -H "X-Disable-Hooks: true" \
3      -H "Authorization: Bearer <token>" \
4      -H "Content-Type: application/json" \
5      -d '{
6   "fileId": "string",
7   "jobId": "string"
8 }'

200Updated

1 {
2   "data": {
3     "job": {
4       "createdAt": "2023-01-01T00:00:00Z",
5       "id": "string",
6       "operation": "string",
7       "source": "string",
8       "type": "file",
9       "updatedAt": "2023-01-01T00:00:00Z",
10       "config": {
11         "filter": "valid",
12         "filterField": "string",
13         "searchValue": "string",
14         "searchField": "string",
15         "q": "string",
16         "sheet": "string",
17         "exceptions": [
18           "string"
19         ],
20         "snapshotLabel": "string"
21       },
22       "destination": "string",
23       "environmentId": "string",
24       "fileId": "string",
25       "finishedAt": "2023-01-01T00:00:00Z",
26       "info": "string",
27       "input": {
28         "string": {}
29       },
30       "managed": true,
31       "metadata": {
32         "string": {}
33       },
34       "mode": "foreground",
35       "outcome": {
36         "string": {}
37       },
38       "outcomeAcknowledgedAt": "2023-01-01T00:00:00Z",
39       "parentId": "string",
40       "part": 0,
41       "partData": {
42         "string": {}
43       },
44       "partExecution": "sequential",
45       "predecessorIds": [
46         "string"
47       ],
48       "progress": 0,
49       "startedAt": "2023-01-01T00:00:00Z",
50       "status": "created",
51       "subject": {
52         "type": "resource",
53         "id": "string"
54       },
55       "trigger": "manual"
56     },
57     "plan": {
58       "fieldMapping": [
59         {
60           "sourceField": {
61             "type": "string",
62             "key": "string",
63             "actions": [
64               {
65                 "label": "string",
66                 "confirm": true,
67                 "constraints": [
68                   {
69                     "type": "hasAllValid",
70                     "ignoreSelection": true
71                   }
72                 ],
73                 "description": "string",
74                 "guardrail": {
75                   "content": "string"
76                 },
77                 "guide": {
78                   "content": "string"
79                 },
80                 "icon": "string",
81                 "inputForm": {
82                   "type": "simple",
83                   "fields": [
84                     {
85                       "key": "string",
86                       "label": "string",
87                       "type": "string",
88                       "description": "string",
89                       "defaultValue": {},
90                       "config": {
91                         "options": [
92                           {
93                             "value": {},
94                             "label": "string",
95                             "description": "string",
96                             "color": "string",
97                             "icon": "string",
98                             "meta": {
99                               "string": {}
100                             }
101                           }
102                         ]
103                       },
104                       "constraints": [
105                         {
106                           "type": "required"
107                         }
108                       ]
109                     }
110                   ]
111                 },
112                 "messages": [
113                   {
114                     "type": "error",
115                     "content": "string"
116                   }
117                 ],
118                 "mode": "foreground",
119                 "mount": {
120                   "type": "sheet",
121                   "slugs": [
122                     "string"
123                   ]
124                 },
125                 "operation": "string",
126                 "primary": true,
127                 "schedule": "weekly",
128                 "tooltip": "string",
129                 "type": "string",
130                 "requireAllValid": true,
131                 "requireSelection": true,
132                 "slug": "string"
133               }
134             ],
135             "alternativeNames": [
136               "string"
137             ],
138             "appearance": {
139               "size": "xs"
140             },
141             "config": {
142               "size": "tiny"
143             },
144             "constraints": [
145               {
146                 "type": "required"
147               }
148             ],
149             "description": "string",
150             "label": "string",
151             "metadata": {},
152             "readonly": true,
153             "treatments": [
154               "string"
155             ]
156           },
157           "destinationField": {
158             "type": "string",
159             "key": "string",
160             "actions": [
161               {
162                 "label": "string",
163                 "confirm": true,
164                 "constraints": [
165                   {
166                     "type": "hasAllValid",
167                     "ignoreSelection": true
168                   }
169                 ],
170                 "description": "string",
171                 "guardrail": {
172                   "content": "string"
173                 },
174                 "guide": {
175                   "content": "string"
176                 },
177                 "icon": "string",
178                 "inputForm": {
179                   "type": "simple",
180                   "fields": [
181                     {
182                       "key": "string",
183                       "label": "string",
184                       "type": "string",
185                       "description": "string",
186                       "defaultValue": {},
187                       "config": {
188                         "options": [
189                           {
190                             "value": {},
191                             "label": "string",
192                             "description": "string",
193                             "color": "string",
194                             "icon": "string",
195                             "meta": {
196                               "string": {}
197                             }
198                           }
199                         ]
200                       },
201                       "constraints": [
202                         {
203                           "type": "required"
204                         }
205                       ]
206                     }
207                   ]
208                 },
209                 "messages": [
210                   {
211                     "type": "error",
212                     "content": "string"
213                   }
214                 ],
215                 "mode": "foreground",
216                 "mount": {
217                   "type": "sheet",
218                   "slugs": [
219                     "string"
220                   ]
221                 },
222                 "operation": "string",
223                 "primary": true,
224                 "schedule": "weekly",
225                 "tooltip": "string",
226                 "type": "string",
227                 "requireAllValid": true,
228                 "requireSelection": true,
229                 "slug": "string"
230               }
231             ],
232             "alternativeNames": [
233               "string"
234             ],
235             "appearance": {
236               "size": "xs"
237             },
238             "config": {
239               "size": "tiny"
240             },
241             "constraints": [
242               {
243                 "type": "required"
244               }
245             ],
246             "description": "string",
247             "label": "string",
248             "metadata": {},
249             "readonly": true,
250             "treatments": [
251               "string"
252             ]
253           },
254           "preview": [
255             "string"
256           ],
257           "enumDetails": {
258             "mapping": [
259               {
260                 "sourceValue": "string",
261                 "destinationValue": "string"
262               }
263             ],
264             "unusedSourceValues": [
265               "string"
266             ],
267             "unusedDestinationValues": [
268               "string"
269             ]
270           },
271           "metadata": {
272             "certainty": "absolute",
273             "confidence": 1,
274             "source": "string",
275             "detectedDelimiter": "string"
276           }
277         }
278       ],
279       "unmappedSourceFields": [
280         {
281           "sourceField": {
282             "type": "string",
283             "key": "string",
284             "actions": [
285               {
286                 "label": "string",
287                 "confirm": true,
288                 "constraints": [
289                   {
290                     "type": "hasAllValid",
291                     "ignoreSelection": true
292                   }
293                 ],
294                 "description": "string",
295                 "guardrail": {
296                   "content": "string"
297                 },
298                 "guide": {
299                   "content": "string"
300                 },
301                 "icon": "string",
302                 "inputForm": {
303                   "type": "simple",
304                   "fields": [
305                     {
306                       "key": "string",
307                       "label": "string",
308                       "type": "string",
309                       "description": "string",
310                       "defaultValue": {},
311                       "config": {
312                         "options": [
313                           {
314                             "value": {},
315                             "label": "string",
316                             "description": "string",
317                             "color": "string",
318                             "icon": "string",
319                             "meta": {
320                               "string": {}
321                             }
322                           }
323                         ]
324                       },
325                       "constraints": [
326                         {
327                           "type": "required"
328                         }
329                       ]
330                     }
331                   ]
332                 },
333                 "messages": [
334                   {
335                     "type": "error",
336                     "content": "string"
337                   }
338                 ],
339                 "mode": "foreground",
340                 "mount": {
341                   "type": "sheet",
342                   "slugs": [
343                     "string"
344                   ]
345                 },
346                 "operation": "string",
347                 "primary": true,
348                 "schedule": "weekly",
349                 "tooltip": "string",
350                 "type": "string",
351                 "requireAllValid": true,
352                 "requireSelection": true,
353                 "slug": "string"
354               }
355             ],
356             "alternativeNames": [
357               "string"
358             ],
359             "appearance": {
360               "size": "xs"
361             },
362             "config": {
363               "size": "tiny"
364             },
365             "constraints": [
366               {
367                 "type": "required"
368               }
369             ],
370             "description": "string",
371             "label": "string",
372             "metadata": {},
373             "readonly": true,
374             "treatments": [
375               "string"
376             ]
377           },
378           "preview": [
379             "string"
380           ]
381         }
382       ],
383       "unmappedDestinationFields": [
384         {
385           "destinationField": {
386             "type": "string",
387             "key": "string",
388             "actions": [
389               {
390                 "label": "string",
391                 "confirm": true,
392                 "constraints": [
393                   {
394                     "type": "hasAllValid",
395                     "ignoreSelection": true
396                   }
397                 ],
398                 "description": "string",
399                 "guardrail": {
400                   "content": "string"
401                 },
402                 "guide": {
403                   "content": "string"
404                 },
405                 "icon": "string",
406                 "inputForm": {
407                   "type": "simple",
408                   "fields": [
409                     {
410                       "key": "string",
411                       "label": "string",
412                       "type": "string",
413                       "description": "string",
414                       "defaultValue": {},
415                       "config": {
416                         "options": [
417                           {
418                             "value": {},
419                             "label": "string",
420                             "description": "string",
421                             "color": "string",
422                             "icon": "string",
423                             "meta": {
424                               "string": {}
425                             }
426                           }
427                         ]
428                       },
429                       "constraints": [
430                         {
431                           "type": "required"
432                         }
433                       ]
434                     }
435                   ]
436                 },
437                 "messages": [
438                   {
439                     "type": "error",
440                     "content": "string"
441                   }
442                 ],
443                 "mode": "foreground",
444                 "mount": {
445                   "type": "sheet",
446                   "slugs": [
447                     "string"
448                   ]
449                 },
450                 "operation": "string",
451                 "primary": true,
452                 "schedule": "weekly",
453                 "tooltip": "string",
454                 "type": "string",
455                 "requireAllValid": true,
456                 "requireSelection": true,
457                 "slug": "string"
458               }
459             ],
460             "alternativeNames": [
461               "string"
462             ],
463             "appearance": {
464               "size": "xs"
465             },
466             "config": {
467               "size": "tiny"
468             },
469             "constraints": [
470               {
471                 "type": "required"
472               }
473             ],
474             "description": "string",
475             "label": "string",
476             "metadata": {},
477             "readonly": true,
478             "treatments": [
479               "string"
480             ]
481           },
482           "preview": [
483             "string"
484           ]
485         }
486       ],
487       "programId": "string"
488     }
489   }
490 }

Built with

1	curl -X PATCH https://api.x.flatfile.com/v1/jobs/:jobId/plan \
2	-H "X-Disable-Hooks: true" \
3	-H "Authorization: Bearer <token>" \
4	-H "Content-Type: application/json" \
5	-d '{
6	"fileId": "string",
7	"jobId": "string"
8	}'

1	{
2	"data": {
3	"job": {
4	"createdAt": "2023-01-01T00:00:00Z",
5	"id": "string",
6	"operation": "string",
7	"source": "string",
8	"type": "file",
9	"updatedAt": "2023-01-01T00:00:00Z",
10	"config": {
11	"filter": "valid",
12	"filterField": "string",
13	"searchValue": "string",
14	"searchField": "string",
15	"q": "string",
16	"sheet": "string",
17	"exceptions": [
18	"string"
19	],
20	"snapshotLabel": "string"
21	},
22	"destination": "string",
23	"environmentId": "string",
24	"fileId": "string",
25	"finishedAt": "2023-01-01T00:00:00Z",
26	"info": "string",
27	"input": {
28	"string": {}
29	},
30	"managed": true,
31	"metadata": {
32	"string": {}
33	},
34	"mode": "foreground",
35	"outcome": {
36	"string": {}
37	},
38	"outcomeAcknowledgedAt": "2023-01-01T00:00:00Z",
39	"parentId": "string",
40	"part": 0,
41	"partData": {
42	"string": {}
43	},
44	"partExecution": "sequential",
45	"predecessorIds": [
46	"string"
47	],
48	"progress": 0,
49	"startedAt": "2023-01-01T00:00:00Z",
50	"status": "created",
51	"subject": {
52	"type": "resource",
53	"id": "string"
54	},
55	"trigger": "manual"
56	},
57	"plan": {
58	"fieldMapping": [
59	{
60	"sourceField": {
61	"type": "string",
62	"key": "string",
63	"actions": [
64	{
65	"label": "string",
66	"confirm": true,
67	"constraints": [
68	{
69	"type": "hasAllValid",
70	"ignoreSelection": true
71	}
72	],
73	"description": "string",
74	"guardrail": {
75	"content": "string"
76	},
77	"guide": {
78	"content": "string"
79	},
80	"icon": "string",
81	"inputForm": {
82	"type": "simple",
83	"fields": [
84	{
85	"key": "string",
86	"label": "string",
87	"type": "string",
88	"description": "string",
89	"defaultValue": {},
90	"config": {
91	"options": [
92	{
93	"value": {},
94	"label": "string",
95	"description": "string",
96	"color": "string",
97	"icon": "string",
98	"meta": {
99	"string": {}
100	}
101	}
102	]
103	},
104	"constraints": [
105	{
106	"type": "required"
107	}
108	]
109	}
110	]
111	},
112	"messages": [
113	{
114	"type": "error",
115	"content": "string"
116	}
117	],
118	"mode": "foreground",
119	"mount": {
120	"type": "sheet",
121	"slugs": [
122	"string"
123	]
124	},
125	"operation": "string",
126	"primary": true,
127	"schedule": "weekly",
128	"tooltip": "string",
129	"type": "string",
130	"requireAllValid": true,
131	"requireSelection": true,
132	"slug": "string"
133	}
134	],
135	"alternativeNames": [
136	"string"
137	],
138	"appearance": {
139	"size": "xs"
140	},
141	"config": {
142	"size": "tiny"
143	},
144	"constraints": [
145	{
146	"type": "required"
147	}
148	],
149	"description": "string",
150	"label": "string",
151	"metadata": {},
152	"readonly": true,
153	"treatments": [
154	"string"
155	]
156	},
157	"destinationField": {
158	"type": "string",
159	"key": "string",
160	"actions": [
161	{
162	"label": "string",
163	"confirm": true,
164	"constraints": [
165	{
166	"type": "hasAllValid",
167	"ignoreSelection": true
168	}
169	],
170	"description": "string",
171	"guardrail": {
172	"content": "string"
173	},
174	"guide": {
175	"content": "string"
176	},
177	"icon": "string",
178	"inputForm": {
179	"type": "simple",
180	"fields": [
181	{
182	"key": "string",
183	"label": "string",
184	"type": "string",
185	"description": "string",
186	"defaultValue": {},
187	"config": {
188	"options": [
189	{
190	"value": {},
191	"label": "string",
192	"description": "string",
193	"color": "string",
194	"icon": "string",
195	"meta": {
196	"string": {}
197	}
198	}
199	]
200	},
201	"constraints": [
202	{
203	"type": "required"
204	}
205	]
206	}
207	]
208	},
209	"messages": [
210	{
211	"type": "error",
212	"content": "string"
213	}
214	],
215	"mode": "foreground",
216	"mount": {
217	"type": "sheet",
218	"slugs": [
219	"string"
220	]
221	},
222	"operation": "string",
223	"primary": true,
224	"schedule": "weekly",
225	"tooltip": "string",
226	"type": "string",
227	"requireAllValid": true,
228	"requireSelection": true,
229	"slug": "string"
230	}
231	],
232	"alternativeNames": [
233	"string"
234	],
235	"appearance": {
236	"size": "xs"
237	},
238	"config": {
239	"size": "tiny"
240	},
241	"constraints": [
242	{
243	"type": "required"
244	}
245	],
246	"description": "string",
247	"label": "string",
248	"metadata": {},
249	"readonly": true,
250	"treatments": [
251	"string"
252	]
253	},
254	"preview": [
255	"string"
256	],
257	"enumDetails": {
258	"mapping": [
259	{
260	"sourceValue": "string",
261	"destinationValue": "string"
262	}
263	],
264	"unusedSourceValues": [
265	"string"
266	],
267	"unusedDestinationValues": [
268	"string"
269	]
270	},
271	"metadata": {
272	"certainty": "absolute",
273	"confidence": 1,
274	"source": "string",
275	"detectedDelimiter": "string"
276	}
277	}
278	],
279	"unmappedSourceFields": [
280	{
281	"sourceField": {
282	"type": "string",
283	"key": "string",
284	"actions": [
285	{
286	"label": "string",
287	"confirm": true,
288	"constraints": [
289	{
290	"type": "hasAllValid",
291	"ignoreSelection": true
292	}
293	],
294	"description": "string",
295	"guardrail": {
296	"content": "string"
297	},
298	"guide": {
299	"content": "string"
300	},
301	"icon": "string",
302	"inputForm": {
303	"type": "simple",
304	"fields": [
305	{
306	"key": "string",
307	"label": "string",
308	"type": "string",
309	"description": "string",
310	"defaultValue": {},
311	"config": {
312	"options": [
313	{
314	"value": {},
315	"label": "string",
316	"description": "string",
317	"color": "string",
318	"icon": "string",
319	"meta": {
320	"string": {}
321	}
322	}
323	]
324	},
325	"constraints": [
326	{
327	"type": "required"
328	}
329	]
330	}
331	]
332	},
333	"messages": [
334	{
335	"type": "error",
336	"content": "string"
337	}
338	],
339	"mode": "foreground",
340	"mount": {
341	"type": "sheet",
342	"slugs": [
343	"string"
344	]
345	},
346	"operation": "string",
347	"primary": true,
348	"schedule": "weekly",
349	"tooltip": "string",
350	"type": "string",
351	"requireAllValid": true,
352	"requireSelection": true,
353	"slug": "string"
354	}
355	],
356	"alternativeNames": [
357	"string"
358	],
359	"appearance": {
360	"size": "xs"
361	},
362	"config": {
363	"size": "tiny"
364	},
365	"constraints": [
366	{
367	"type": "required"
368	}
369	],
370	"description": "string",
371	"label": "string",
372	"metadata": {},
373	"readonly": true,
374	"treatments": [
375	"string"
376	]
377	},
378	"preview": [
379	"string"
380	]
381	}
382	],
383	"unmappedDestinationFields": [
384	{
385	"destinationField": {
386	"type": "string",
387	"key": "string",
388	"actions": [
389	{
390	"label": "string",
391	"confirm": true,
392	"constraints": [
393	{
394	"type": "hasAllValid",
395	"ignoreSelection": true
396	}
397	],
398	"description": "string",
399	"guardrail": {
400	"content": "string"
401	},
402	"guide": {
403	"content": "string"
404	},
405	"icon": "string",
406	"inputForm": {
407	"type": "simple",
408	"fields": [
409	{
410	"key": "string",
411	"label": "string",
412	"type": "string",
413	"description": "string",
414	"defaultValue": {},
415	"config": {
416	"options": [
417	{
418	"value": {},
419	"label": "string",
420	"description": "string",
421	"color": "string",
422	"icon": "string",
423	"meta": {
424	"string": {}
425	}
426	}
427	]
428	},
429	"constraints": [
430	{
431	"type": "required"
432	}
433	]
434	}
435	]
436	},
437	"messages": [
438	{
439	"type": "error",
440	"content": "string"
441	}
442	],
443	"mode": "foreground",
444	"mount": {
445	"type": "sheet",
446	"slugs": [
447	"string"
448	]
449	},
450	"operation": "string",
451	"primary": true,
452	"schedule": "weekly",
453	"tooltip": "string",
454	"type": "string",
455	"requireAllValid": true,
456	"requireSelection": true,
457	"slug": "string"
458	}
459	],
460	"alternativeNames": [
461	"string"
462	],
463	"appearance": {
464	"size": "xs"
465	},
466	"config": {
467	"size": "tiny"
468	},
469	"constraints": [
470	{
471	"type": "required"
472	}
473	],
474	"description": "string",
475	"label": "string",
476	"metadata": {},
477	"readonly": true,
478	"treatments": [
479	"string"
480	]
481	},
482	"preview": [
483	"string"
484	]
485	}
486	],
487	"programId": "string"
488	}
489	}
490	}