Accessing mandatory metadata fields through API

[Pablo Valério Polônia]

Hi all,

Is it possible to know, via API, which metadata fields are mandatory for a given Dataverse?

Context: In the plugin we developed for integration between OJS and Dataverse, we are considering only a minimum set of mandatory metadata (such as title, description, subject, etc.).

For instance, we had a case where the Related Publication Type field had been marked as mandatory, which prevented the plugin from completing the deposit of research data. This is just an example — in practice, any other customized mandatory field could generate the same issue.

Knowing which fields are mandatory would allow us to think of strategies to deal with them. 

Kind Regards,

Pablo

Lepidus

[Philip Durbin]

Hi Pablo,

Good question. A field can be marked as required (the term we use instead of mandatory) globally or at the collection level.

For example, if you go to https://demo.dataverse.org/api/metadatablocks/citation you can see that "title" is required globally. Docs on this API call are here: https://guides.dataverse.org/en/6.7.1/api/native-api.html#show-info-about-all-metadata-blocks

Probably someone made Related Publication required for a certain collection. To check, please use this API call: https://guides.dataverse.org/en/6.7.1/api/native-api.html#list-metadata-blocks-defined-on-a-dataverse-collection 

I hope this helps. Please let me know if you have any questions!

Thanks,

Phil

--
You received this message because you are subscribed to the Google Groups "Dataverse Users Community" group.
To unsubscribe from this group and stop receiving emails from it, send an email to dataverse-commu...@googlegroups.com.
To view this discussion visit https://groups.google.com/d/msgid/dataverse-community/CAMCDo-JUYqEjSBOVhVq8J7BjAogYOAC02eXo30j-n94NRFrCHA%40mail.gmail.com.

--

Philip Durbin
Software Developer for http://dataverse.org
http://www.iq.harvard.edu/people/philip-durbin