Skip to content

ROR v2 API support#46

Merged
qqmyers merged 4 commits intomainfrom
RORv2
Dec 3, 2025
Merged

ROR v2 API support#46
qqmyers merged 4 commits intomainfrom
RORv2

Conversation

@qqmyers
Copy link
Copy Markdown
Member

@qqmyers qqmyers commented Aug 20, 2025

This PR updates the main ror.js script and the configurations applying it to the author affiliation field and grantNumberAgency field to use the ROR v2 API (needed prior to ~12/31/25).

The PR doesn't update the affiliation.js script - an earlier example with different UI, but does switch it to explicitly use the ROR v1 API which is needed to make it work until 12/31/25.

The changes in the API were relatively minor for our purposes - the name and acronym fields are replaced with a single names array that has entries of type acronym and ror_display/label that can be used as replacements. The new API does allow labels in multiple languages - it's not clear how many entries have that populated, so I did not try to adapt the UI to use internationalized labels in this PR. The retrieval filtering will pick up all such values for use in the metadata exports though (as it gets the whole /names array).

I'm testing this at QDR, but if anyone else would like to try it now and review the PR, please do. Otherwise I'll merge this at some later date.

Note that this PR requires #11782 which is being QA'd for inclusion in Dataverse 6.8. To use this with earlier versions of Dataverse, the "retrieval-filtering" entry should be emptied/removed.
In Dataverse 6.8, using the "termName" with "params":["/names"] will result in the list of acronyms and names (possibly in different languages) for the organization to be added to exports such as the JSON and OAI_ORE exports. However, the organization name will not be sent to DataCite/appear in the DataCite XML export.

For Dataverse 6.9, additional options for retrieval-filtering are being added.

  • #11762 will allow using "params":["/names/0/value"] or other number to get the nth name in ROR's list.
  • #11793 will allow using "params":["/names/types=ror_display/value"] to get the name that ROR uses in it's own web display for a term.

With either of these, the organization name will be sent to DataCite and appear in the DataCite XML export, and the JSON/OAI_ORE exports will include just this single name rather than the array of available names.

Closes: #41

see Dataverse #11941 for some additional details.
@qqmyers qqmyers merged commit 246b5d6 into main Dec 3, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

ROR is dropping there v1 API - scripts need to use v2 schema

1 participant