Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP

Refine API

Tom Morris edited this page · 5 revisions
Clone this wiki locally

Refine API

This is a generic API reference for interacting with Refine's HTTP API.

NOTE: The internal client-server protocol used by Refine is not maintained as a stable external API, so use at your own risk.

When uploading files you will need to send the data as multipart/form-data, e.g.:

  Content-Disposition: form-data; name="project-file"; filename="operations.json"

  Content-Disposition: form-data; name="project-name"

  myproject

The other operations are just normal POST parameters

Create project:

POST /command/core/create-project-from-upload

multipart form-data:

  'project-file' : file contents...
  'project-name' : project name...

Returns new project ID and other metadata

Apply operations

POST /command/core/apply-operations

multipart form-data:

  'project' : project id...
  'operations' : file contents...

Returns JSON response

Export rows

POST /command/core/export-rows

  'engine' : JSON string... (e.g. '{"facets":[],"mode":"row-based"}')
  'project' : project id...
  'format' : format... (e.g 'tsv', 'csv')

Returns exported row data

Delete project

POST /command/core/delete-project

  'project' : project id...

Returns JSON response

Check status of async processes

POST /command/core/get-processes

  'project' : project id...

Returns JSON response

Get all project metadata:

Command: GET /command/core/get-all-project-metadata

Recovers the meta data for all projects. This includes the project's id, name, time of creation and last time of modification.

Response:

{
    "projects":{
        "[project_id]":{
            "name":"[project_name]",
            "created":"[project_creation_time]",
            "modified":"[project_modification_time]"
        },
        ...[More projects]...
    }
}

Expression Preview

Command: POST /command/core/preview-expression

Pass some expression (GREL or otherwise) to the server where it will be executed on selected columns and the result returned.

Parameters:

  • cellIndex: [column]
    The cell/column you wish to execute the expression on.
  • expression: [language]:[expression]
    The expression to execute. The language can either be grel, jython or clojure. Example: grel:value.toLowercase()
  • project: [project_id]
    The project id to execute the expression on.
  • repeat: [repeat]
    A boolean value (true/false) indicating whether or not this command should be repeated multiple times. A repeated command will be executed until the result of the current iteration equals the result of the previous iteration.
  • repeatCount: [repeatCount]
    The maximum amount of times a command will be repeated.

Response:

On success:

{
  "code": "ok",
  "results" : [result_array]
}

The result array will hold up to ten results, depending on how many rows there are in the project that was specified by the [project_id] parameter. Each result is the string that would be put in the cell if the GREL command was executed on that cell. Note that any expression that would return an array or JSon object will be jsonized, although the output can differ slightly from the jsonize() function.

On error:

{
  "code": "error",
  "type": "[error_type]",
  "message": "[error message]"
}
Something went wrong with that request. Please try again.