ror-community / ror-roadmap

Central information about what is happening at ROR and how to contribute feedback
10 stars 2 forks source link

[FEATURE] API v2: Bulk record create/update from CSV endpoint #206

Open lizkrznarich opened 1 year ago

lizkrznarich commented 1 year ago

Describe the problem you would like to solve As part of https://github.com/ror-community/ror-roadmap/issues/122, add API functionality to ROR API that supports generating new or updated record files in bulk using data submitted to the API in a CSV file.

Describe the solution you'd like Functionality should behave as follows:

  1. User submits a CSV file to API endpoint with field values specified in columns identified by column headings.
  1. For each row, new or updated record steps above are completed using create and update functionality described in https://github.com/ror-community/ror-roadmap/issues/204 and https://github.com/ror-community/ror-roadmap/issues/205. If an error occurs, the row is skipped and an error message is appended to the response.
  2. API returns a ZIP file object containing generated records for all successful rows. If any (or all) rows were skipped due to errors, API returns an error message containing the full list of errors.

Who would benefit from this feature? ROR curation team

Additional information See full specification for more details