Stable URLs for datasets
This page is for website creators, editors and administrators who publish data that other people will link to, download by script or cite. Re-users build on your addresses; a broken one breaks their work. The facts about aliases and redirects come from Redirects and moved content and URL aliases and nice URLs.
Contents
- The addresses a dataset has
- What Exponential keeps working
- What breaks an address
- Rules for the data team
- A short, permanent address per dataset
- Checking addresses
The addresses a dataset has
| Address | Example | Stable while |
|---|---|---|
| URL alias of the page | /Open-data/Street-lighting-requests | the node exists; old aliases redirect after a rename or move |
| System address of the node | /content/view/full/<node ID> | the node exists |
| Download of a file | /content/download/<object ID>/<attribute ID>/file/<file name> | the object exists and the file name stays |
| Feed of the catalog | /rss/feed/<address> | the RSS export exists and is active |
| REST address | /api/ezp/v1/content/node/<node ID> | the node exists and the API stays enabled |
The node ID and object ID never change for the life of the object, whatever editors do with names and places.
What Exponential keeps working
| Event | Result |
|---|---|
| The page is renamed | a new alias is made; the old one stays and redirects |
| The page is moved | the old path redirects |
| A translation is renamed | the same, per language |
| The file is replaced with one of the same name | the download address stays the same |
So editors can correct titles and reorganize folders without breaking links.
What breaks an address
| Event | Result | Prevention |
|---|---|---|
| The node is removed | "not found"; nothing redirects | Do not remove datasets; mark them withdrawn (see "Versioning and updating datasets") |
| The file is replaced with one of another name | the old download address no longer matches | Keep file names stable, or link to the page |
| The catalog moves to another siteaccess or host | addresses on the old host stop | Redirect in the web server (Going live) |
| A global alias or wildcard is removed | its address stops | Keep a list of the aliases you promised |
Rules for the data team
- Link to the dataset page, not to a file, in announcements and catalogs.
- Never remove a published dataset; withdraw it with a notice instead.
- Keep file names stable across updates, or publish each period as its own distribution.
- Give every dataset a short, permanent alias (below) and print it on the page as "Cite as".
- Record moved or retired addresses in a redirect table before a relaunch (Relaunching a site: a redirect plan).
A short, permanent address per dataset
Give each dataset an extra alias such as /data/street-lighting:
- Open the dataset page, the URL aliases tab.
- Add the alias. It points to the node, so it keeps working through renames and moves.
For a pattern of old addresses, use Setup > URL wildcards (for example datasets/* to data/{1}), with
"Redirecting URL" checked, and test it with Try an address
(URL wildcards).
Checking addresses
curl -sI https://www.example.gov/data/street-lightingshould answer200, or301to the current page.- Setup > Link management lists links in your content and their state (Link list).
./console exp:verify_aliaseschecks the URL alias table;--fixrepairs what is safe to repair (Content languages, section 10).
Related pages
- Redirects and moved content
- URL wildcards and custom aliases
- Links, URL aliases, wildcards and search statistics
- Free documentation: this page is free to copy, translate and improve under the GNU FDL 1.3.
Become an Exponential Partner
Partners share their information, provide funding, contribute back and develop the products with us, and that is how Exponential grows. A partner website and dashboard are planned for mid-2027: please become a partner today to speed up our growth rate and land new features faster.