Feature Request/Idea: Documentation for the API to create and edit harvesting clients

[pdurbin]

Overview of the Feature Request

In pull request #8106 we documented the SERVER side of the harvesting API: https://guides.dataverse.org/en/5.8/api/native-api.html#managing-harvesting-server-and-sets

This issue is for documenting the CLIENT side of the harvesting API

What kind of user is the feature intended for?

API User, Sysadmin

What inspired the request?

Thomas Jouneau asked about it at https://groups.google.com/g/dataverse-community/c/BK2IIc1QUY4/m/DpmiDF-DBgAJ

Any related open or closed issues to this feature request?

• Documentation: Document Harvesting/OAI set endpoints Documentation: Document Harvesting/OAI set endpoints #4514

[pdurbin]

In order to reply to the question I had a play with the harvest clients API. I documented what I got working in 1364349 which is listing and editing.

Delete is not implemented. There's a TODO.

I couldn't get create working. Here's the file I was using: harvest-client.json.txt

Exceptions in server.log looked like this:

A system exception occurred during an invocation on EJB GroupServiceBean, method: public java.util.Set edu.harvard.iq.dataverse.authorization.groups.GroupServiceBean.gro
upsFor(edu.harvard.iq.dataverse.engine.command.DataverseRequest,edu.harvard.iq.dataverse.DvObject)]]

javax.ejb.TransactionRolledbackLocalException: Exception thrown from bean: java.lang.IllegalStateException: During synchronization a new object was found through a relatio
nship that was not marked cascade PERSIST: edu.harvard.iq.dataverse.harvest.client.HarvestingClient[ id=null ].

Here's my full log: server.log.txt

[pdurbin]

In order to reply to the question I had a play with the harvest clients API. I documented what I got working in 1364349 which is listing and editing.

We should probably limit the scope of this issue to just documenting listing and editing, which is working. There's a commit above to help get started.

We can use this issue to work on getting "create harvesting client via API" to work:

• Trying to set up or complete a harvesting client through the API crashes Dataverse #8290