Update a job's plan

PATCH

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

PATCH

/v1/jobs/:jobId/plan

$ curl -X PATCH https://api.x.flatfile.com/v1/jobs/jobId/plan \
>      -H "X-Disable-Hooks: true" \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "fileId": "fileId",
>   "jobId": "jobId"
> }'

200Updated

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

Update one or more individual fields on a 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

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

Update a job's plan

Authentication

Path parameters

Headers

Request

Response

Authentication

Path parameters

Headers

Request

Response