OpenRefine icon

OpenRefine

OpenRefine is an open-source desktop application for data wrangling

Actions10

Project Models → Get

AI-generated

Overview

This node integrates with OpenRefine, an open-source data wrangling tool, allowing users to interact programmatically with OpenRefine projects and their models. Specifically, the "Project Models: Get" operation retrieves the data models (schemas) associated with a given OpenRefine project. This is useful for understanding the structure of the project's data, such as column definitions and types.

Practical scenarios include:

  • Automating workflows that require fetching the schema of a dataset managed in OpenRefine.
  • Integrating OpenRefine project metadata into other systems or dashboards.
  • Validating or documenting the structure of data before further processing.

Properties

Name Meaning
Server The URL of the OpenRefine server. Defaults to http://127.0.0.1:3333. Change if your server runs elsewhere.
Project ID The unique identifier of the OpenRefine project whose models you want to retrieve.

Output

The output is a JSON array where each item contains the models (schemas) of the specified OpenRefine project. The structure typically includes details about columns and their properties within the project.

Example output structure (simplified):

{
  "columnModel": {
    "columns": [
      {
        "name": "ColumnName",
        "type": "ColumnType",
        ...
      },
      ...
    ]
  }
}

No binary data is produced by this operation.

Dependencies

  • Requires access to a running OpenRefine server.
  • The node fetches a CSRF token from the server to authenticate requests.
  • No special API keys or credentials are required beyond access to the OpenRefine instance.
  • The server URL must be correctly configured in the "Server" property.

Troubleshooting

  • Connection errors: Ensure the OpenRefine server URL is correct and the server is running and accessible.
  • Invalid Project ID: If the project ID does not exist or is incorrect, the request will fail. Verify the project ID in OpenRefine.
  • CSRF token errors: The node fetches a CSRF token before making requests. If the server configuration changes or tokens expire, re-authenticate or restart the server.
  • Unexpected response format: If OpenRefine updates its API, the node might receive unexpected data. Check OpenRefine version compatibility.

Links and References

Discussion