Skip to content

Feature Request: External Vocab API to get CVoc configuration #12630

Description

@ChengShi-1

Overview of the Feature Request
Add a public API that returns a sanitized view of the :CVocConfconfiguration for metadata fields wired to an external controlled vocabulary.
GET /api/info/settings/externalVocabularies
This lets API users know which fields are external-vocabulary-enabled and how, without needing admin credentials.

The result could be

{
  "status": "OK",
  "data": [
    {
      "fieldName": "author",
      "termUriField": "authorName",
      "protocol": "orcid-or-ror",
      "allowFreeText": true,
      "languages": ["en"],
      "termParentUri": null,
      "vocabs": {
        "orcid": { "uriSpace": "https://orcid.org/", "vocabularyUri": "https://orcid.org/" },
        "ror":   { "uriSpace": "https://ror.org/",   "vocabularyUri": "https://ror.org/" }
      },
      "managedFields": {
        "personName": "authorName",
        "organizationName": "authorAffiliation",
        "affiliation": "authorAffiliation",
        "idType": "authorIdentifierScheme"
      }
    },
    {
      "fieldName": "authorAffiliation",
      "termUriField": "authorAffiliation",
      "protocol": "ror",
      "allowFreeText": true,
      "languages": [],
      "vocabs": { "ror": { "uriSpace": "https://ror.org/", "vocabularyUri": "https://ror.org/" } },
      "managedFields": { "organizationName": "authorAffiliation" }
    }
  ]
}

What kind of user is the feature intended for?
(Example users roles: API User, Curator, Depositor, Guest, Superuser, Sysadmin)
API User, SPA

What inspired the request?
This is in the GREI5 Scope
IQSS/dataverse-frontend#1023

What existing behavior do you want changed?
NA

Any brand new behavior do you want to add to Dataverse?
NA

Any open or closed issues related to this feature request?

Are you thinking about creating a pull request for this feature?
Help is always welcome, is this feature something you or your organization plan to implement?

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    Status
    Sprint Ready

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions