From 7b080fe99d4dc779d5581f474c1b0c60e7882112 Mon Sep 17 00:00:00 2001 From: Rajaram Date: Wed, 27 Jan 2021 09:19:44 +0100 Subject: [PATCH] Update openrefine-api.md (#3159) * Update openrefine-api.md Documentation for Create project and Export rows API calls modified * Update docs/docs/technical-reference/openrefine-api.md Co-authored-by: Tom Morris Co-authored-by: Tom Morris --- docs/docs/technical-reference/openrefine-api.md | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/docs/docs/technical-reference/openrefine-api.md b/docs/docs/technical-reference/openrefine-api.md index 5b5ba5c9d..9953f1a89 100644 --- a/docs/docs/technical-reference/openrefine-api.md +++ b/docs/docs/technical-reference/openrefine-api.md @@ -17,7 +17,7 @@ multipart form-data: 'project-file' : file contents 'project-name' : project name 'format' : format of data in project-file (e.g. 'text/line-based/*sv') [optional] - 'options' : json object containing options relevant to the file format [optional] + 'options' : json object containing options relevant to the file format [optional - however, some importers may have required options, such as `recordPath` for the JSON & XML importers]. The formats supported will depend on the version of OpenRefine you are using and any Extensions you have installed. The common formats include: @@ -159,9 +159,14 @@ On success returns JSON response > **Command:** _POST /command/core/export-rows_ - 'project' : project id - 'engine' : JSON string... (e.g. '{"facets":[],"mode":"row-based"}') +In the parameter + + 'project' : project id 'format' : format... (e.g 'tsv', 'csv') + +In the form data + + 'engine' : JSON string... (e.g. '{"facets":[],"mode":"row-based"}') Returns exported row data in the specified format. The formats supported will depend on the version of OpenRefine you are using and any Extensions you have installed. The common formats include: