Jobs
Update a job's plan
PATCH
PATCH
$ 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": "string", > "jobId": "string" > }'
Response
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 "destination": "string", 11 "environmentId": "string", 12 "fileId": "string", 13 "finishedAt": "2023-01-01T00:00:00Z", 14 "info": "string", 15 "input": { 16 "string": {} 17 }, 18 "managed": true, 19 "mode": "foreground", 20 "outcome": { 21 "string": {} 22 }, 23 "outcomeAcknowledgedAt": "2023-01-01T00:00:00Z", 24 "parentId": "string", 25 "part": 0, 26 "partData": { 27 "string": {} 28 }, 29 "partExecution": "sequential", 30 "predecessorIds": [ 31 "string" 32 ], 33 "progress": 0, 34 "startedAt": "2023-01-01T00:00:00Z", 35 "status": "created", 36 "subject": { 37 "type": "resource", 38 "id": "string" 39 }, 40 "trigger": "manual", 41 "config": { 42 "filter": "valid", 43 "filterField": "string", 44 "searchValue": "string", 45 "searchField": "string", 46 "q": "string", 47 "sheet": "string", 48 "exceptions": [ 49 "string" 50 ] 51 } 52 }, 53 "plan": { 54 "fieldMapping": [ 55 { 56 "sourceField": { 57 "type": "string", 58 "key": "string", 59 "alternativeNames": [ 60 "string" 61 ], 62 "appearance": { 63 "size": "xs" 64 }, 65 "config": { 66 "size": "tiny" 67 }, 68 "constraints": [ 69 { 70 "type": "required" 71 } 72 ], 73 "description": "string", 74 "label": "string", 75 "metadata": {}, 76 "readonly": true, 77 "treatments": [ 78 "string" 79 ] 80 }, 81 "destinationField": { 82 "type": "string", 83 "key": "string", 84 "alternativeNames": [ 85 "string" 86 ], 87 "appearance": { 88 "size": "xs" 89 }, 90 "config": { 91 "size": "tiny" 92 }, 93 "constraints": [ 94 { 95 "type": "required" 96 } 97 ], 98 "description": "string", 99 "label": "string", 100 "metadata": {}, 101 "readonly": true, 102 "treatments": [ 103 "string" 104 ] 105 }, 106 "preview": [ 107 "string" 108 ], 109 "enumDetails": { 110 "mapping": [ 111 { 112 "sourceValue": "string", 113 "destinationValue": "string" 114 } 115 ], 116 "unusedSourceValues": [ 117 "string" 118 ], 119 "unusedDestinationValues": [ 120 "string" 121 ] 122 }, 123 "metadata": { 124 "certainty": "absolute", 125 "confidence": 1, 126 "source": "string" 127 } 128 } 129 ], 130 "unmappedSourceFields": [ 131 { 132 "sourceField": { 133 "type": "string", 134 "key": "string", 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 "preview": [ 158 "string" 159 ] 160 } 161 ], 162 "unmappedDestinationFields": [ 163 { 164 "destinationField": { 165 "type": "string", 166 "key": "string", 167 "alternativeNames": [ 168 "string" 169 ], 170 "appearance": { 171 "size": "xs" 172 }, 173 "config": { 174 "size": "tiny" 175 }, 176 "constraints": [ 177 { 178 "type": "required" 179 } 180 ], 181 "description": "string", 182 "label": "string", 183 "metadata": {}, 184 "readonly": true, 185 "treatments": [ 186 "string" 187 ] 188 }, 189 "preview": [ 190 "string" 191 ] 192 } 193 ], 194 "programId": "string" 195 } 196 } 197 }