Update a job’s plan

PATCH

1 from flatfile import Flatfile
2 
3 client = Flatfile(
4     token="YOUR_TOKEN",
5 )
6 client.jobs.update_execution_plan_fields(
7     job_id_="jobId",
8     file_id="fileId",
9     job_id="jobId",
10 )

Try it

200Updated

1 {
2   "data": {
3     "job": {
4       "createdAt": "2024-01-15T09:30:00Z",
5       "id": "id",
6       "updatedAt": "2024-01-15T09:30:00Z",
7       "finishedAt": "2024-01-15T09:30:00Z",
8       "outcomeAcknowledgedAt": "2024-01-15T09:30:00Z",
9       "startedAt": "2024-01-15T09:30:00Z"
10     },
11     "plan": {
12       "fieldMapping": [
13         {
14           "sourceField": {
15             "type": "string",
16             "config": {
17               "size": "tiny"
18             }
19           },
20           "destinationField": {
21             "type": "string",
22             "config": {
23               "size": "tiny"
24             }
25           },
26           "preview": [
27             "preview",
28             "preview"
29           ],
30           "enumDetails": {
31             "mapping": [
32               {},
33               {}
34             ],
35             "unusedSourceValues": [
36               "unusedSourceValues",
37               "unusedSourceValues"
38             ],
39             "unusedDestinationValues": [
40               "unusedDestinationValues",
41               "unusedDestinationValues"
42             ]
43           },
44           "metadata": {
45             "certainty": "absolute",
46             "confidence": 1.1,
47             "source": "source",
48             "detectedDelimiter": "detectedDelimiter"
49           }
50         },
51         {
52           "sourceField": {
53             "type": "string",
54             "config": {
55               "size": "tiny"
56             }
57           },
58           "destinationField": {
59             "type": "string",
60             "config": {
61               "size": "tiny"
62             }
63           },
64           "preview": [
65             "preview",
66             "preview"
67           ],
68           "enumDetails": {
69             "mapping": [
70               {},
71               {}
72             ],
73             "unusedSourceValues": [
74               "unusedSourceValues",
75               "unusedSourceValues"
76             ],
77             "unusedDestinationValues": [
78               "unusedDestinationValues",
79               "unusedDestinationValues"
80             ]
81           },
82           "metadata": {
83             "certainty": "absolute",
84             "confidence": 1.1,
85             "source": "source",
86             "detectedDelimiter": "detectedDelimiter"
87           }
88         }
89       ],
90       "unmappedSourceFields": [
91         {
92           "sourceField": {
93             "type": "string",
94             "config": {
95               "size": "tiny"
96             }
97           },
98           "preview": [
99             "preview",
100             "preview"
101           ]
102         },
103         {
104           "sourceField": {
105             "type": "string",
106             "config": {
107               "size": "tiny"
108             }
109           },
110           "preview": [
111             "preview",
112             "preview"
113           ]
114         }
115       ],
116       "unmappedDestinationFields": [
117         {
118           "destinationField": {
119             "type": "string",
120             "config": {
121               "size": "tiny"
122             }
123           },
124           "preview": [
125             "preview",
126             "preview"
127           ]
128         },
129         {
130           "destinationField": {
131             "type": "string",
132             "config": {
133               "size": "tiny"
134             }
135           },
136           "preview": [
137             "preview",
138             "preview"
139           ]
140         }
141       ],
142       "programId": "programId"
143     }
144   }
145 }

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

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

Path parameters

Headers

Request

Response