Preview a mutation | Flatfile

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

1 { 2 "data": [ 3 { 4 "id": "id", 5 "values": { 6 "values": { 7 "clipValue": "clipValue", 8 "layer": "layer", 9 "messages": [ 10 { 11 "field": "field", 12 "type": "error", 13 "source": "required-constraint", 14 "message": "message", 15 "path": "path" 16 }, 17 { 18 "field": "field", 19 "type": "error", 20 "source": "required-constraint", 21 "message": "message", 22 "path": "path" 23 } 24 ], 25 "snapshotValue": "snapshotValue", 26 "updatedAt": "2024-01-15T09:30:00Z", 27 "valid": true, 28 "value": "value", 29 "warning": true, 30 "warnings": [ 31 "warnings", 32 "warnings" 33 ], 34 "metadata": { 35 "metadata": { 36 "key": "value" 37 } 38 } 39 } 40 }, 41 "commitId": "commitId", 42 "config": { 43 "readonly": true, 44 "fields": { 45 "fields": { 46 "readonly": true 47 } 48 }, 49 "markedForDeletion": true 50 }, 51 "metadata": { 52 "metadata": { 53 "key": "value" 54 } 55 }, 56 "resolves": [ 57 { 58 "field": "field", 59 "type": "conflict", 60 "resolveTo": "clip", 61 "clip_value_reference": "clip_value_reference", 62 "main_value_reference": "main_value_reference", 63 "removedFromMainResolution": "ignore" 64 }, 65 { 66 "field": "field", 67 "type": "conflict", 68 "resolveTo": "clip", 69 "clip_value_reference": "clip_value_reference", 70 "main_value_reference": "main_value_reference", 71 "removedFromMainResolution": "ignore" 72 } 73 ], 74 "valid": true, 75 "messages": [ 76 { 77 "field": "field", 78 "type": "error", 79 "source": "required-constraint", 80 "message": "message", 81 "path": "path" 82 }, 83 { 84 "field": "field", 85 "type": "error", 86 "source": "required-constraint", 87 "message": "message", 88 "path": "path" 89 } 90 ], 91 "versionId": "versionId" 92 }, 93 { 94 "id": "id", 95 "values": { 96 "values": { 97 "clipValue": "clipValue", 98 "layer": "layer", 99 "messages": [ 100 { 101 "field": "field", 102 "type": "error", 103 "source": "required-constraint", 104 "message": "message", 105 "path": "path" 106 }, 107 { 108 "field": "field", 109 "type": "error", 110 "source": "required-constraint", 111 "message": "message", 112 "path": "path" 113 } 114 ], 115 "snapshotValue": "snapshotValue", 116 "updatedAt": "2024-01-15T09:30:00Z", 117 "valid": true, 118 "value": "value", 119 "warning": true, 120 "warnings": [ 121 "warnings", 122 "warnings" 123 ], 124 "metadata": { 125 "metadata": { 126 "key": "value" 127 } 128 } 129 } 130 }, 131 "commitId": "commitId", 132 "config": { 133 "readonly": true, 134 "fields": { 135 "fields": { 136 "readonly": true 137 } 138 }, 139 "markedForDeletion": true 140 }, 141 "metadata": { 142 "metadata": { 143 "key": "value" 144 } 145 }, 146 "resolves": [ 147 { 148 "field": "field", 149 "type": "conflict", 150 "resolveTo": "clip", 151 "clip_value_reference": "clip_value_reference", 152 "main_value_reference": "main_value_reference", 153 "removedFromMainResolution": "ignore" 154 }, 155 { 156 "field": "field", 157 "type": "conflict", 158 "resolveTo": "clip", 159 "clip_value_reference": "clip_value_reference", 160 "main_value_reference": "main_value_reference", 161 "removedFromMainResolution": "ignore" 162 } 163 ], 164 "valid": true, 165 "messages": [ 166 { 167 "field": "field", 168 "type": "error", 169 "source": "required-constraint", 170 "message": "message", 171 "path": "path" 172 }, 173 { 174 "field": "field", 175 "type": "error", 176 "source": "required-constraint", 177 "message": "message", 178 "path": "path" 179 } 180 ], 181 "versionId": "versionId" 182 } 183 ] 184 }

Preview the results of a mutation

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.

sheetIdstringRequired

Sheet ID

mutateRecordstringRequired

A JavaScript function that will be run on each record in the sheet, it should return a mutated record.

mutationIdstringOptional

If the mutation was generated through some sort of id-ed process, this links this job and that process.

snapshotLabelstringOptional

If specified, a snapshot will be generated with this label

snapshotIdstringOptional

The generated snapshotId will be stored here

filterenumOptional

Options to filter records

Allowed values:

filterFieldstringOptional

Use this to narrow the valid/error filter results to a specific field

searchValuestringOptional

Search for the given value, returning matching rows. For exact matches, wrap the value in double quotes (“Bob”). To search for null values, send empty double quotes ("")

searchFieldstringOptional

Use this to narrow the searchValue results to a specific field

qstringOptional

idslist of stringsOptional

The Record Ids param (ids) is a list of record ids that can be passed to several record endpoints allowing the user to identify specific records to INCLUDE in the query, or specific records to EXCLUDE, depending on whether or not filters are being applied. When passing a query param that filters the record dataset, such as ‘searchValue’, or a ‘filter’ of ‘valid’ | ‘error’ | ‘all’, the ‘ids’ param will EXCLUDE those records from the filtered results. For basic queries that do not filter the dataset, passing record ids in the ‘ids’ param will limit the dataset to INCLUDE just those specific records

The Record Ids param (ids) is a list of record ids that can be passed to several record endpoints allowing the user to identify specific records to INCLUDE in the query, or specific records to EXCLUDE, depending on whether or not filters are being applied. When passing a query param that filters the record dataset, such as 'searchValue', or a 'filter' of 'valid' | 'error' | 'all', the 'ids' param will EXCLUDE those records from the filtered results. For basic queries that do not filter the dataset, passing record ids in the 'ids' param will limit the dataset to INCLUDE just those specific records

Response

This endpoint returns an object.

datalist of objects

List of DiffRecord objects

Authentication

Headers

Request

Response