Tables/Write
Feature for writing data to a Factual table.
Requires a table key in the TABLE_KEY position of request url.
Basic Example
http://api.factual.com/v1/YOUR_API_KEY/tables/CIGf9f/write?subject_key=0QqxlMH8-ybQ3iVHy1oT9V-tN38&field=3231771&value=West+Covina
Feature Details
Parameters (inline mode)
| Parameter |
Description |
Requirements
|
Examples
|
Default
|
| data |
data payload |
can be a parsable string or file attachment (as in a multi-part form) |
Name, Address, Phone Number
Bob Smith, 123 Elm St, 800-555-1234
A zip file containing an Excel spreadsheet |
|
| source |
a citation or url identifying the source of the data |
|
http://en.wikipedia.org/wiki/Cy_Young_Award#Winners |
|
| field_mapping |
instructions for aligning the data to the fields in the table (optional if there is no ambiguity) |
in order of precedence:
a hash mapping field id to ordinal array
-or-
the pasted data/file should contain a header with field names matching the table field names
-or-
the pasted data/file should have the same number of columns as the target table
|
{"12":[0],"13":[1],"14":[2]} |
|
Parameters (url mode)
| Parameter |
Description |
Requirements
|
Examples
|
Default
|
| url |
data payload |
can be a parsable string or file attachment (as in a multi-part form) |
Name, Address, Phone Number
Bob Smith, 123 Elm St, 800-555-1234
A zip file containing an Excel spreadsheet |
|
| field_mapping |
instructions for aligning the data to the fields in the table (optional if there is no ambiguity) |
in order of precedence:
a hash mapping field id to ordinal array
-or-
the pasted data/file should contain a header with field names matching the table field names
-or-
the pasted data/file should have the same number of columns as the target table |
{"12":[0],"13":[1],"14":[2]} |
|
Parameters (cell mode)
| Parameter |
Description |
Requirements
|
Examples
|
Default
|
| subject_key |
string that uniquely identifies the row |
|
|
|
| field |
field id or name representing the column to which the value should be written; ambiguity will result in writing to the first matched field. |
must be a valid field id or an exact match for name; |
|
|
| value |
the value to be written to the cell |
must meet field requirements such as datatype, enumerations, etc. |
|
|
| comments |
comments to attach to the cell vote |
|
|
|
| source |
a citation or url identifying the source of the data |
must be a valid field id or an exact match for name; |
http://en.wikipedia.org/wiki/Cy_Young_Award#Winners |
|
Result payload
| Payload Field |
Description |
Examples
|
| write_successful |
boolean value representing the outcome of the write request |
true |
