Welcome to the dmp-hub-ui wiki!

Should be passed via the Authorization: Bearer [api_token] to each of the endpoints.

The following user tokens can be used for testing purposes:

• 1111111111 - A researcher (non-admin user) from 'University of California System (universityofcalifornia.edu)'. This user should not have access at this point, but their DMPs will become important for their admins to see when we get to the dashboards.
• 2222222222 - An admin for 'University of California, Merced (ucmerced.edu)'
• 3333333333 - An admin for 'University of California System (universityofcalifornia.edu)'

• GET /me - returns the current user's info

• GET /contributor_roles - returns the available contributor roles

• GET /funders - funder typeahead (e.g. 'national institutes of')

• GET /orgs - contributor org typeahead (e,g, 'university of california')

• GET /repositories - repository typeahead (e.g. 'genome', 'metabolic', 'dryad')

• GET /wips - the current user's Work in progress DMPs

• POST /wips - create a new work in progress record. minimum data is: { "dmp": { "title": "My fancy DMP" } }

• GET /wips/[wip_id] - a specific work in progress DMP owned by the current user

• PUT /wips/[wip_id] - update a work in progress DMP (current user must own it)

• DELETE /wips/[wip_id] - delete the work in progress DMP (current user must own it)

• POST /narratives - uploads a PDF document and returns a retrieval URL. The response from this should be appended to the wip

Searching for the following funders will return API info that can be used to find projects/awards:

• 'National Institutes of Health' -> /awards/nih
• 'National Science Foundation' -> /awards/nsf
• 'Department of Energy' -> /awards/crossref/[fundref_id] Note that the funder APIs are just starting to get traction so they may not have a lot of results now

For the funder APIs you can use the following search options to see some results:

• GET /awards/nih - { project: '7R21CA256680-02' }, { pi_names: 'Bethard, Crane', years: '2023' }
• GET /awards/crossref/10.13039%2F100000015 - { pi_names: 'Jones, Smith', years: '2022' }
• GET /awards/nsf - { pi_names: 'Jones, Smith', years: '2022' }