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"RequiredDefaults to true

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           }
276         }
277       ],
278       "unmappedSourceFields": [
279         {
280           "sourceField": {
281             "type": "string",
282             "key": "string",
283             "actions": [
284               {
285                 "label": "string",
286                 "confirm": true,
287                 "constraints": [
288                   {
289                     "type": "hasAllValid",
290                     "ignoreSelection": true
291                   }
292                 ],
293                 "description": "string",
294                 "guardrail": {
295                   "content": "string"
296                 },
297                 "guide": {
298                   "content": "string"
299                 },
300                 "icon": "string",
301                 "inputForm": {
302                   "type": "simple",
303                   "fields": [
304                     {
305                       "key": "string",
306                       "label": "string",
307                       "type": "string",
308                       "description": "string",
309                       "defaultValue": {},
310                       "config": {
311                         "options": [
312                           {
313                             "value": {},
314                             "label": "string",
315                             "description": "string",
316                             "color": "string",
317                             "icon": "string",
318                             "meta": {
319                               "string": {}
320                             }
321                           }
322                         ]
323                       },
324                       "constraints": [
325                         {
326                           "type": "required"
327                         }
328                       ]
329                     }
330                   ]
331                 },
332                 "messages": [
333                   {
334                     "type": "error",
335                     "content": "string"
336                   }
337                 ],
338                 "mode": "foreground",
339                 "mount": {
340                   "type": "sheet",
341                   "slugs": [
342                     "string"
343                   ]
344                 },
345                 "operation": "string",
346                 "primary": true,
347                 "schedule": "weekly",
348                 "tooltip": "string",
349                 "type": "string",
350                 "requireAllValid": true,
351                 "requireSelection": true,
352                 "slug": "string"
353               }
354             ],
355             "alternativeNames": [
356               "string"
357             ],
358             "appearance": {
359               "size": "xs"
360             },
361             "config": {
362               "size": "tiny"
363             },
364             "constraints": [
365               {
366                 "type": "required"
367               }
368             ],
369             "description": "string",
370             "label": "string",
371             "metadata": {},
372             "readonly": true,
373             "treatments": [
374               "string"
375             ]
376           },
377           "preview": [
378             "string"
379           ]
380         }
381       ],
382       "unmappedDestinationFields": [
383         {
384           "destinationField": {
385             "type": "string",
386             "key": "string",
387             "actions": [
388               {
389                 "label": "string",
390                 "confirm": true,
391                 "constraints": [
392                   {
393                     "type": "hasAllValid",
394                     "ignoreSelection": true
395                   }
396                 ],
397                 "description": "string",
398                 "guardrail": {
399                   "content": "string"
400                 },
401                 "guide": {
402                   "content": "string"
403                 },
404                 "icon": "string",
405                 "inputForm": {
406                   "type": "simple",
407                   "fields": [
408                     {
409                       "key": "string",
410                       "label": "string",
411                       "type": "string",
412                       "description": "string",
413                       "defaultValue": {},
414                       "config": {
415                         "options": [
416                           {
417                             "value": {},
418                             "label": "string",
419                             "description": "string",
420                             "color": "string",
421                             "icon": "string",
422                             "meta": {
423                               "string": {}
424                             }
425                           }
426                         ]
427                       },
428                       "constraints": [
429                         {
430                           "type": "required"
431                         }
432                       ]
433                     }
434                   ]
435                 },
436                 "messages": [
437                   {
438                     "type": "error",
439                     "content": "string"
440                   }
441                 ],
442                 "mode": "foreground",
443                 "mount": {
444                   "type": "sheet",
445                   "slugs": [
446                     "string"
447                   ]
448                 },
449                 "operation": "string",
450                 "primary": true,
451                 "schedule": "weekly",
452                 "tooltip": "string",
453                 "type": "string",
454                 "requireAllValid": true,
455                 "requireSelection": true,
456                 "slug": "string"
457               }
458             ],
459             "alternativeNames": [
460               "string"
461             ],
462             "appearance": {
463               "size": "xs"
464             },
465             "config": {
466               "size": "tiny"
467             },
468             "constraints": [
469               {
470                 "type": "required"
471               }
472             ],
473             "description": "string",
474             "label": "string",
475             "metadata": {},
476             "readonly": true,
477             "treatments": [
478               "string"
479             ]
480           },
481           "preview": [
482             "string"
483           ]
484         }
485       ],
486       "programId": "string"
487     }
488   }
489 }

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	}
276	}
277	],
278	"unmappedSourceFields": [
279	{
280	"sourceField": {
281	"type": "string",
282	"key": "string",
283	"actions": [
284	{
285	"label": "string",
286	"confirm": true,
287	"constraints": [
288	{
289	"type": "hasAllValid",
290	"ignoreSelection": true
291	}
292	],
293	"description": "string",
294	"guardrail": {
295	"content": "string"
296	},
297	"guide": {
298	"content": "string"
299	},
300	"icon": "string",
301	"inputForm": {
302	"type": "simple",
303	"fields": [
304	{
305	"key": "string",
306	"label": "string",
307	"type": "string",
308	"description": "string",
309	"defaultValue": {},
310	"config": {
311	"options": [
312	{
313	"value": {},
314	"label": "string",
315	"description": "string",
316	"color": "string",
317	"icon": "string",
318	"meta": {
319	"string": {}
320	}
321	}
322	]
323	},
324	"constraints": [
325	{
326	"type": "required"
327	}
328	]
329	}
330	]
331	},
332	"messages": [
333	{
334	"type": "error",
335	"content": "string"
336	}
337	],
338	"mode": "foreground",
339	"mount": {
340	"type": "sheet",
341	"slugs": [
342	"string"
343	]
344	},
345	"operation": "string",
346	"primary": true,
347	"schedule": "weekly",
348	"tooltip": "string",
349	"type": "string",
350	"requireAllValid": true,
351	"requireSelection": true,
352	"slug": "string"
353	}
354	],
355	"alternativeNames": [
356	"string"
357	],
358	"appearance": {
359	"size": "xs"
360	},
361	"config": {
362	"size": "tiny"
363	},
364	"constraints": [
365	{
366	"type": "required"
367	}
368	],
369	"description": "string",
370	"label": "string",
371	"metadata": {},
372	"readonly": true,
373	"treatments": [
374	"string"
375	]
376	},
377	"preview": [
378	"string"
379	]
380	}
381	],
382	"unmappedDestinationFields": [
383	{
384	"destinationField": {
385	"type": "string",
386	"key": "string",
387	"actions": [
388	{
389	"label": "string",
390	"confirm": true,
391	"constraints": [
392	{
393	"type": "hasAllValid",
394	"ignoreSelection": true
395	}
396	],
397	"description": "string",
398	"guardrail": {
399	"content": "string"
400	},
401	"guide": {
402	"content": "string"
403	},
404	"icon": "string",
405	"inputForm": {
406	"type": "simple",
407	"fields": [
408	{
409	"key": "string",
410	"label": "string",
411	"type": "string",
412	"description": "string",
413	"defaultValue": {},
414	"config": {
415	"options": [
416	{
417	"value": {},
418	"label": "string",
419	"description": "string",
420	"color": "string",
421	"icon": "string",
422	"meta": {
423	"string": {}
424	}
425	}
426	]
427	},
428	"constraints": [
429	{
430	"type": "required"
431	}
432	]
433	}
434	]
435	},
436	"messages": [
437	{
438	"type": "error",
439	"content": "string"
440	}
441	],
442	"mode": "foreground",
443	"mount": {
444	"type": "sheet",
445	"slugs": [
446	"string"
447	]
448	},
449	"operation": "string",
450	"primary": true,
451	"schedule": "weekly",
452	"tooltip": "string",
453	"type": "string",
454	"requireAllValid": true,
455	"requireSelection": true,
456	"slug": "string"
457	}
458	],
459	"alternativeNames": [
460	"string"
461	],
462	"appearance": {
463	"size": "xs"
464	},
465	"config": {
466	"size": "tiny"
467	},
468	"constraints": [
469	{
470	"type": "required"
471	}
472	],
473	"description": "string",
474	"label": "string",
475	"metadata": {},
476	"readonly": true,
477	"treatments": [
478	"string"
479	]
480	},
481	"preview": [
482	"string"
483	]
484	}
485	],
486	"programId": "string"
487	}
488	}
489	}