CINXE.COM
Drafts and Records - Turn-key research data management repository
<!doctype html> <html lang="en" class="no-js"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width,initial-scale=1"> <link rel="canonical" href="https://inveniordm.docs.cern.ch/reference/rest_api_drafts_records/"> <link rel="prev" href="../rest_api_communities/"> <link rel="next" href="../rest_api_groups/"> <link rel="icon" href="../../images/favicon.svg"> <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.40"> <title>Drafts and Records - Turn-key research data management repository</title> <link rel="stylesheet" href="../../assets/stylesheets/main.8c3ca2c6.min.css"> <link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css"> <link rel="stylesheet" href="../../stylesheets/extra.css"> <script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script> </head> <body dir="ltr" data-md-color-scheme="default" data-md-color-primary="custom" data-md-color-accent="custom"> <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off"> <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off"> <label class="md-overlay" for="__drawer"></label> <div data-md-component="skip"> <a href="#drafts-and-records" class="md-skip"> Skip to content </a> </div> <div data-md-component="announce"> </div> <header class="md-header" data-md-component="header"> <nav class="md-header__inner md-grid" aria-label="Header"> <a href="../.." title="Turn-key research data management repository" class="md-header__button md-logo" aria-label="Turn-key research data management repository" data-md-component="logo"> <img src="../../images/logo-rdm.png" alt="logo"> </a> <label class="md-header__button md-icon" for="__drawer"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg> </label> <div class="md-header__title" data-md-component="header-title"> <div class="md-header__ellipsis"> <div class="md-header__topic"> <span class="md-ellipsis"> Turn-key research data management repository </span> </div> <div class="md-header__topic" data-md-component="header-topic"> <span class="md-ellipsis"> Drafts and Records </span> </div> </div> </div> <form class="md-header__option" data-md-component="palette"> <input class="md-option" data-md-color-media="(prefers-color-scheme: light)" data-md-color-scheme="default" data-md-color-primary="custom" data-md-color-accent="custom" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_0"> <label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_1" hidden> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a4 4 0 0 0-4 4 4 4 0 0 0 4 4 4 4 0 0 0 4-4 4 4 0 0 0-4-4m0 10a6 6 0 0 1-6-6 6 6 0 0 1 6-6 6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z"/></svg> </label> <input class="md-option" data-md-color-media="(prefers-color-scheme: dark)" data-md-color-scheme="slate" data-md-color-primary="black" data-md-color-accent="orange" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_1"> <label class="md-header__button md-icon" title="Switch to light mode" for="__palette_0" hidden> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 18c-.89 0-1.74-.2-2.5-.55C11.56 16.5 13 14.42 13 12s-1.44-4.5-3.5-5.45C10.26 6.2 11.11 6 12 6a6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z"/></svg> </label> </form> <script>var palette=__md_get("__palette");if(palette&&palette.color){if("(prefers-color-scheme)"===palette.color.media){var media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent")}for(var[key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script> <label class="md-header__button md-icon" for="__search"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg> </label> <div class="md-search" data-md-component="search" role="dialog"> <label class="md-search__overlay" for="__search"></label> <div class="md-search__inner" role="search"> <form class="md-search__form" name="search"> <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required> <label class="md-search__icon md-icon" for="__search"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg> </label> <nav class="md-search__options" aria-label="Search"> <button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"/></svg> </button> </nav> </form> <div class="md-search__output"> <div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix> <div class="md-search-result" data-md-component="search-result"> <div class="md-search-result__meta"> Initializing search </div> <ol class="md-search-result__list" role="presentation"></ol> </div> </div> </div> </div> </div> <div class="md-header__source"> <a href="https://github.com/inveniosoftware/docs-invenio-rdm" title="Go to repository" class="md-source" data-md-component="source"> <div class="md-source__icon md-icon"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.6.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81"/></svg> </div> <div class="md-source__repository"> GitHub </div> </a> </div> </nav> </header> <div class="md-container" data-md-component="container"> <nav class="md-tabs" aria-label="Tabs" data-md-component="tabs"> <div class="md-grid"> <ul class="md-tabs__list"> <li class="md-tabs__item"> <a href="../.." class="md-tabs__link"> Home </a> </li> <li class="md-tabs__item"> <a href="../../features/" class="md-tabs__link"> Features </a> </li> <li class="md-tabs__item"> <a href="../../install/" class="md-tabs__link"> Install </a> </li> <li class="md-tabs__item"> <a href="../../customize/" class="md-tabs__link"> Customize </a> </li> <li class="md-tabs__item"> <a href="../../develop/" class="md-tabs__link"> Develop </a> </li> <li class="md-tabs__item"> <a href="../../deploy/" class="md-tabs__link"> Deploy </a> </li> <li class="md-tabs__item md-tabs__item--active"> <a href="../" class="md-tabs__link"> Reference </a> </li> <li class="md-tabs__item"> <a href="../../releases/" class="md-tabs__link"> Releases </a> </li> <li class="md-tabs__item"> <a href="../../maintenance/" class="md-tabs__link"> Maintainers </a> </li> <li class="md-tabs__item"> <a href="../../contribute/" class="md-tabs__link"> Onboard & Contribute </a> </li> </ul> </div> </nav> <main class="md-main" data-md-component="main"> <div class="md-main__inner md-grid"> <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" > <div class="md-sidebar__scrollwrap"> <div class="md-sidebar__inner"> <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0"> <label class="md-nav__title" for="__drawer"> <a href="../.." title="Turn-key research data management repository" class="md-nav__button md-logo" aria-label="Turn-key research data management repository" data-md-component="logo"> <img src="../../images/logo-rdm.png" alt="logo"> </a> Turn-key research data management repository </label> <div class="md-nav__source"> <a href="https://github.com/inveniosoftware/docs-invenio-rdm" title="Go to repository" class="md-source" data-md-component="source"> <div class="md-source__icon md-icon"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.6.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81"/></svg> </div> <div class="md-source__repository"> GitHub </div> </a> </div> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../.." class="md-nav__link"> <span class="md-ellipsis"> Home </span> </a> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" > <label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0"> <span class="md-ellipsis"> Features </span> <span class="md-nav__icon md-icon"></span> </label> <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_2"> <span class="md-nav__icon md-icon"></span> Features </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../features/" class="md-nav__link"> <span class="md-ellipsis"> Overview </span> </a> </li> <li class="md-nav__item"> <a href="../../features/ux/" class="md-nav__link"> <span class="md-ellipsis"> Beautiful UX </span> </a> </li> <li class="md-nav__item"> <a href="../../features/scalable/" class="md-nav__link"> <span class="md-ellipsis"> Highly scalable </span> </a> </li> <li class="md-nav__item"> <a href="../../features/customization/" class="md-nav__link"> <span class="md-ellipsis"> Customizable </span> </a> </li> <li class="md-nav__item"> <a href="../../features/interoperable/" class="md-nav__link"> <span class="md-ellipsis"> Interoperable </span> </a> </li> <li class="md-nav__item"> <a href="../../features/powerful/" class="md-nav__link"> <span class="md-ellipsis"> Powerful </span> </a> </li> <li class="md-nav__item"> <a href="../../features/secure/" class="md-nav__link"> <span class="md-ellipsis"> Secure </span> </a> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_8" > <label class="md-nav__link" for="__nav_2_8" id="__nav_2_8_label" tabindex="0"> <span class="md-ellipsis"> Features walk-through </span> <span class="md-nav__icon md-icon"></span> </label> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_8_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_2_8"> <span class="md-nav__icon md-icon"></span> Features walk-through </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../features/features-walk-through/" class="md-nav__link"> <span class="md-ellipsis"> Features overview </span> </a> </li> <li class="md-nav__item"> <a href="../../features/features-walk-through/banners/" class="md-nav__link"> <span class="md-ellipsis"> Site banners </span> </a> </li> <li class="md-nav__item"> <a href="../../features/features-walk-through/notifications/" class="md-nav__link"> <span class="md-ellipsis"> Notifications </span> </a> </li> <li class="md-nav__item"> <a href="../../features/features-walk-through/access_requests/" class="md-nav__link"> <span class="md-ellipsis"> Access requests </span> </a> </li> </ul> </nav> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" > <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0"> <span class="md-ellipsis"> Install </span> <span class="md-nav__icon md-icon"></span> </label> <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_3"> <span class="md-nav__icon md-icon"></span> Install </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../install/" class="md-nav__link"> <span class="md-ellipsis"> Quick start </span> </a> </li> <li class="md-nav__item"> <a href="../../install/requirements/" class="md-nav__link"> <span class="md-ellipsis"> System requirements </span> </a> </li> <li class="md-nav__item"> <a href="../../install/cli/" class="md-nav__link"> <span class="md-ellipsis"> Install CLI </span> </a> </li> <li class="md-nav__item"> <a href="../../install/scaffold/" class="md-nav__link"> <span class="md-ellipsis"> Scaffold </span> </a> </li> <li class="md-nav__item"> <a href="../../install/build-setup-run/" class="md-nav__link"> <span class="md-ellipsis"> Build, setup & run </span> </a> </li> <li class="md-nav__item"> <a href="../../install/configuration/" class="md-nav__link"> <span class="md-ellipsis"> Configure </span> </a> </li> <li class="md-nav__item"> <a href="../../install/run/" class="md-nav__link"> <span class="md-ellipsis"> Use </span> </a> </li> <li class="md-nav__item"> <a href="../../install/migrate/" class="md-nav__link"> <span class="md-ellipsis"> Migrate </span> </a> </li> <li class="md-nav__item"> <a href="../../install/destroy/" class="md-nav__link"> <span class="md-ellipsis"> Destroy </span> </a> </li> <li class="md-nav__item"> <a href="../../install/troubleshoot/" class="md-nav__link"> <span class="md-ellipsis"> Troubleshooting </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" > <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0"> <span class="md-ellipsis"> Customize </span> <span class="md-nav__icon md-icon"></span> </label> <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_4"> <span class="md-nav__icon md-icon"></span> Customize </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../customize/" class="md-nav__link"> <span class="md-ellipsis"> Overview </span> </a> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_2" > <label class="md-nav__link" for="__nav_4_2" id="__nav_4_2_label" tabindex="0"> <span class="md-ellipsis"> Look-and-feel </span> <span class="md-nav__icon md-icon"></span> </label> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_2_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_4_2"> <span class="md-nav__icon md-icon"></span> Look-and-feel </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../customize/look-and-feel/" class="md-nav__link"> <span class="md-ellipsis"> Overview </span> </a> </li> <li class="md-nav__item"> <a href="../../customize/look-and-feel/logo/" class="md-nav__link"> <span class="md-ellipsis"> Change logo </span> </a> </li> <li class="md-nav__item"> <a href="../../customize/look-and-feel/templates/" class="md-nav__link"> <span class="md-ellipsis"> Change templates </span> </a> </li> <li class="md-nav__item"> <a href="../../customize/look-and-feel/theme/" class="md-nav__link"> <span class="md-ellipsis"> Change theme </span> </a> </li> <li class="md-nav__item"> <a href="../../customize/look-and-feel/font/" class="md-nav__link"> <span class="md-ellipsis"> Change font </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item"> <a href="../../customize/authentication/" class="md-nav__link"> <span class="md-ellipsis"> Authentication </span> </a> </li> <li class="md-nav__item"> <a href="../../customize/emails/" class="md-nav__link"> <span class="md-ellipsis"> Sending emails </span> </a> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_5" > <label class="md-nav__link" for="__nav_4_5" id="__nav_4_5_label" tabindex="0"> <span class="md-ellipsis"> Search </span> <span class="md-nav__icon md-icon"></span> </label> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_5_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_4_5"> <span class="md-nav__icon md-icon"></span> Search </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../customize/search/" class="md-nav__link"> <span class="md-ellipsis"> Change facets/sorting </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_6" > <label class="md-nav__link" for="__nav_4_6" id="__nav_4_6_label" tabindex="0"> <span class="md-ellipsis"> Vocabularies </span> <span class="md-nav__icon md-icon"></span> </label> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_6_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_4_6"> <span class="md-nav__icon md-icon"></span> Vocabularies </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../customize/vocabularies/" class="md-nav__link"> <span class="md-ellipsis"> Overview </span> </a> </li> <li class="md-nav__item"> <a href="../../customize/vocabularies/resource_types/" class="md-nav__link"> <span class="md-ellipsis"> Resource types </span> </a> </li> <li class="md-nav__item"> <a href="../../customize/vocabularies/affiliations/" class="md-nav__link"> <span class="md-ellipsis"> Affiliations </span> </a> </li> <li class="md-nav__item"> <a href="../../customize/vocabularies/names/" class="md-nav__link"> <span class="md-ellipsis"> Names </span> </a> </li> <li class="md-nav__item"> <a href="../../customize/vocabularies/funding/" class="md-nav__link"> <span class="md-ellipsis"> Funding </span> </a> </li> <li class="md-nav__item"> <a href="../../customize/vocabularies/subjects/" class="md-nav__link"> <span class="md-ellipsis"> Subjects </span> </a> </li> <li class="md-nav__item"> <a href="../../customize/vocabularies/users/" class="md-nav__link"> <span class="md-ellipsis"> Users </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_7" > <label class="md-nav__link" for="__nav_4_7" id="__nav_4_7_label" tabindex="0"> <span class="md-ellipsis"> Metadata </span> <span class="md-nav__icon md-icon"></span> </label> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_7_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_4_7"> <span class="md-nav__icon md-icon"></span> Metadata </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../customize/metadata/optional_fields/" class="md-nav__link"> <span class="md-ellipsis"> Optional metadata </span> </a> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_7_2" > <label class="md-nav__link" for="__nav_4_7_2" id="__nav_4_7_2_label" tabindex="0"> <span class="md-ellipsis"> Custom fields </span> <span class="md-nav__icon md-icon"></span> </label> <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_4_7_2_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_4_7_2"> <span class="md-nav__icon md-icon"></span> Custom fields </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../customize/metadata/custom_fields/records/" class="md-nav__link"> <span class="md-ellipsis"> Add fields to records </span> </a> </li> <li class="md-nav__item"> <a href="../../customize/metadata/custom_fields/communities/" class="md-nav__link"> <span class="md-ellipsis"> Add fields to communities </span> </a> </li> </ul> </nav> </li> </ul> </nav> </li> <li class="md-nav__item"> <a href="../../customize/record_landing_page/" class="md-nav__link"> <span class="md-ellipsis"> Record landing page </span> </a> </li> <li class="md-nav__item"> <a href="../../customize/static_pages/" class="md-nav__link"> <span class="md-ellipsis"> Static pages </span> </a> </li> <li class="md-nav__item"> <a href="../../customize/dois/" class="md-nav__link"> <span class="md-ellipsis"> DOI registration </span> </a> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_11" > <label class="md-nav__link" for="__nav_4_11" id="__nav_4_11_label" tabindex="0"> <span class="md-ellipsis"> Other PIDs integrations </span> <span class="md-nav__icon md-icon"></span> </label> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_11_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_4_11"> <span class="md-nav__icon md-icon"></span> Other PIDs integrations </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../customize/other-pids/urns/" class="md-nav__link"> <span class="md-ellipsis"> DNB URNs </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item"> <a href="../../customize/s3/" class="md-nav__link"> <span class="md-ellipsis"> Storage </span> </a> </li> <li class="md-nav__item"> <a href="../../customize/upload_limits/" class="md-nav__link"> <span class="md-ellipsis"> Upload Limits </span> </a> </li> <li class="md-nav__item"> <a href="../../customize/metadata_only/" class="md-nav__link"> <span class="md-ellipsis"> Metadata-only records </span> </a> </li> <li class="md-nav__item"> <a href="../../customize/Logging/" class="md-nav__link"> <span class="md-ellipsis"> Logging </span> </a> </li> <li class="md-nav__item"> <a href="../../customize/i18n-and-l10n/" class="md-nav__link"> <span class="md-ellipsis"> Internationalisation (i18n) and Localisation (l10n) </span> </a> </li> <li class="md-nav__item"> <a href="../../customize/notifications/" class="md-nav__link"> <span class="md-ellipsis"> Notifications </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" > <label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0"> <span class="md-ellipsis"> Develop </span> <span class="md-nav__icon md-icon"></span> </label> <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_5"> <span class="md-nav__icon md-icon"></span> Develop </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../develop/" class="md-nav__link"> <span class="md-ellipsis"> Overview </span> </a> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_2" > <label class="md-nav__link" for="__nav_5_2" id="__nav_5_2_label" tabindex="0"> <span class="md-ellipsis"> Getting started </span> <span class="md-nav__icon md-icon"></span> </label> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_2_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_5_2"> <span class="md-nav__icon md-icon"></span> Getting started </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../develop/getting-started/source-code/" class="md-nav__link"> <span class="md-ellipsis"> Source code </span> </a> </li> <li class="md-nav__item"> <a href="../../develop/getting-started/package-development/" class="md-nav__link"> <span class="md-ellipsis"> Package development </span> </a> </li> <li class="md-nav__item"> <a href="../../develop/getting-started/instance-development/" class="md-nav__link"> <span class="md-ellipsis"> Instance development </span> </a> </li> <li class="md-nav__item"> <a href="../../develop/getting-started/debugging/" class="md-nav__link"> <span class="md-ellipsis"> Debugging </span> </a> </li> <li class="md-nav__item"> <a href="../../develop/getting-started/code-style/" class="md-nav__link"> <span class="md-ellipsis"> Coding style </span> </a> </li> <li class="md-nav__item"> <a href="../../develop/getting-started/virtualenvs/" class="md-nav__link"> <span class="md-ellipsis"> Virtual environments </span> </a> </li> <li class="md-nav__item"> <a href="../../develop/getting-started/help/" class="md-nav__link"> <span class="md-ellipsis"> Getting help </span> </a> </li> <li class="md-nav__item"> <a href="../../develop/process/" class="md-nav__link"> <span class="md-ellipsis"> Development process </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_3" > <label class="md-nav__link" for="__nav_5_3" id="__nav_5_3_label" tabindex="0"> <span class="md-ellipsis"> Best practices </span> <span class="md-nav__icon md-icon"></span> </label> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_3_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_5_3"> <span class="md-nav__icon md-icon"></span> Best practices </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../develop/best-practices/accessibility/" class="md-nav__link"> <span class="md-ellipsis"> Accessibility (a11y) </span> </a> </li> <li class="md-nav__item"> <a href="../../develop/best-practices/commits/" class="md-nav__link"> <span class="md-ellipsis"> Commits, PRs & reviews </span> </a> </li> <li class="md-nav__item"> <a href="../../develop/best-practices/css-js/" class="md-nav__link"> <span class="md-ellipsis"> CSS/JavaScript </span> </a> </li> <li class="md-nav__item"> <a href="../../develop/best-practices/react/" class="md-nav__link"> <span class="md-ellipsis"> React </span> </a> </li> <li class="md-nav__item"> <a href="../../develop/best-practices/ui/" class="md-nav__link"> <span class="md-ellipsis"> User interface </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_4" > <label class="md-nav__link" for="__nav_5_4" id="__nav_5_4_label" tabindex="0"> <span class="md-ellipsis"> Topic guides </span> <span class="md-nav__icon md-icon"></span> </label> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_4_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_5_4"> <span class="md-nav__icon md-icon"></span> Topic guides </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../develop/topics/resource/" class="md-nav__link"> <span class="md-ellipsis"> Building resources </span> </a> </li> <li class="md-nav__item"> <a href="../../develop/topics/service/" class="md-nav__link"> <span class="md-ellipsis"> Building services </span> </a> </li> <li class="md-nav__item"> <a href="../../develop/topics/serializers/" class="md-nav__link"> <span class="md-ellipsis"> Building serializers </span> </a> </li> <li class="md-nav__item"> <a href="../../develop/topics/uow/" class="md-nav__link"> <span class="md-ellipsis"> Grouping atomic operations </span> </a> </li> <li class="md-nav__item"> <a href="../../develop/topics/validation/" class="md-nav__link"> <span class="md-ellipsis"> Sanitize input data </span> </a> </li> <li class="md-nav__item"> <a href="../../develop/topics/theming/" class="md-nav__link"> <span class="md-ellipsis"> Theming </span> </a> </li> <li class="md-nav__item"> <a href="../../develop/topics/administration_panel/" class="md-nav__link"> <span class="md-ellipsis"> Administration panel </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_5" > <label class="md-nav__link" for="__nav_5_5" id="__nav_5_5_label" tabindex="0"> <span class="md-ellipsis"> How-to guides </span> <span class="md-nav__icon md-icon"></span> </label> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_5_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_5_5"> <span class="md-nav__icon md-icon"></span> How-to guides </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../develop/howtos/i18n/" class="md-nav__link"> <span class="md-ellipsis"> Translation (i18n) </span> </a> </li> <li class="md-nav__item"> <a href="../../develop/howtos/custom_fields/" class="md-nav__link"> <span class="md-ellipsis"> Create a new custom field </span> </a> </li> <li class="md-nav__item"> <a href="../../develop/howtos/custom_code/" class="md-nav__link"> <span class="md-ellipsis"> Create custom code and views </span> </a> </li> <li class="md-nav__item"> <a href="../../develop/howtos/add_javascript/" class="md-nav__link"> <span class="md-ellipsis"> Add JavaScript </span> </a> </li> <li class="md-nav__item"> <a href="../../develop/howtos/override_components/" class="md-nav__link"> <span class="md-ellipsis"> Override UI React components </span> </a> </li> <li class="md-nav__item"> <a href="../../develop/howtos/search_terms_migration/" class="md-nav__link"> <span class="md-ellipsis"> Create search terms mappings </span> </a> </li> <li class="md-nav__item"> <a href="../../develop/howtos/alembic/" class="md-nav__link"> <span class="md-ellipsis"> Create a database migration </span> </a> </li> <li class="md-nav__item"> <a href="../../develop/howtos/security-fix/" class="md-nav__link"> <span class="md-ellipsis"> Fix a vulnerability </span> </a> </li> <li class="md-nav__item"> <a href="../../develop/howtos/dev_email/" class="md-nav__link"> <span class="md-ellipsis"> Test emails locally </span> </a> </li> <li class="md-nav__item"> <a href="../../develop/howtos/route_migration/" class="md-nav__link"> <span class="md-ellipsis"> Migrate legacy routes </span> </a> </li> <li class="md-nav__item"> <a href="../../develop/howtos/backup_search_indices/" class="md-nav__link"> <span class="md-ellipsis"> Back up search indices </span> </a> </li> <li class="md-nav__item"> <a href="../../develop/howtos/restrict_access/" class="md-nav__link"> <span class="md-ellipsis"> Restrict access to pages </span> </a> </li> <li class="md-nav__item"> <a href="../../develop/howtos/notifications/" class="md-nav__link"> <span class="md-ellipsis"> Create and configure notifications </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_6" > <label class="md-nav__link" for="__nav_5_6" id="__nav_5_6_label" tabindex="0"> <span class="md-ellipsis"> Architecture </span> <span class="md-nav__icon md-icon"></span> </label> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_6_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_5_6"> <span class="md-nav__icon md-icon"></span> Architecture </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../develop/architecture/" class="md-nav__link"> <span class="md-ellipsis"> Introduction </span> </a> </li> <li class="md-nav__item"> <a href="../../develop/architecture/infrastructure/" class="md-nav__link"> <span class="md-ellipsis"> Infrastructure </span> </a> </li> <li class="md-nav__item"> <a href="../../develop/architecture/software/" class="md-nav__link"> <span class="md-ellipsis"> Software </span> </a> </li> <li class="md-nav__item"> <a href="../../develop/architecture/runtime/" class="md-nav__link"> <span class="md-ellipsis"> Runtime </span> </a> </li> <li class="md-nav__item"> <a href="../../develop/architecture/requests/" class="md-nav__link"> <span class="md-ellipsis"> Requests </span> </a> </li> <li class="md-nav__item"> <a href="../../develop/architecture/communities/" class="md-nav__link"> <span class="md-ellipsis"> Communities </span> </a> </li> <li class="md-nav__item"> <a href="../../develop/architecture/records/" class="md-nav__link"> <span class="md-ellipsis"> Records </span> </a> </li> <li class="md-nav__item"> <a href="../../develop/architecture/event_handling/" class="md-nav__link"> <span class="md-ellipsis"> Event handling </span> </a> </li> <li class="md-nav__item"> <a href="../../develop/architecture/notifications/" class="md-nav__link"> <span class="md-ellipsis"> Notifications </span> </a> </li> <li class="md-nav__item"> <a href="../../develop/architecture/reading/" class="md-nav__link"> <span class="md-ellipsis"> Recommended reading </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_7" > <label class="md-nav__link" for="__nav_5_7" id="__nav_5_7_label" tabindex="0"> <span class="md-ellipsis"> Concepts </span> <span class="md-nav__icon md-icon"></span> </label> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_7_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_5_7"> <span class="md-nav__icon md-icon"></span> Concepts </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../develop/concepts/concurrency-control/" class="md-nav__link"> <span class="md-ellipsis"> Optimistic concurrency control </span> </a> </li> <li class="md-nav__item"> <a href="../../develop/concepts/transactions/" class="md-nav__link"> <span class="md-ellipsis"> Database transaction management </span> </a> </li> </ul> </nav> </li> </ul> </nav> </li> <li class="md-nav__item"> <a href="../../deploy/" class="md-nav__link"> <span class="md-ellipsis"> Deploy </span> </a> </li> <li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7" checked> <label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex=""> <span class="md-ellipsis"> Reference </span> <span class="md-nav__icon md-icon"></span> </label> <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="true"> <label class="md-nav__title" for="__nav_7"> <span class="md-nav__icon md-icon"></span> Reference </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../" class="md-nav__link"> <span class="md-ellipsis"> Overview </span> </a> </li> <li class="md-nav__item"> <a href="../cli/" class="md-nav__link"> <span class="md-ellipsis"> CLI </span> </a> </li> <li class="md-nav__item"> <a href="../configuration/" class="md-nav__link"> <span class="md-ellipsis"> Configuration </span> </a> </li> <li class="md-nav__item"> <a href="../metadata/" class="md-nav__link"> <span class="md-ellipsis"> Metadata </span> </a> </li> <li class="md-nav__item"> <a href="../metadata/optional_metadata/" class="md-nav__link"> <span class="md-ellipsis"> Optional metadata </span> </a> </li> <li class="md-nav__item"> <a href="../oai_pmh/" class="md-nav__link"> <span class="md-ellipsis"> OAI-PMH </span> </a> </li> <li class="md-nav__item"> <a href="../export_formats/" class="md-nav__link"> <span class="md-ellipsis"> Export formats </span> </a> </li> <li class="md-nav__item md-nav__item--active md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7_8" checked> <label class="md-nav__link" for="__nav_7_8" id="__nav_7_8_label" tabindex="0"> <span class="md-ellipsis"> REST API </span> <span class="md-nav__icon md-icon"></span> </label> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_7_8_label" aria-expanded="true"> <label class="md-nav__title" for="__nav_7_8"> <span class="md-nav__icon md-icon"></span> REST API </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../rest_api_index/" class="md-nav__link"> <span class="md-ellipsis"> Overview </span> </a> </li> <li class="md-nav__item"> <a href="../rest_api_quickstart/" class="md-nav__link"> <span class="md-ellipsis"> Quickstart </span> </a> </li> <li class="md-nav__item"> <a href="../rest_api_communities/" class="md-nav__link"> <span class="md-ellipsis"> Communities </span> </a> </li> <li class="md-nav__item md-nav__item--active"> <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc"> <label class="md-nav__link md-nav__link--active" for="__toc"> <span class="md-ellipsis"> Drafts and Records </span> <span class="md-nav__icon md-icon"></span> </label> <a href="./" class="md-nav__link md-nav__link--active"> <span class="md-ellipsis"> Drafts and Records </span> </a> <nav class="md-nav md-nav--secondary" aria-label="Table of contents"> <label class="md-nav__title" for="__toc"> <span class="md-nav__icon md-icon"></span> Table of contents </label> <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix> <li class="md-nav__item"> <a href="#drafts" class="md-nav__link"> <span class="md-ellipsis"> Drafts </span> </a> <nav class="md-nav" aria-label="Drafts"> <ul class="md-nav__list"> <li class="md-nav__item"> <a href="#create-a-draft-record" class="md-nav__link"> <span class="md-ellipsis"> Create a draft record </span> </a> <nav class="md-nav" aria-label="Create a draft record"> <ul class="md-nav__list"> <li class="md-nav__item"> <a href="#files-options" class="md-nav__link"> <span class="md-ellipsis"> Files Options </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item"> <a href="#get-a-draft-record" class="md-nav__link"> <span class="md-ellipsis"> Get a draft record </span> </a> </li> <li class="md-nav__item"> <a href="#update-a-draft-record" class="md-nav__link"> <span class="md-ellipsis"> Update a draft record </span> </a> </li> <li class="md-nav__item"> <a href="#publish-a-draft-record" class="md-nav__link"> <span class="md-ellipsis"> Publish a draft record </span> </a> </li> <li class="md-nav__item"> <a href="#edit-a-published-record-create-a-draft-record-from-a-published-record" class="md-nav__link"> <span class="md-ellipsis"> Edit a published record (Create a draft record from a published record) </span> </a> </li> <li class="md-nav__item"> <a href="#deletediscard-a-draft-record" class="md-nav__link"> <span class="md-ellipsis"> Delete/discard a draft record </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item"> <a href="#draft-files" class="md-nav__link"> <span class="md-ellipsis"> Draft files </span> </a> <nav class="md-nav" aria-label="Draft files"> <ul class="md-nav__list"> <li class="md-nav__item"> <a href="#list-a-drafts-files" class="md-nav__link"> <span class="md-ellipsis"> List a draft's files </span> </a> </li> <li class="md-nav__item"> <a href="#start-draft-file-uploads" class="md-nav__link"> <span class="md-ellipsis"> Start draft file upload(s) </span> </a> </li> <li class="md-nav__item"> <a href="#upload-a-draft-files-content" class="md-nav__link"> <span class="md-ellipsis"> Upload a draft file's content </span> </a> </li> <li class="md-nav__item"> <a href="#complete-a-draft-file-upload" class="md-nav__link"> <span class="md-ellipsis"> Complete a draft file upload </span> </a> </li> <li class="md-nav__item"> <a href="#get-a-draft-files-metadata" class="md-nav__link"> <span class="md-ellipsis"> Get a draft file's metadata </span> </a> </li> <li class="md-nav__item"> <a href="#download-a-draft-file" class="md-nav__link"> <span class="md-ellipsis"> Download a draft file </span> </a> </li> <li class="md-nav__item"> <a href="#delete-a-draft-file" class="md-nav__link"> <span class="md-ellipsis"> Delete a draft file </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item"> <a href="#records" class="md-nav__link"> <span class="md-ellipsis"> Records </span> </a> <nav class="md-nav" aria-label="Records"> <ul class="md-nav__list"> <li class="md-nav__item"> <a href="#get-a-record" class="md-nav__link"> <span class="md-ellipsis"> Get a record </span> </a> </li> <li class="md-nav__item"> <a href="#search-records" class="md-nav__link"> <span class="md-ellipsis"> Search records </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item"> <a href="#record-files" class="md-nav__link"> <span class="md-ellipsis"> Record files </span> </a> <nav class="md-nav" aria-label="Record files"> <ul class="md-nav__list"> <li class="md-nav__item"> <a href="#list-a-records-files" class="md-nav__link"> <span class="md-ellipsis"> List a record's files </span> </a> </li> <li class="md-nav__item"> <a href="#get-a-record-files-metadata" class="md-nav__link"> <span class="md-ellipsis"> Get a record file's metadata </span> </a> </li> <li class="md-nav__item"> <a href="#download-a-record-file" class="md-nav__link"> <span class="md-ellipsis"> Download a record file </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item"> <a href="#versions" class="md-nav__link"> <span class="md-ellipsis"> Versions </span> </a> <nav class="md-nav" aria-label="Versions"> <ul class="md-nav__list"> <li class="md-nav__item"> <a href="#create-a-new-version" class="md-nav__link"> <span class="md-ellipsis"> Create a new version </span> </a> </li> <li class="md-nav__item"> <a href="#link-files-from-previous-version" class="md-nav__link"> <span class="md-ellipsis"> Link files from previous version </span> </a> </li> <li class="md-nav__item"> <a href="#get-all-versions" class="md-nav__link"> <span class="md-ellipsis"> Get all versions </span> </a> </li> <li class="md-nav__item"> <a href="#get-latest-version" class="md-nav__link"> <span class="md-ellipsis"> Get latest version </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item"> <a href="#access-links" class="md-nav__link"> <span class="md-ellipsis"> Access links </span> </a> <nav class="md-nav" aria-label="Access links"> <ul class="md-nav__list"> <li class="md-nav__item"> <a href="#create-an-access-link" class="md-nav__link"> <span class="md-ellipsis"> Create an access link </span> </a> </li> <li class="md-nav__item"> <a href="#get-an-access-link" class="md-nav__link"> <span class="md-ellipsis"> Get an access link </span> </a> </li> <li class="md-nav__item"> <a href="#update-an-access-link" class="md-nav__link"> <span class="md-ellipsis"> Update an access link </span> </a> </li> <li class="md-nav__item"> <a href="#delete-an-access-link" class="md-nav__link"> <span class="md-ellipsis"> Delete an access link </span> </a> </li> <li class="md-nav__item"> <a href="#list-access-links" class="md-nav__link"> <span class="md-ellipsis"> List access links </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item"> <a href="#user-records" class="md-nav__link"> <span class="md-ellipsis"> User Records </span> </a> <nav class="md-nav" aria-label="User Records"> <ul class="md-nav__list"> <li class="md-nav__item"> <a href="#list-your-draft-and-published-records" class="md-nav__link"> <span class="md-ellipsis"> List your draft and published records </span> </a> </li> </ul> </nav> </li> </ul> </nav> </li> <li class="md-nav__item"> <a href="../rest_api_groups/" class="md-nav__link"> <span class="md-ellipsis"> Groups </span> </a> </li> <li class="md-nav__item"> <a href="../rest_api_members/" class="md-nav__link"> <span class="md-ellipsis"> Members </span> </a> </li> <li class="md-nav__item"> <a href="../rest_api_requests/" class="md-nav__link"> <span class="md-ellipsis"> Requests </span> </a> </li> <li class="md-nav__item"> <a href="../rest_api_users/" class="md-nav__link"> <span class="md-ellipsis"> Users </span> </a> </li> <li class="md-nav__item"> <a href="../rest_api_reviews/" class="md-nav__link"> <span class="md-ellipsis"> Reviews </span> </a> </li> <li class="md-nav__item"> <a href="../rest_api_vocabularies/" class="md-nav__link"> <span class="md-ellipsis"> Vocabularies </span> </a> </li> <li class="md-nav__item"> <a href="../rest_api_names/" class="md-nav__link"> <span class="md-ellipsis"> Names </span> </a> </li> <li class="md-nav__item"> <a href="../rest_api_funders/" class="md-nav__link"> <span class="md-ellipsis"> Funders </span> </a> </li> <li class="md-nav__item"> <a href="../rest_api_awards/" class="md-nav__link"> <span class="md-ellipsis"> Awards </span> </a> </li> <li class="md-nav__item"> <a href="../rest_api_oaipmh_sets/" class="md-nav__link"> <span class="md-ellipsis"> OAI-PMH Sets </span> </a> </li> <li class="md-nav__item"> <a href="../rest_api_statistics/" class="md-nav__link"> <span class="md-ellipsis"> Statistics </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7_9" > <label class="md-nav__link" for="__nav_7_9" id="__nav_7_9_label" tabindex="0"> <span class="md-ellipsis"> Custom fields </span> <span class="md-nav__icon md-icon"></span> </label> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_7_9_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_7_9"> <span class="md-nav__icon md-icon"></span> Custom fields </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../custom_fields/widgets/" class="md-nav__link"> <span class="md-ellipsis"> UI widgets </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7_10" > <label class="md-nav__link" for="__nav_7_10" id="__nav_7_10_label" tabindex="0"> <span class="md-ellipsis"> Administration </span> <span class="md-nav__icon md-icon"></span> </label> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_7_10_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_7_10"> <span class="md-nav__icon md-icon"></span> Administration </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../administration_reference/" class="md-nav__link"> <span class="md-ellipsis"> Reference </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item"> <a href="../file_storage/" class="md-nav__link"> <span class="md-ellipsis"> File storage </span> </a> </li> <li class="md-nav__item"> <a href="../statistics/" class="md-nav__link"> <span class="md-ellipsis"> Usage statistics </span> </a> </li> <li class="md-nav__item"> <a href="../notifications/" class="md-nav__link"> <span class="md-ellipsis"> Notifications </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_8" > <label class="md-nav__link" for="__nav_8" id="__nav_8_label" tabindex="0"> <span class="md-ellipsis"> Releases </span> <span class="md-nav__icon md-icon"></span> </label> <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_8_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_8"> <span class="md-nav__icon md-icon"></span> Releases </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../releases/" class="md-nav__link"> <span class="md-ellipsis"> Overview </span> </a> </li> <li class="md-nav__item"> <a href="../../releases/maintenance-policy/" class="md-nav__link"> <span class="md-ellipsis"> Maintenance policy </span> </a> </li> <li class="md-nav__item"> <a href="../../releases/upgrade-policy/" class="md-nav__link"> <span class="md-ellipsis"> Upgrade policy </span> </a> </li> <li class="md-nav__item"> <a href="../../releases/security-policy/" class="md-nav__link"> <span class="md-ellipsis"> Security policy </span> </a> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_8_5" > <label class="md-nav__link" for="__nav_8_5" id="__nav_8_5_label" tabindex="0"> <span class="md-ellipsis"> Version v12.0 LTS </span> <span class="md-nav__icon md-icon"></span> </label> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_8_5_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_8_5"> <span class="md-nav__icon md-icon"></span> Version v12.0 LTS </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../releases/v12/version-v12.0.0/" class="md-nav__link"> <span class="md-ellipsis"> Release Notes v12.0 </span> </a> </li> <li class="md-nav__item"> <a href="../../releases/v12/upgrade-v12.0/" class="md-nav__link"> <span class="md-ellipsis"> Upgrade from v11 to v12 </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_8_6" > <label class="md-nav__link" for="__nav_8_6" id="__nav_8_6_label" tabindex="0"> <span class="md-ellipsis"> Version v11.0 STS </span> <span class="md-nav__icon md-icon"></span> </label> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_8_6_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_8_6"> <span class="md-nav__icon md-icon"></span> Version v11.0 STS </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../releases/v11/version-v11.0.0/" class="md-nav__link"> <span class="md-ellipsis"> Release Notes v11.0 </span> </a> </li> <li class="md-nav__item"> <a href="../../releases/v11/upgrade-v11.0/" class="md-nav__link"> <span class="md-ellipsis"> Upgrade from v10 to v11 </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_8_7" > <label class="md-nav__link" for="__nav_8_7" id="__nav_8_7_label" tabindex="0"> <span class="md-ellipsis"> Version v9.1 LTS </span> <span class="md-nav__icon md-icon"></span> </label> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_8_7_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_8_7"> <span class="md-nav__icon md-icon"></span> Version v9.1 LTS </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../releases/v9/version-v9.1.0/" class="md-nav__link"> <span class="md-ellipsis"> Release Notes v9.1 </span> </a> </li> <li class="md-nav__item"> <a href="../../releases/v9/version-v9.0.0/" class="md-nav__link"> <span class="md-ellipsis"> Release Notes v9.0 </span> </a> </li> <li class="md-nav__item"> <a href="../../releases/migrate-docker-images/" class="md-nav__link"> <span class="md-ellipsis"> Migrate Docker images </span> </a> </li> <li class="md-nav__item"> <a href="../../releases/v9/migrate-opensearch-v9/" class="md-nav__link"> <span class="md-ellipsis"> Migrate v9 to OpenSearch </span> </a> </li> <li class="md-nav__item"> <a href="../../releases/v9/upgrade-v9.0/" class="md-nav__link"> <span class="md-ellipsis"> Upgrade from v8 to v9 </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_8_8" > <label class="md-nav__link" for="__nav_8_8" id="__nav_8_8_label" tabindex="0"> <span class="md-ellipsis"> Legacy Versions </span> <span class="md-nav__icon md-icon"></span> </label> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_8_8_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_8_8"> <span class="md-nav__icon md-icon"></span> Legacy Versions </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_8_8_1" > <label class="md-nav__link" for="__nav_8_8_1" id="__nav_8_8_1_label" tabindex="0"> <span class="md-ellipsis"> Version v10.1 </span> <span class="md-nav__icon md-icon"></span> </label> <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_8_8_1_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_8_8_1"> <span class="md-nav__icon md-icon"></span> Version v10.1 </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../releases/v10/version-v10.1.0/" class="md-nav__link"> <span class="md-ellipsis"> Release Notes v10.1 </span> </a> </li> <li class="md-nav__item"> <a href="../../releases/v10/version-v10.0.0/" class="md-nav__link"> <span class="md-ellipsis"> Release Notes v10.0 </span> </a> </li> <li class="md-nav__item"> <a href="../../releases/v10/upgrade-v10.0/" class="md-nav__link"> <span class="md-ellipsis"> Upgrade from v9 to v10 </span> </a> </li> <li class="md-nav__item"> <a href="../../releases/migrate-docker-images/" class="md-nav__link"> <span class="md-ellipsis"> Migrate Docker images </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_8_8_2" > <label class="md-nav__link" for="__nav_8_8_2" id="__nav_8_8_2_label" tabindex="0"> <span class="md-ellipsis"> Version v8.0 </span> <span class="md-nav__icon md-icon"></span> </label> <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_8_8_2_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_8_8_2"> <span class="md-nav__icon md-icon"></span> Version v8.0 </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../releases/v8/version-v8.0.0/" class="md-nav__link"> <span class="md-ellipsis"> Release Notes v8.0 </span> </a> </li> <li class="md-nav__item"> <a href="../../releases/v8/upgrade-v8.0/" class="md-nav__link"> <span class="md-ellipsis"> Upgrade from v7 to v8 </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_8_8_3" > <label class="md-nav__link" for="__nav_8_8_3" id="__nav_8_8_3_label" tabindex="0"> <span class="md-ellipsis"> Version v7.0 </span> <span class="md-nav__icon md-icon"></span> </label> <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_8_8_3_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_8_8_3"> <span class="md-nav__icon md-icon"></span> Version v7.0 </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../releases/v7/version-v7.0.0/" class="md-nav__link"> <span class="md-ellipsis"> Release Notes v7.0 </span> </a> </li> <li class="md-nav__item"> <a href="../../releases/v7/upgrade-v7.0/" class="md-nav__link"> <span class="md-ellipsis"> Upgrade from v6 to v7 </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_8_8_4" > <label class="md-nav__link" for="__nav_8_8_4" id="__nav_8_8_4_label" tabindex="0"> <span class="md-ellipsis"> Version v6.0.5 </span> <span class="md-nav__icon md-icon"></span> </label> <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_8_8_4_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_8_8_4"> <span class="md-nav__icon md-icon"></span> Version v6.0.5 </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../releases/v6/version-v6.0.5/" class="md-nav__link"> <span class="md-ellipsis"> Release Notes v6.0.5 </span> </a> </li> <li class="md-nav__item"> <a href="../../releases/v6/upgrade-v6.0.5/" class="md-nav__link"> <span class="md-ellipsis"> Upgrade from v6.0.x to v6.0.5 </span> </a> </li> <li class="md-nav__item"> <a href="../../releases/v6/version-v6.0.0/" class="md-nav__link"> <span class="md-ellipsis"> Release Notes v6.0.0 </span> </a> </li> <li class="md-nav__item"> <a href="../../releases/v6/upgrade-v6.0/" class="md-nav__link"> <span class="md-ellipsis"> Upgrade from v4 to v6 </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_8_8_5" > <label class="md-nav__link" for="__nav_8_8_5" id="__nav_8_8_5_label" tabindex="0"> <span class="md-ellipsis"> Version v5.0 </span> <span class="md-nav__icon md-icon"></span> </label> <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_8_8_5_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_8_8_5"> <span class="md-nav__icon md-icon"></span> Version v5.0 </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../releases/v5/version-v5.0.0/" class="md-nav__link"> <span class="md-ellipsis"> Release Notes v5.0 </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_8_8_6" > <label class="md-nav__link" for="__nav_8_8_6" id="__nav_8_8_6_label" tabindex="0"> <span class="md-ellipsis"> Version v4.0 </span> <span class="md-nav__icon md-icon"></span> </label> <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_8_8_6_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_8_8_6"> <span class="md-nav__icon md-icon"></span> Version v4.0 </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../releases/v4/version-v4.0.0/" class="md-nav__link"> <span class="md-ellipsis"> Release Notes v4.0 </span> </a> </li> <li class="md-nav__item"> <a href="../../releases/v4/upgrade-v4.0/" class="md-nav__link"> <span class="md-ellipsis"> Upgrade from v3 to v4 </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_8_8_7" > <label class="md-nav__link" for="__nav_8_8_7" id="__nav_8_8_7_label" tabindex="0"> <span class="md-ellipsis"> Version v3.0 </span> <span class="md-nav__icon md-icon"></span> </label> <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_8_8_7_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_8_8_7"> <span class="md-nav__icon md-icon"></span> Version v3.0 </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../releases/v3/version-v3.0.0/" class="md-nav__link"> <span class="md-ellipsis"> Release Notes v3.0 </span> </a> </li> <li class="md-nav__item"> <a href="../../releases/v3/upgrade-v3.0/" class="md-nav__link"> <span class="md-ellipsis"> Upgrade from v2 to v3 </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_8_8_8" > <label class="md-nav__link" for="__nav_8_8_8" id="__nav_8_8_8_label" tabindex="0"> <span class="md-ellipsis"> Version v2.0 </span> <span class="md-nav__icon md-icon"></span> </label> <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_8_8_8_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_8_8_8"> <span class="md-nav__icon md-icon"></span> Version v2.0 </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../releases/v2/version-v2.0.0/" class="md-nav__link"> <span class="md-ellipsis"> Release Notes v2.0 </span> </a> </li> <li class="md-nav__item"> <a href="../../releases/v2/upgrade-v2.0/" class="md-nav__link"> <span class="md-ellipsis"> Upgrade from v1 to v2 </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_8_8_9" > <label class="md-nav__link" for="__nav_8_8_9" id="__nav_8_8_9_label" tabindex="0"> <span class="md-ellipsis"> Version v1.0 </span> <span class="md-nav__icon md-icon"></span> </label> <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_8_8_9_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_8_8_9"> <span class="md-nav__icon md-icon"></span> Version v1.0 </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../releases/v1/version-v1.0.0/" class="md-nav__link"> <span class="md-ellipsis"> Release Notes v1.0 </span> </a> </li> </ul> </nav> </li> </ul> </nav> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_9" > <label class="md-nav__link" for="__nav_9" id="__nav_9_label" tabindex="0"> <span class="md-ellipsis"> Maintainers </span> <span class="md-nav__icon md-icon"></span> </label> <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_9_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_9"> <span class="md-nav__icon md-icon"></span> Maintainers </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../maintenance/" class="md-nav__link"> <span class="md-ellipsis"> Overview </span> </a> </li> <li class="md-nav__item"> <a href="../../maintenance/newcomers/" class="md-nav__link"> <span class="md-ellipsis"> Newcomers </span> </a> </li> <li class="md-nav__item"> <a href="../../maintenance/board-workflow/" class="md-nav__link"> <span class="md-ellipsis"> Sprintboard workflow </span> </a> </li> <li class="md-nav__item"> <a href="../../maintenance/pr-community-board/" class="md-nav__link"> <span class="md-ellipsis"> Community PR board </span> </a> </li> <li class="md-nav__item"> <a href="../../maintenance/release-management/" class="md-nav__link"> <span class="md-ellipsis"> Release management </span> </a> </li> <li class="md-nav__item"> <a href="../../maintenance/modules/" class="md-nav__link"> <span class="md-ellipsis"> Modules on GitHub </span> </a> </li> <li class="md-nav__item"> <a href="../../maintenance/branch-management/" class="md-nav__link"> <span class="md-ellipsis"> Branch management </span> </a> </li> <li class="md-nav__item"> <a href="../../maintenance/demosite/" class="md-nav__link"> <span class="md-ellipsis"> Demo site & docs </span> </a> </li> <li class="md-nav__item"> <a href="../../maintenance/docker-images/" class="md-nav__link"> <span class="md-ellipsis"> Docker images </span> </a> </li> <li class="md-nav__item"> <a href="../../maintenance/rfcs/" class="md-nav__link"> <span class="md-ellipsis"> RFCs </span> </a> </li> <li class="md-nav__item"> <a href="../../maintenance/documentation/" class="md-nav__link"> <span class="md-ellipsis"> Writing documentation </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_10" > <label class="md-nav__link" for="__nav_10" id="__nav_10_label" tabindex="0"> <span class="md-ellipsis"> Onboard & Contribute </span> <span class="md-nav__icon md-icon"></span> </label> <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_10_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_10"> <span class="md-nav__icon md-icon"></span> Onboard & Contribute </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../contribute/" class="md-nav__link"> <span class="md-ellipsis"> Overview </span> </a> </li> <li class="md-nav__item"> <a href="../../contribute/onboarding/" class="md-nav__link"> <span class="md-ellipsis"> Onboarding </span> </a> </li> <li class="md-nav__item"> <a href="../../contribute/code-of-conduct/" class="md-nav__link"> <span class="md-ellipsis"> Code of conduct </span> </a> </li> <li class="md-nav__item"> <a href="../../contribute/copyright-policy/" class="md-nav__link"> <span class="md-ellipsis"> Copyright policy </span> </a> </li> <li class="md-nav__item"> <a href="../../contribute/roadmap/" class="md-nav__link"> <span class="md-ellipsis"> Roadmap </span> </a> </li> <li class="md-nav__item"> <a href="../../contribute/translators-guide/" class="md-nav__link"> <span class="md-ellipsis"> Translators guide </span> </a> </li> </ul> </nav> </li> </ul> </nav> </div> </div> </div> <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" > <div class="md-sidebar__scrollwrap"> <div class="md-sidebar__inner"> <nav class="md-nav md-nav--secondary" aria-label="Table of contents"> <label class="md-nav__title" for="__toc"> <span class="md-nav__icon md-icon"></span> Table of contents </label> <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix> <li class="md-nav__item"> <a href="#drafts" class="md-nav__link"> <span class="md-ellipsis"> Drafts </span> </a> <nav class="md-nav" aria-label="Drafts"> <ul class="md-nav__list"> <li class="md-nav__item"> <a href="#create-a-draft-record" class="md-nav__link"> <span class="md-ellipsis"> Create a draft record </span> </a> <nav class="md-nav" aria-label="Create a draft record"> <ul class="md-nav__list"> <li class="md-nav__item"> <a href="#files-options" class="md-nav__link"> <span class="md-ellipsis"> Files Options </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item"> <a href="#get-a-draft-record" class="md-nav__link"> <span class="md-ellipsis"> Get a draft record </span> </a> </li> <li class="md-nav__item"> <a href="#update-a-draft-record" class="md-nav__link"> <span class="md-ellipsis"> Update a draft record </span> </a> </li> <li class="md-nav__item"> <a href="#publish-a-draft-record" class="md-nav__link"> <span class="md-ellipsis"> Publish a draft record </span> </a> </li> <li class="md-nav__item"> <a href="#edit-a-published-record-create-a-draft-record-from-a-published-record" class="md-nav__link"> <span class="md-ellipsis"> Edit a published record (Create a draft record from a published record) </span> </a> </li> <li class="md-nav__item"> <a href="#deletediscard-a-draft-record" class="md-nav__link"> <span class="md-ellipsis"> Delete/discard a draft record </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item"> <a href="#draft-files" class="md-nav__link"> <span class="md-ellipsis"> Draft files </span> </a> <nav class="md-nav" aria-label="Draft files"> <ul class="md-nav__list"> <li class="md-nav__item"> <a href="#list-a-drafts-files" class="md-nav__link"> <span class="md-ellipsis"> List a draft's files </span> </a> </li> <li class="md-nav__item"> <a href="#start-draft-file-uploads" class="md-nav__link"> <span class="md-ellipsis"> Start draft file upload(s) </span> </a> </li> <li class="md-nav__item"> <a href="#upload-a-draft-files-content" class="md-nav__link"> <span class="md-ellipsis"> Upload a draft file's content </span> </a> </li> <li class="md-nav__item"> <a href="#complete-a-draft-file-upload" class="md-nav__link"> <span class="md-ellipsis"> Complete a draft file upload </span> </a> </li> <li class="md-nav__item"> <a href="#get-a-draft-files-metadata" class="md-nav__link"> <span class="md-ellipsis"> Get a draft file's metadata </span> </a> </li> <li class="md-nav__item"> <a href="#download-a-draft-file" class="md-nav__link"> <span class="md-ellipsis"> Download a draft file </span> </a> </li> <li class="md-nav__item"> <a href="#delete-a-draft-file" class="md-nav__link"> <span class="md-ellipsis"> Delete a draft file </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item"> <a href="#records" class="md-nav__link"> <span class="md-ellipsis"> Records </span> </a> <nav class="md-nav" aria-label="Records"> <ul class="md-nav__list"> <li class="md-nav__item"> <a href="#get-a-record" class="md-nav__link"> <span class="md-ellipsis"> Get a record </span> </a> </li> <li class="md-nav__item"> <a href="#search-records" class="md-nav__link"> <span class="md-ellipsis"> Search records </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item"> <a href="#record-files" class="md-nav__link"> <span class="md-ellipsis"> Record files </span> </a> <nav class="md-nav" aria-label="Record files"> <ul class="md-nav__list"> <li class="md-nav__item"> <a href="#list-a-records-files" class="md-nav__link"> <span class="md-ellipsis"> List a record's files </span> </a> </li> <li class="md-nav__item"> <a href="#get-a-record-files-metadata" class="md-nav__link"> <span class="md-ellipsis"> Get a record file's metadata </span> </a> </li> <li class="md-nav__item"> <a href="#download-a-record-file" class="md-nav__link"> <span class="md-ellipsis"> Download a record file </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item"> <a href="#versions" class="md-nav__link"> <span class="md-ellipsis"> Versions </span> </a> <nav class="md-nav" aria-label="Versions"> <ul class="md-nav__list"> <li class="md-nav__item"> <a href="#create-a-new-version" class="md-nav__link"> <span class="md-ellipsis"> Create a new version </span> </a> </li> <li class="md-nav__item"> <a href="#link-files-from-previous-version" class="md-nav__link"> <span class="md-ellipsis"> Link files from previous version </span> </a> </li> <li class="md-nav__item"> <a href="#get-all-versions" class="md-nav__link"> <span class="md-ellipsis"> Get all versions </span> </a> </li> <li class="md-nav__item"> <a href="#get-latest-version" class="md-nav__link"> <span class="md-ellipsis"> Get latest version </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item"> <a href="#access-links" class="md-nav__link"> <span class="md-ellipsis"> Access links </span> </a> <nav class="md-nav" aria-label="Access links"> <ul class="md-nav__list"> <li class="md-nav__item"> <a href="#create-an-access-link" class="md-nav__link"> <span class="md-ellipsis"> Create an access link </span> </a> </li> <li class="md-nav__item"> <a href="#get-an-access-link" class="md-nav__link"> <span class="md-ellipsis"> Get an access link </span> </a> </li> <li class="md-nav__item"> <a href="#update-an-access-link" class="md-nav__link"> <span class="md-ellipsis"> Update an access link </span> </a> </li> <li class="md-nav__item"> <a href="#delete-an-access-link" class="md-nav__link"> <span class="md-ellipsis"> Delete an access link </span> </a> </li> <li class="md-nav__item"> <a href="#list-access-links" class="md-nav__link"> <span class="md-ellipsis"> List access links </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item"> <a href="#user-records" class="md-nav__link"> <span class="md-ellipsis"> User Records </span> </a> <nav class="md-nav" aria-label="User Records"> <ul class="md-nav__list"> <li class="md-nav__item"> <a href="#list-your-draft-and-published-records" class="md-nav__link"> <span class="md-ellipsis"> List your draft and published records </span> </a> </li> </ul> </nav> </li> </ul> </nav> </div> </div> </div> <div class="md-content" data-md-component="content"> <article class="md-content__inner md-typeset"> <h1 id="drafts-and-records">Drafts and Records<a class="headerlink" href="#drafts-and-records" title="Permanent link">¶</a></h1> <h2 id="drafts">Drafts<a class="headerlink" href="#drafts" title="Permanent link">¶</a></h2> <p>Used for interacting with unpublished or edited draft records.</p> <div class="admonition info"> <p class="admonition-title">Authentication required</p> <p>All requests to the draft-related REST API endpoints require authentication.</p> </div> <h3 id="create-a-draft-record">Create a draft record<a class="headerlink" href="#create-a-draft-record" title="Permanent link">¶</a></h3> <p><code>POST /api/records</code></p> <p><strong>Parameters</strong></p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Location</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>access</code></td> <td>object</td> <td>body</td> <td><a href="../metadata/#access">Access options</a> for the record.</td> </tr> <tr> <td><code>files</code></td> <td>object</td> <td>body</td> <td>Files options (see below) for the record.</td> </tr> <tr> <td><code>metadata</code></td> <td>object</td> <td>body</td> <td><a href="../metadata/#metadata">Metadata</a> of the record.</td> </tr> <tr> <td><code>custom_fields</code></td> <td>object</td> <td>body</td> <td><a href="../../customize/metadata/custom_fields/records/#declaring-custom-fields">Custom fields</a> metadata for the record. (v10 and newer)</td> </tr> </tbody> </table> <h4 id="files-options">Files Options<a class="headerlink" href="#files-options" title="Permanent link">¶</a></h4> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Location</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>enabled</code></td> <td>boolean</td> <td>body</td> <td><em>Required</em>. Should (and can) files be attached to this record or not.</td> </tr> <tr> <td><code>default_preview</code> </td> <td>string</td> <td>body</td> <td>Filename of file to be previewed by default.</td> </tr> <tr> <td><code>order</code></td> <td>array</td> <td>body</td> <td>Array of filename strings in display order.</td> </tr> </tbody> </table> <p>A file must be uploaded to the draft before it can be used as the default preview. See "<a href="#start-draft-file-uploads">Start a draft file upload</a>" below.</p> <p><strong>Request</strong></p> <div class="highlight"><pre><span></span><code><span class="nf">POST</span> <span class="nn">/api/records</span> <span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> <span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span> <span class="p">{</span> <span class="w"> </span><span class="nt">"access"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"record"</span><span class="p">:</span><span class="w"> </span><span class="s2">"public"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"files"</span><span class="p">:</span><span class="w"> </span><span class="s2">"public"</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="nt">"files"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"enabled"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="nt">"metadata"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"creators"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span> <span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"person_or_org"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"family_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Brown"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"given_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Troy"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"personal"</span> <span class="w"> </span><span class="p">}</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"person_or_org"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"family_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Collins"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"given_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Thomas"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"identifiers"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span> <span class="w"> </span><span class="p">{</span><span class="nt">"scheme"</span><span class="p">:</span><span class="w"> </span><span class="s2">"orcid"</span><span class="p">,</span><span class="w"> </span><span class="nt">"identifier"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0000-0002-1825-0097"</span><span class="p">}</span> <span class="w"> </span><span class="p">],</span> <span class="w"> </span><span class="nt">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Collins, Thomas"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"personal"</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="nt">"affiliations"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span> <span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"01ggx4157"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Entity One"</span> <span class="w"> </span><span class="p">}</span> <span class="w"> </span><span class="p">]</span> <span class="w"> </span><span class="p">}</span> <span class="w"> </span><span class="p">],</span> <span class="w"> </span><span class="nt">"publication_date"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2020-06-01"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"resource_type"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="nt">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"image-photo"</span><span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="nt">"title"</span><span class="p">:</span><span class="w"> </span><span class="s2">"A Romans story"</span><span class="p">,</span> <span class="w"> </span><span class="p">}</span> <span class="p">}</span> </code></pre></div> <p><strong>Response</strong></p> <div class="highlight"><pre><span></span><code><span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> <span class="m">201</span> <span class="ne">CREATED</span> <span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span> <span class="p">{</span> <span class="w"> </span><span class="nt">"access"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"record"</span><span class="p">:</span><span class="w"> </span><span class="s2">"public"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"files"</span><span class="p">:</span><span class="w"> </span><span class="s2">"public"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"embargo"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"reason"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span> <span class="w"> </span><span class="nt">"active"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span> <span class="w"> </span><span class="p">}</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="nt">"created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2020-11-27 10:52:23.945755"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"expires_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2020-11-27 10:52:23.945868"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"files"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"enabled"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="nt">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"{id}"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"is_published"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span> <span class="w"> </span><span class="nt">"links"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"latest"</span><span class="p">:</span><span class="w"> </span><span class="s2">"{scheme+hostname}/api/records/{id}/versions/latest"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"versions"</span><span class="p">:</span><span class="w"> </span><span class="s2">"{scheme+hostname}/api/records/{id}/versions"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"self_html"</span><span class="p">:</span><span class="w"> </span><span class="s2">"{scheme+hostname}/uploads/{id}"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"publish"</span><span class="p">:</span><span class="w"> </span><span class="s2">"{scheme+hostname}/api/records/{id}/draft/actions/publish"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"latest_html"</span><span class="p">:</span><span class="w"> </span><span class="s2">"{scheme+hostname}/records/{id}/latest"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"self"</span><span class="p">:</span><span class="w"> </span><span class="s2">"{scheme+hostname}/api/records/{id}/draft"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"files"</span><span class="p">:</span><span class="w"> </span><span class="s2">"{scheme+hostname}/api/records/{id}/draft/files"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"access_links"</span><span class="p">:</span><span class="w"> </span><span class="s2">"{scheme+hostname}/api/records/{id}/access/links"</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="nt">"metadata"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"resource_type"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"image-photo"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"title"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"en"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Photo"</span> <span class="w"> </span><span class="p">}</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="nt">"title"</span><span class="p">:</span><span class="w"> </span><span class="s2">"A Romans story"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"publication_date"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2020-06-01"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"creators"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span> <span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"person_or_org"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"family_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Brown"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"given_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Troy"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"personal"</span> <span class="w"> </span><span class="p">}</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"person_or_org"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"family_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Collins"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"given_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Thomas"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"identifiers"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span> <span class="w"> </span><span class="p">{</span><span class="nt">"scheme"</span><span class="p">:</span><span class="w"> </span><span class="s2">"orcid"</span><span class="p">,</span><span class="w"> </span><span class="nt">"identifier"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0000-0002-1825-0097"</span><span class="p">}</span> <span class="w"> </span><span class="p">],</span> <span class="w"> </span><span class="nt">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Collins, Thomas"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"personal"</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="nt">"affiliations"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span> <span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"01ggx4157"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"European Organization for Nuclear Research"</span> <span class="w"> </span><span class="p">}</span> <span class="w"> </span><span class="p">]</span> <span class="w"> </span><span class="p">}</span> <span class="w"> </span><span class="p">],</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="nt">"parent"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"{parent-id}"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"access"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"owned_by"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"user"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="err">user</span><span class="mi">-</span><span class="err">id</span><span class="p">}</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="nt">"links"</span><span class="p">:</span><span class="w"> </span><span class="p">[]</span> <span class="w"> </span><span class="p">}</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="nt">"pids"</span><span class="p">:</span><span class="w"> </span><span class="p">{},</span> <span class="w"> </span><span class="nt">"revision_id"</span><span class="p">:</span><span class="w"> </span><span class="mi">3</span><span class="p">,</span> <span class="w"> </span><span class="nt">"updated"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2020-11-27 10:52:23.969244"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"versions"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"index"</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span> <span class="w"> </span><span class="nt">"is_latest"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span> <span class="w"> </span><span class="nt">"is_latest_draft"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span> <span class="w"> </span><span class="p">}</span> <span class="p">}</span> </code></pre></div> <p>Note how if a name and id are given for an affiliation identifiers. The instance's name it has for the given id is used e.g. "Entity One" is replaced by "European Organization for Nuclear Research" above.</p> <h3 id="get-a-draft-record">Get a draft record<a class="headerlink" href="#get-a-draft-record" title="Permanent link">¶</a></h3> <p><code>GET /api/records/{id}/draft</code></p> <p><strong>Parameters</strong></p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Location</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>id</code></td> <td>string</td> <td>path</td> <td>Identifier of the record, e.g. <code>4d0ns-ntd89</code></td> </tr> <tr> <td><code>accept</code></td> <td>string</td> <td>header</td> <td>- <code>application/json</code> (default)<br />- <code>application/vnd.inveniordm.v1+json</code></td> </tr> </tbody> </table> <p><strong>Request</strong></p> <div class="highlight"><pre><span></span><code><span class="nf">GET</span> <span class="nn">/api/records/{id}/draft</span> <span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> <span class="na">Accept</span><span class="o">:</span> <span class="l">application/json</span> </code></pre></div> <p><strong>Response</strong></p> <div class="highlight"><pre><span></span><code><span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> <span class="m">200</span> <span class="ne">OK</span> <span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span> <span class="p">{</span> <span class="w"> </span><span class="nt">"access"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"record"</span><span class="p">:</span><span class="w"> </span><span class="s2">"public"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"files"</span><span class="p">:</span><span class="w"> </span><span class="s2">"public"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"embargo"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"reason"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span> <span class="w"> </span><span class="nt">"active"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span> <span class="w"> </span><span class="p">}</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="nt">"created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2020-11-27 10:52:23.945755"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"expires_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2020-11-27 10:52:23.945868"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"files"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"enabled"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="nt">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"{id}"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"is_published"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span> <span class="w"> </span><span class="nt">"links"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"latest"</span><span class="p">:</span><span class="w"> </span><span class="s2">"{scheme+hostname}/api/records/{id}/versions/latest"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"versions"</span><span class="p">:</span><span class="w"> </span><span class="s2">"{scheme+hostname}/api/records/{id}/versions"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"self_html"</span><span class="p">:</span><span class="w"> </span><span class="s2">"{scheme+hostname}/uploads/{id}"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"publish"</span><span class="p">:</span><span class="w"> </span><span class="s2">"{scheme+hostname}/api/records/{id}/draft/actions/publish"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"latest_html"</span><span class="p">:</span><span class="w"> </span><span class="s2">"{scheme+hostname}/records/{id}/latest"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"self"</span><span class="p">:</span><span class="w"> </span><span class="s2">"{scheme+hostname}/api/records/{id}/draft"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"files"</span><span class="p">:</span><span class="w"> </span><span class="s2">"{scheme+hostname}/api/records/{id}/draft/files"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"access_links"</span><span class="p">:</span><span class="w"> </span><span class="s2">"{scheme+hostname}/api/records/{id}/access/links"</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="nt">"metadata"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"resource_type"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"image-photo"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"title"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"en"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Photo"</span> <span class="w"> </span><span class="p">}</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="nt">"title"</span><span class="p">:</span><span class="w"> </span><span class="s2">"A Romans story"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"publication_date"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2020-06-01"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"creators"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span> <span class="w"> </span><span class="nt">"person_or_org"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"family_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Brown"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"given_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Troy"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"personal"</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"person_or_org"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"family_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Collins"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"given_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Thomas"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"identifiers"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span> <span class="w"> </span><span class="p">{</span><span class="nt">"scheme"</span><span class="p">:</span><span class="w"> </span><span class="s2">"orcid"</span><span class="p">,</span><span class="w"> </span><span class="nt">"identifier"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0000-0002-1825-0097"</span><span class="p">}</span> <span class="w"> </span><span class="p">],</span> <span class="w"> </span><span class="nt">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Collins, Thomas"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"personal"</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="nt">"affiliations"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span> <span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"01ggx4157"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"European Organization for Nuclear Research"</span> <span class="w"> </span><span class="p">}</span> <span class="w"> </span><span class="p">]</span> <span class="w"> </span><span class="p">}</span> <span class="w"> </span><span class="p">],</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="nt">"parent"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"{parent-id}"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"access"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"owned_by"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"user"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="err">user</span><span class="mi">-</span><span class="err">id</span><span class="p">}</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="nt">"links"</span><span class="p">:</span><span class="w"> </span><span class="p">[]</span> <span class="w"> </span><span class="p">}</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="nt">"pids"</span><span class="p">:</span><span class="w"> </span><span class="p">{},</span> <span class="w"> </span><span class="nt">"revision_id"</span><span class="p">:</span><span class="w"> </span><span class="mi">3</span><span class="p">,</span> <span class="w"> </span><span class="nt">"updated"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2020-11-27 10:52:23.969244"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"versions"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"index"</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span> <span class="w"> </span><span class="nt">"is_latest"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span> <span class="w"> </span><span class="nt">"is_latest_draft"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span> <span class="w"> </span><span class="p">}</span> <span class="p">}</span> </code></pre></div> <h3 id="update-a-draft-record">Update a draft record<a class="headerlink" href="#update-a-draft-record" title="Permanent link">¶</a></h3> <p><code>PUT /api/records/{id}/draft</code></p> <p><strong>Parameters</strong></p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Location</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>id</code></td> <td>string</td> <td>path</td> <td>Identifier of the record, e.g. <code>4d0ns-ntd89</code></td> </tr> <tr> <td><code>access</code></td> <td>object</td> <td>body</td> <td><a href="../metadata/#access">Access options</a> for the record.</td> </tr> <tr> <td><code>files</code></td> <td>object</td> <td>body</td> <td><a href="#files-options">Files options</a> for the record.</td> </tr> <tr> <td><code>metadata</code></td> <td>object</td> <td>body</td> <td><a href="../metadata/#metadata">Metadata</a> of the record.</td> </tr> <tr> <td><code>custom_fields</code></td> <td>object</td> <td>body</td> <td><a href="../../customize/metadata/custom_fields/records/#declaring-custom-fields">Custom fields</a> metadata for the record. (v10 and newer)</td> </tr> </tbody> </table> <p><strong>Request</strong></p> <div class="highlight"><pre><span></span><code><span class="nf">PUT</span> <span class="nn">/api/records/{id}/draft</span> <span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> <span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span> <span class="p">{</span> <span class="w"> </span><span class="nt">"access"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"record"</span><span class="p">:</span><span class="w"> </span><span class="s2">"restricted"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"files"</span><span class="p">:</span><span class="w"> </span><span class="s2">"restricted"</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="nt">"files"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"enabled"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="nt">"metadata"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"creators"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span> <span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"person_or_org"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"family_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Brown"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"given_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Troy"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"personal"</span> <span class="w"> </span><span class="p">}</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"person_or_org"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"family_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Collins"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"given_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Thomas"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"identifiers"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span> <span class="w"> </span><span class="p">{</span><span class="nt">"scheme"</span><span class="p">:</span><span class="w"> </span><span class="s2">"orcid"</span><span class="p">,</span><span class="w"> </span><span class="nt">"identifier"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0000-0002-1825-0097"</span><span class="p">}</span> <span class="w"> </span><span class="p">],</span> <span class="w"> </span><span class="nt">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Collins, Thomas"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"personal"</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="nt">"affiliations"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span> <span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"01ggx4157"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Entity One"</span> <span class="w"> </span><span class="p">}</span> <span class="w"> </span><span class="p">]</span> <span class="w"> </span><span class="p">}</span> <span class="w"> </span><span class="p">],</span> <span class="w"> </span><span class="nt">"publication_date"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2020-06-01"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"resource_type"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="nt">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"image-photo"</span><span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="nt">"title"</span><span class="p">:</span><span class="w"> </span><span class="s2">"An Updated Romans story"</span> <span class="w"> </span><span class="p">}</span> <span class="p">}</span> </code></pre></div> <p><strong>Response</strong></p> <div class="highlight"><pre><span></span><code><span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> <span class="m">200</span> <span class="ne">OK</span> <span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span> <span class="p">{</span> <span class="w"> </span><span class="nt">"access"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"record"</span><span class="p">:</span><span class="w"> </span><span class="s2">"restricted"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"files"</span><span class="p">:</span><span class="w"> </span><span class="s2">"restricted"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"embargo"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"reason"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span> <span class="w"> </span><span class="nt">"active"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span> <span class="w"> </span><span class="p">}</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="nt">"created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2020-11-27 10:52:23.945755"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"expires_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2020-11-27 10:52:23.945868"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"files"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"enabled"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="nt">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"{id}"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"is_published"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span> <span class="w"> </span><span class="nt">"links"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"latest"</span><span class="p">:</span><span class="w"> </span><span class="s2">"{scheme+hostname}/api/records/{id}/versions/latest"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"versions"</span><span class="p">:</span><span class="w"> </span><span class="s2">"{scheme+hostname}/api/records/{id}/versions"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"self_html"</span><span class="p">:</span><span class="w"> </span><span class="s2">"{scheme+hostname}/uploads/{id}"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"publish"</span><span class="p">:</span><span class="w"> </span><span class="s2">"{scheme+hostname}/api/records/{id}/draft/actions/publish"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"latest_html"</span><span class="p">:</span><span class="w"> </span><span class="s2">"{scheme+hostname}/records/{id}/latest"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"self"</span><span class="p">:</span><span class="w"> </span><span class="s2">"{scheme+hostname}/api/records/{id}/draft"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"files"</span><span class="p">:</span><span class="w"> </span><span class="s2">"{scheme+hostname}/api/records/{id}/draft/files"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"access_links"</span><span class="p">:</span><span class="w"> </span><span class="s2">"{scheme+hostname}/api/records/{id}/access/links"</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="nt">"metadata"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"resource_type"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"image-photo"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"title"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"en"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Photo"</span> <span class="w"> </span><span class="p">}</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="nt">"title"</span><span class="p">:</span><span class="w"> </span><span class="s2">"An Updated Romans story"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"publication_date"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2020-06-01"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"creators"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span> <span class="w"> </span><span class="nt">"person_or_org"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"family_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Brown"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"given_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Troy"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"personal"</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"person_or_org"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"family_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Collins"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"given_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Thomas"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"identifiers"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span> <span class="w"> </span><span class="p">{</span><span class="nt">"scheme"</span><span class="p">:</span><span class="w"> </span><span class="s2">"orcid"</span><span class="p">,</span><span class="w"> </span><span class="nt">"identifier"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0000-0002-1825-0097"</span><span class="p">}</span> <span class="w"> </span><span class="p">],</span> <span class="w"> </span><span class="nt">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Collins, Thomas"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"personal"</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="nt">"affiliations"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span> <span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"01ggx4157"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"European Organization for Nuclear Research"</span> <span class="w"> </span><span class="p">}</span> <span class="w"> </span><span class="p">]</span> <span class="w"> </span><span class="p">}</span> <span class="w"> </span><span class="p">],</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="nt">"parent"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"{parent-id}"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"access"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"owned_by"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"user"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="err">user</span><span class="mi">-</span><span class="err">id</span><span class="p">}</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="nt">"links"</span><span class="p">:</span><span class="w"> </span><span class="p">[]</span> <span class="w"> </span><span class="p">}</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="nt">"pids"</span><span class="p">:</span><span class="w"> </span><span class="p">{},</span> <span class="w"> </span><span class="nt">"revision_id"</span><span class="p">:</span><span class="w"> </span><span class="mi">3</span><span class="p">,</span> <span class="w"> </span><span class="nt">"updated"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2020-11-27 10:52:23.969244"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"versions"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"index"</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span> <span class="w"> </span><span class="nt">"is_latest"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span> <span class="w"> </span><span class="nt">"is_latest_draft"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span> <span class="w"> </span><span class="p">}</span> <span class="p">}</span> </code></pre></div> <h3 id="publish-a-draft-record">Publish a draft record<a class="headerlink" href="#publish-a-draft-record" title="Permanent link">¶</a></h3> <p><code>POST /api/records/{id}/draft/actions/publish</code></p> <p><strong>Parameters</strong></p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Location</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>id</code></td> <td>string</td> <td>path</td> <td>Identifier of the record, e.g. <code>4d0ns-ntd89</code></td> </tr> </tbody> </table> <p><strong>Request</strong></p> <div class="highlight"><pre><span></span><code><span class="nf">POST</span> <span class="nn">/api/records/{id}/draft/actions/publish</span> <span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> </code></pre></div> <p><strong>Response</strong></p> <div class="highlight"><pre><span></span><code><span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> <span class="m">202</span> <span class="ne">ACCEPTED</span> <span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span> <span class="p">{</span> <span class="w"> </span><span class="nt">"access"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"record"</span><span class="p">:</span><span class="w"> </span><span class="s2">"restricted"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"files"</span><span class="p">:</span><span class="w"> </span><span class="s2">"restricted"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"embargo"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"reason"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span> <span class="w"> </span><span class="nt">"active"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span> <span class="w"> </span><span class="p">}</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="nt">"created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2020-11-27 10:52:23.945755"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"expires_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2020-11-27 10:52:23.945868"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"files"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"enabled"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="nt">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"{id}"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"is_published"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span> <span class="w"> </span><span class="nt">"links"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"latest"</span><span class="p">:</span><span class="w"> </span><span class="s2">"{scheme+hostname}/api/records/{id}/versions/latest"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"versions"</span><span class="p">:</span><span class="w"> </span><span class="s2">"{scheme+hostname}/api/records/{id}/versions"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"self_html"</span><span class="p">:</span><span class="w"> </span><span class="s2">"{scheme+hostname}/records/{id}"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"latest_html"</span><span class="p">:</span><span class="w"> </span><span class="s2">"{scheme+hostname}/records/{id}/latest"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"self"</span><span class="p">:</span><span class="w"> </span><span class="s2">"{scheme+hostname}/api/records/{id}"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"files"</span><span class="p">:</span><span class="w"> </span><span class="s2">"{scheme+hostname}/api/records/{id}/files"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"access_links"</span><span class="p">:</span><span class="w"> </span><span class="s2">"{scheme+hostname}/api/records/{id}/access/links"</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="nt">"metadata"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"resource_type"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"image-photo"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"title"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"en"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Photo"</span> <span class="w"> </span><span class="p">}</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="nt">"title"</span><span class="p">:</span><span class="w"> </span><span class="s2">"An Updated Romans story"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"publication_date"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2020-06-01"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"creators"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span> <span class="w"> </span><span class="nt">"person_or_org"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"family_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Brown"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"given_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Troy"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"personal"</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"person_or_org"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"family_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Collins"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"given_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Thomas"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"identifiers"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span> <span class="w"> </span><span class="p">{</span><span class="nt">"scheme"</span><span class="p">:</span><span class="w"> </span><span class="s2">"orcid"</span><span class="p">,</span><span class="w"> </span><span class="nt">"identifier"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0000-0002-1825-0097"</span><span class="p">}</span> <span class="w"> </span><span class="p">],</span> <span class="w"> </span><span class="nt">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Collins, Thomas"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"personal"</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="nt">"affiliations"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span> <span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"01ggx4157"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"European Organization for Nuclear Research"</span> <span class="w"> </span><span class="p">}</span> <span class="w"> </span><span class="p">]</span> <span class="w"> </span><span class="p">}</span> <span class="w"> </span><span class="p">],</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="nt">"parent"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"{parent-id}"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"access"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"owned_by"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"user"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="err">user</span><span class="mi">-</span><span class="err">id</span><span class="p">}</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="nt">"links"</span><span class="p">:</span><span class="w"> </span><span class="p">[]</span> <span class="w"> </span><span class="p">}</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="nt">"pids"</span><span class="p">:</span><span class="w"> </span><span class="p">{},</span> <span class="w"> </span><span class="nt">"revision_id"</span><span class="p">:</span><span class="w"> </span><span class="mi">3</span><span class="p">,</span> <span class="w"> </span><span class="nt">"updated"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2020-11-27 10:52:23.969244"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"versions"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"index"</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span> <span class="w"> </span><span class="nt">"is_latest"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span> <span class="w"> </span><span class="nt">"is_latest_draft"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span> <span class="w"> </span><span class="p">}</span> <span class="p">}</span> </code></pre></div> <h3 id="edit-a-published-record-create-a-draft-record-from-a-published-record">Edit a published record (Create a draft record from a published record)<a class="headerlink" href="#edit-a-published-record-create-a-draft-record-from-a-published-record" title="Permanent link">¶</a></h3> <p><code>POST /api/records/{id}/draft</code></p> <p><strong>Parameters</strong></p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Location</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>id</code></td> <td>string</td> <td>path</td> <td>Identifier of the record, e.g. <code>4d0ns-ntd89</code></td> </tr> </tbody> </table> <p><strong>Request</strong></p> <div class="highlight"><pre><span></span><code><span class="nf">POST</span> <span class="nn">/api/records/{id}/draft</span> <span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> </code></pre></div> <p><strong>Response</strong></p> <div class="highlight"><pre><span></span><code><span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> <span class="m">201</span> <span class="ne">CREATED</span> <span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span> <span class="p">{</span> <span class="w"> </span><span class="nt">"access"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"record"</span><span class="p">:</span><span class="w"> </span><span class="s2">"restricted"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"files"</span><span class="p">:</span><span class="w"> </span><span class="s2">"restricted"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"embargo"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"reason"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span> <span class="w"> </span><span class="nt">"active"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span> <span class="w"> </span><span class="p">}</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="nt">"created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2020-11-27 10:52:23.945755"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"expires_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2020-11-27 10:52:23.945868"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"files"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"enabled"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="nt">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"{id}"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"is_published"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span> <span class="w"> </span><span class="nt">"links"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"latest"</span><span class="p">:</span><span class="w"> </span><span class="s2">"{scheme+hostname}/api/records/{id}/versions/latest"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"versions"</span><span class="p">:</span><span class="w"> </span><span class="s2">"{scheme+hostname}/api/records/{id}/versions"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"self_html"</span><span class="p">:</span><span class="w"> </span><span class="s2">"{scheme+hostname}/uploads/{id}"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"publish"</span><span class="p">:</span><span class="w"> </span><span class="s2">"{scheme+hostname}/api/records/{id}/draft/actions/publish"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"latest_html"</span><span class="p">:</span><span class="w"> </span><span class="s2">"{scheme+hostname}/records/{id}/latest"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"self"</span><span class="p">:</span><span class="w"> </span><span class="s2">"{scheme+hostname}/api/records/{id}/draft"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"files"</span><span class="p">:</span><span class="w"> </span><span class="s2">"{scheme+hostname}/api/records/{id}/draft/files"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"access_links"</span><span class="p">:</span><span class="w"> </span><span class="s2">"{scheme+hostname}/api/records/{id}/access/links"</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="nt">"metadata"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"resource_type"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"image-photo"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"title"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"en"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Photo"</span> <span class="w"> </span><span class="p">}</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="nt">"title"</span><span class="p">:</span><span class="w"> </span><span class="s2">"An Updated Romans story"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"publication_date"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2020-06-01"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"creators"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span> <span class="w"> </span><span class="nt">"person_or_org"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"family_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Brown"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"given_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Troy"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"personal"</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"person_or_org"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"family_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Collins"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"given_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Thomas"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"identifiers"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span> <span class="w"> </span><span class="p">{</span><span class="nt">"scheme"</span><span class="p">:</span><span class="w"> </span><span class="s2">"orcid"</span><span class="p">,</span><span class="w"> </span><span class="nt">"identifier"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0000-0002-1825-0097"</span><span class="p">}</span> <span class="w"> </span><span class="p">],</span> <span class="w"> </span><span class="nt">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Collins, Thomas"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"personal"</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="nt">"affiliations"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span> <span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"01ggx4157"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"European Organization for Nuclear Research"</span> <span class="w"> </span><span class="p">}</span> <span class="w"> </span><span class="p">]</span> <span class="w"> </span><span class="p">}</span> <span class="w"> </span><span class="p">],</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="nt">"parent"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"{parent-id}"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"access"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"owned_by"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"user"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="err">user</span><span class="mi">-</span><span class="err">id</span><span class="p">}</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="nt">"links"</span><span class="p">:</span><span class="w"> </span><span class="p">[]</span> <span class="w"> </span><span class="p">}</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="nt">"pids"</span><span class="p">:</span><span class="w"> </span><span class="p">{},</span> <span class="w"> </span><span class="nt">"revision_id"</span><span class="p">:</span><span class="w"> </span><span class="mi">3</span><span class="p">,</span> <span class="w"> </span><span class="nt">"updated"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2020-11-27 10:52:23.969244"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"versions"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"index"</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span> <span class="w"> </span><span class="nt">"is_latest"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span> <span class="w"> </span><span class="nt">"is_latest_draft"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span> <span class="w"> </span><span class="p">}</span> <span class="p">}</span> </code></pre></div> <h3 id="deletediscard-a-draft-record">Delete/discard a draft record<a class="headerlink" href="#deletediscard-a-draft-record" title="Permanent link">¶</a></h3> <p><code>DELETE /api/records/{id}/draft</code></p> <p>Deleting a draft for an unpublished record will remove the draft and associated files from the system.</p> <p>Deleting a draft for a published record will remove the draft but not the published record.</p> <p><strong>Parameters</strong></p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Location</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>id</code></td> <td>string</td> <td>path</td> <td>Identifier of the record, e.g. <code>4d0ns-ntd89</code></td> </tr> </tbody> </table> <p><strong>Request</strong></p> <div class="highlight"><pre><span></span><code><span class="nf">DELETE</span> <span class="nn">/api/records/{id}/draft</span> <span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> </code></pre></div> <p><strong>Response</strong></p> <div class="highlight"><pre><span></span><code><span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> <span class="m">204</span> <span class="ne">No Content</span> </code></pre></div> <h2 id="draft-files">Draft files<a class="headerlink" href="#draft-files" title="Permanent link">¶</a></h2> <p>Used to manage a draft's files.</p> <div class="admonition info"> <p class="admonition-title">Authentication required</p> <p>All requests to the draft-related REST API endpoints require authentication.</p> </div> <h3 id="list-a-drafts-files">List a draft's files<a class="headerlink" href="#list-a-drafts-files" title="Permanent link">¶</a></h3> <p><code>GET /api/records/{id}/draft/files</code></p> <p><strong>Parameters</strong></p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Location</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>id</code></td> <td>string</td> <td>path</td> <td>Identifier of the record, e.g. <code>4d0ns-ntd89</code></td> </tr> </tbody> </table> <p><strong>Request</strong></p> <div class="highlight"><pre><span></span><code><span class="nf">GET</span> <span class="nn">/api/records/{id}/draft/files</span> <span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> </code></pre></div> <p><strong>Response</strong></p> <div class="highlight"><pre><span></span><code><span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> <span class="m">200</span> <span class="ne">OK</span> <span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span> <span class="p">{</span> <span class="w"> </span><span class="nt">"default_preview"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span> <span class="w"> </span><span class="nt">"enabled"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span> <span class="w"> </span><span class="nt">"entries"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span> <span class="w"> </span><span class="nt">"links"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"self"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/records/{id}/draft/files"</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="nt">"order"</span><span class="p">:</span><span class="w"> </span><span class="p">[]</span> <span class="p">}</span> </code></pre></div> <h3 id="start-draft-file-uploads">Start draft file upload(s)<a class="headerlink" href="#start-draft-file-uploads" title="Permanent link">¶</a></h3> <p><code>POST /api/records/{id}/draft/files</code></p> <p><strong>Parameters</strong></p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Location</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>id</code></td> <td>string</td> <td>path</td> <td>Identifier of the record, e.g. <code>4d0ns-ntd89</code></td> </tr> <tr> <td><code><top-level></code></td> <td>array</td> <td>body</td> <td>Array of objects describing the file uploads to be initialized.</td> </tr> <tr> <td><code>[].key</code></td> <td>string</td> <td>body</td> <td>Name of the file to be uploaded.</td> </tr> </tbody> </table> <p><strong>Request</strong></p> <div class="highlight"><pre><span></span><code><span class="nf">POST</span> <span class="nn">/api/records/{id}/draft/files</span> <span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> <span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span> <span class="p">[</span> <span class="w"> </span><span class="p">{</span><span class="nt">"key"</span><span class="p">:</span><span class="w"> </span><span class="s2">"figure.png"</span><span class="p">},</span> <span class="w"> </span><span class="p">{</span><span class="nt">"key"</span><span class="p">:</span><span class="w"> </span><span class="s2">"article.pdf"</span><span class="p">},</span> <span class="w"> </span><span class="p">{</span><span class="nt">"key"</span><span class="p">:</span><span class="w"> </span><span class="s2">"data.zip"</span><span class="p">}</span> <span class="p">]</span> </code></pre></div> <p><strong>Response</strong></p> <div class="highlight"><pre><span></span><code><span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> <span class="m">201</span> <span class="ne">CREATED</span> <span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span> <span class="p">{</span> <span class="w"> </span><span class="nt">"enabled"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span> <span class="w"> </span><span class="nt">"default_preview"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span> <span class="w"> </span><span class="nt">"order"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span> <span class="w"> </span><span class="nt">"entries"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span> <span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"key"</span><span class="p">:</span><span class="w"> </span><span class="s2">"figure.png"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"updated"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2020-11-27 11:17:11.002624"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2020-11-27 11:17:10.998919"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"metadata"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span> <span class="w"> </span><span class="nt">"status"</span><span class="p">:</span><span class="w"> </span><span class="s2">"pending"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"links"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"content"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/records/{id}/draft/files/figure.png/content"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"self"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/records/{id}/draft/files/figure.png"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"commit"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/records/{id}/draft/files/figure.png/commit"</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"key"</span><span class="p">:</span><span class="w"> </span><span class="s2">"article.pdf"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"updated"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2020-11-27 11:17:11.002624"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2020-11-27 11:17:10.998919"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"metadata"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span> <span class="w"> </span><span class="nt">"status"</span><span class="p">:</span><span class="w"> </span><span class="s2">"pending"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"links"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"content"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/records/{id}/draft/files/article.pdf/content"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"self"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/records/{id}/draft/files/article.pdf"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"commit"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/records/{id}/draft/files/article.pdf/commit"</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"key"</span><span class="p">:</span><span class="w"> </span><span class="s2">"data.zip"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"updated"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2020-11-27 11:17:11.002624"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2020-11-27 11:17:10.998919"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"metadata"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span> <span class="w"> </span><span class="nt">"status"</span><span class="p">:</span><span class="w"> </span><span class="s2">"pending"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"links"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"content"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/records/{id}/draft/files/data.zip/content"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"self"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/records/{id}/draft/files/data.zip"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"commit"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/records/{id}/draft/files/data.zip/commit"</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="p">}</span> <span class="w"> </span><span class="p">],</span> <span class="w"> </span><span class="nt">"links"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"self"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/records/{id}/draft/files"</span> <span class="w"> </span><span class="p">},</span> <span class="p">}</span> </code></pre></div> <h3 id="upload-a-draft-files-content">Upload a draft file's content<a class="headerlink" href="#upload-a-draft-files-content" title="Permanent link">¶</a></h3> <p><code>PUT /api/records/{id}/draft/files/{filename}/content</code></p> <p><strong>Parameters</strong></p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Location</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>id</code></td> <td>string</td> <td>path</td> <td>Identifier of the record, e.g. <code>4d0ns-ntd89</code></td> </tr> <tr> <td><code>filename</code></td> <td>string</td> <td>path</td> <td>Name of the file.</td> </tr> <tr> <td><code>content-type</code></td> <td>string</td> <td>header</td> <td>Should always be <code>application/octet-stream</code>.</td> </tr> <tr> <td><code>content-length</code></td> <td>integer</td> <td>header</td> <td>Size of the content in bytes (optional).</td> </tr> <tr> <td><code><content></code></td> <td>bytes</td> <td>body</td> <td>The raw bytes of the file content to be uploaded.</td> </tr> </tbody> </table> <p><strong>Request</strong></p> <div class="highlight"><pre><span></span><code><span class="nf">PUT</span> <span class="nn">/api/records/{id}/draft/files/{filename}/content</span> <span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> <span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/octet-stream</span> <...file binary data...> </code></pre></div> <p><strong>Response</strong></p> <div class="highlight"><pre><span></span><code><span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> <span class="m">200</span> <span class="ne">OK</span> <span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span> <span class="p">{</span> <span class="w"> </span><span class="nt">"key"</span><span class="p">:</span><span class="w"> </span><span class="s2">"{filename}"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"updated"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2020-11-27 11:17:11.002624"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2020-11-27 11:17:10.998919"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"metadata"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span> <span class="w"> </span><span class="nt">"status"</span><span class="p">:</span><span class="w"> </span><span class="s2">"pending"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"links"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"content"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/records/{id}/draft/files/{filename}/content"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"self"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/records/{id}/draft/files/{filename}"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"commit"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/records/{id}/draft/files/{filename}/commit"</span> <span class="w"> </span><span class="p">},</span> <span class="p">}</span> </code></pre></div> <p><strong>Code sample</strong></p> <div class="highlight"><pre><span></span><code>curl<span class="w"> </span><span class="se">\</span> <span class="w"> </span>--request<span class="w"> </span>PUT<span class="w"> </span><span class="se">\</span> <span class="w"> </span>--header<span class="w"> </span><span class="s2">"Content-Type: application/octet-stream"</span><span class="w"> </span><span class="se">\</span> <span class="w"> </span>https://127.0.0.1:5000//api/records/<span class="o">{</span>id<span class="o">}</span>/draft/files/<span class="o">{</span>filename<span class="o">}</span>/content<span class="w"> </span><span class="se">\</span> <span class="w"> </span>--upload-file<span class="w"> </span>/path/to/file </code></pre></div> <h3 id="complete-a-draft-file-upload">Complete a draft file upload<a class="headerlink" href="#complete-a-draft-file-upload" title="Permanent link">¶</a></h3> <p><code>POST /api/records/{id}/draft/files/{filename}/commit</code></p> <p><strong>Parameters</strong></p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Location</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>id</code></td> <td>string</td> <td>path</td> <td>Identifier of the record, e.g. <code>4d0ns-ntd89</code></td> </tr> <tr> <td><code>filename</code></td> <td>string</td> <td>path</td> <td>Name of the file.</td> </tr> </tbody> </table> <p><strong>Request</strong></p> <div class="highlight"><pre><span></span><code><span class="nf">POST</span> <span class="nn">/api/records/{id}/draft/files/{filename}/commit</span> <span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> </code></pre></div> <p><strong>Response</strong></p> <div class="highlight"><pre><span></span><code><span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> <span class="m">200</span> <span class="ne">OK</span> <span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span> <span class="p">{</span> <span class="w"> </span><span class="nt">"key"</span><span class="p">:</span><span class="w"> </span><span class="s2">"{filename}"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"updated"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2020-11-27 11:26:04.607831"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2020-11-27 11:17:10.998919"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"checksum"</span><span class="p">:</span><span class="w"> </span><span class="s2">"md5:6ef4267f0e710357c895627e931f16cd"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"mimetype"</span><span class="p">:</span><span class="w"> </span><span class="s2">"image/png"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"size"</span><span class="p">:</span><span class="w"> </span><span class="mf">89364.0</span><span class="p">,</span> <span class="w"> </span><span class="nt">"status"</span><span class="p">:</span><span class="w"> </span><span class="s2">"completed"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"metadata"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span> <span class="w"> </span><span class="nt">"file_id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2151fa94-6dc3-4965-8df9-ec73ceb9175c"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"version_id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"57ad8c66-b934-49c9-a46f-38bf5aa0374f"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"bucket_id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"90b5b318-114a-4b87-bc9d-0d018b9363d3"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"storage_class"</span><span class="p">:</span><span class="w"> </span><span class="s2">"S"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"links"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"content"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/records/{id}/draft/files/{filename}/content"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"self"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/records/{id}/draft/files/{filename}"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"commit"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/records/{id}/draft/files/{filename}/commit"</span> <span class="w"> </span><span class="p">},</span> <span class="p">}</span> </code></pre></div> <h3 id="get-a-draft-files-metadata">Get a draft file's metadata<a class="headerlink" href="#get-a-draft-files-metadata" title="Permanent link">¶</a></h3> <p><code>GET /api/records/{id}/draft/files/{filename}</code></p> <p><strong>Parameters</strong></p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Location</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>id</code></td> <td>string</td> <td>path</td> <td>Identifier of the record, e.g. <code>4d0ns-ntd89</code></td> </tr> <tr> <td><code>filename</code></td> <td>string</td> <td>path</td> <td>Name of the file.</td> </tr> </tbody> </table> <p><strong>Request</strong></p> <div class="highlight"><pre><span></span><code><span class="nf">GET</span> <span class="nn">/api/records/{id}/draft/files/{filename}</span> <span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> </code></pre></div> <p><strong>Response</strong></p> <div class="highlight"><pre><span></span><code><span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> <span class="m">200</span> <span class="ne">OK</span> <span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span> <span class="p">{</span> <span class="w"> </span><span class="nt">"key"</span><span class="p">:</span><span class="w"> </span><span class="s2">"{filename}"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"updated"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2020-11-27 11:26:04.607831"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2020-11-27 11:17:10.998919"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"checksum"</span><span class="p">:</span><span class="w"> </span><span class="s2">"md5:6ef4267f0e710357c895627e931f16cd"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"mimetype"</span><span class="p">:</span><span class="w"> </span><span class="s2">"image/png"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"size"</span><span class="p">:</span><span class="w"> </span><span class="mf">89364.0</span><span class="p">,</span> <span class="w"> </span><span class="nt">"status"</span><span class="p">:</span><span class="w"> </span><span class="s2">"completed"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"metadata"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"width"</span><span class="p">:</span><span class="w"> </span><span class="mi">960</span><span class="p">,</span> <span class="w"> </span><span class="nt">"height"</span><span class="p">:</span><span class="w"> </span><span class="mi">640</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="nt">"file_id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2151fa94-6dc3-4965-8df9-ec73ceb9175c"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"version_id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"57ad8c66-b934-49c9-a46f-38bf5aa0374f"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"bucket_id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"90b5b318-114a-4b87-bc9d-0d018b9363d3"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"storage_class"</span><span class="p">:</span><span class="w"> </span><span class="s2">"S"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"links"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"content"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/records/{id}/draft/files/{filename}/content"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"self"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/records/{id}/draft/files/{filename}"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"commit"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/records/{id}/draft/files/{filename}/commit"</span> <span class="w"> </span><span class="p">},</span> <span class="p">}</span> </code></pre></div> <h3 id="download-a-draft-file">Download a draft file<a class="headerlink" href="#download-a-draft-file" title="Permanent link">¶</a></h3> <p><code>GET /api/records/{id}/draft/files/{filename}/content</code></p> <p><strong>Parameters</strong></p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Location</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>id</code></td> <td>string</td> <td>path</td> <td>Identifier of the record, e.g. <code>cbc2k-q9x58</code></td> </tr> <tr> <td><code>filename</code></td> <td>string</td> <td>path</td> <td>Name of a file</td> </tr> </tbody> </table> <p><strong>Request</strong></p> <div class="highlight"><pre><span></span><code><span class="nf">GET</span> <span class="nn">/api/records/{id}/draft/files/{filename}/content</span> <span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> </code></pre></div> <p><strong>Response</strong></p> <div class="highlight"><pre><span></span><code><span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> <span class="m">200</span> <span class="ne">OK</span> <span class="na">Content-Disposition</span><span class="o">:</span> <span class="l">inline</span> <span class="na">Content-Length</span><span class="o">:</span> <span class="l">76122</span> <span class="na">Content-MD5</span><span class="o">:</span> <span class="l">71449104d017a6056ac1a5fb58754975</span> <span class="na">Content-Type</span><span class="o">:</span> <span class="l">image/pdf</span> <span class="na">Date</span><span class="o">:</span> <span class="l">Thu, 26 Nov 2020 18:35:33 GMT</span> <span class="na">ETag</span><span class="o">:</span> <span class="l">"md5:71449104d017a6056ac1a5fb58754975"</span> <span class="na">Last-Modified</span><span class="o">:</span> <span class="l">Thu, 26 Nov 2020 14:30:06 GMT</span> <...file binary data...> </code></pre></div> <h3 id="delete-a-draft-file">Delete a draft file<a class="headerlink" href="#delete-a-draft-file" title="Permanent link">¶</a></h3> <p><code>DELETE /api/records/{id}/draft/files/{filename}</code></p> <p><strong>Parameters</strong></p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Location</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>id</code></td> <td>string</td> <td>path</td> <td>Identifier of the record, e.g. <code>4d0ns-ntd89</code></td> </tr> <tr> <td><code>filename</code></td> <td>string</td> <td>path</td> <td>Name of the file.</td> </tr> </tbody> </table> <p><strong>Request</strong></p> <div class="highlight"><pre><span></span><code><span class="nf">DELETE</span> <span class="nn">/api/records/{id}/draft/files/{filename}</span> <span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> </code></pre></div> <p><strong>Response</strong></p> <div class="highlight"><pre><span></span><code><span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> <span class="m">204</span> <span class="ne">No Content</span> </code></pre></div> <h2 id="records">Records<a class="headerlink" href="#records" title="Permanent link">¶</a></h2> <p>Used for interacting with published records.</p> <h3 id="get-a-record">Get a record<a class="headerlink" href="#get-a-record" title="Permanent link">¶</a></h3> <p><code>GET /api/records/{id}</code></p> <p><strong>Parameters</strong></p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Location</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>id</code></td> <td>string</td> <td>path</td> <td>Identifier of the record, e.g. <code>cbc2k-q9x58</code></td> </tr> <tr> <td><code>accept</code></td> <td>string</td> <td>header</td> <td>- <code>application/json</code> (default)<br />- <code>application/vnd.inveniordm.v1+json</code></td> </tr> </tbody> </table> <p><strong>Request</strong></p> <div class="highlight"><pre><span></span><code><span class="nf">GET</span> <span class="nn">/api/records/{id}</span> <span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> </code></pre></div> <p><strong>Response</strong></p> <div class="highlight"><pre><span></span><code><span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> <span class="m">200</span> <span class="ne">OK</span> <span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span> <span class="p">{</span> <span class="w"> </span><span class="nt">"access"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"record"</span><span class="p">:</span><span class="w"> </span><span class="s2">"restricted"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"files"</span><span class="p">:</span><span class="w"> </span><span class="s2">"restricted"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"embargo"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"reason"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span> <span class="w"> </span><span class="nt">"active"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span> <span class="w"> </span><span class="p">}</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="nt">"created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2020-11-27 10:52:23.945755"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"expires_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2020-11-27 10:52:23.945868"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"files"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"enabled"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="nt">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"{id}"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"is_published"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span> <span class="w"> </span><span class="nt">"links"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"latest"</span><span class="p">:</span><span class="w"> </span><span class="s2">"{scheme+hostname}/api/records/{id}/versions/latest"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"versions"</span><span class="p">:</span><span class="w"> </span><span class="s2">"{scheme+hostname}/api/records/{id}/versions"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"self_html"</span><span class="p">:</span><span class="w"> </span><span class="s2">"{scheme+hostname}/records/{id}"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"latest_html"</span><span class="p">:</span><span class="w"> </span><span class="s2">"{scheme+hostname}/records/{id}/latest"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"self"</span><span class="p">:</span><span class="w"> </span><span class="s2">"{scheme+hostname}/api/records/{id}"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"self_iiif_manifest"</span><span class="p">:</span><span class="w"> </span><span class="s2">"{scheme+hostname}/api/records/{id}/manifest"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"self_iiif_sequence"</span><span class="p">:</span><span class="w"> </span><span class="s2">"{scheme+hostname}/api/records/{id}/sequence/default"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"files"</span><span class="p">:</span><span class="w"> </span><span class="s2">"{scheme+hostname}/api/records/{id}/files"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"access_links"</span><span class="p">:</span><span class="w"> </span><span class="s2">"{scheme+hostname}/api/records/{id}/access/links"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"communities"</span><span class="p">:</span><span class="w"> </span><span class="s2">"{scheme+hostname}/api/records/{id}/communities"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"requests"</span><span class="p">:</span><span class="w"> </span><span class="s2">"{scheme+hostname}/api/records/{id}/requests"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"communities-suggestions"</span><span class="p">:</span><span class="w"> </span><span class="s2">"{scheme+hostname}/api/records/{id}/communities-suggestions"</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="nt">"metadata"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"resource_type"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"image-photo"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"title"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"en"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Photo"</span> <span class="w"> </span><span class="p">}</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="nt">"title"</span><span class="p">:</span><span class="w"> </span><span class="s2">"An Updated Romans story"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"publication_date"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2020-06-01"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"creators"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span> <span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"person_or_org"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"given_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Troy"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"personal"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Brown, Troy"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"family_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Brown"</span> <span class="w"> </span><span class="p">}</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"person_or_org"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"family_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Collins"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"given_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Thomas"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"identifiers"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span> <span class="w"> </span><span class="p">{</span><span class="nt">"scheme"</span><span class="p">:</span><span class="w"> </span><span class="s2">"orcid"</span><span class="p">,</span><span class="w"> </span><span class="nt">"identifier"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0000-0002-1825-0097"</span><span class="p">}</span> <span class="w"> </span><span class="p">],</span> <span class="w"> </span><span class="nt">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Collins, Thomas"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"personal"</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="nt">"affiliations"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span> <span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"01ggx4157"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"European Organization for Nuclear Research"</span> <span class="w"> </span><span class="p">}</span> <span class="w"> </span><span class="p">]</span> <span class="w"> </span><span class="p">}</span> <span class="w"> </span><span class="p">],</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="nt">"parent"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"{parent-id}"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"access"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"owned_by"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"user"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="err">user</span><span class="mi">-</span><span class="err">id</span><span class="p">}</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="nt">"links"</span><span class="p">:</span><span class="w"> </span><span class="p">[]</span> <span class="w"> </span><span class="p">}</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="nt">"pids"</span><span class="p">:</span><span class="w"> </span><span class="p">{},</span> <span class="w"> </span><span class="nt">"revision_id"</span><span class="p">:</span><span class="w"> </span><span class="mi">3</span><span class="p">,</span> <span class="w"> </span><span class="nt">"updated"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2020-11-27 10:52:23.969244"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"versions"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"index"</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span> <span class="w"> </span><span class="nt">"is_latest"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span> <span class="w"> </span><span class="nt">"is_latest_draft"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span> <span class="w"> </span><span class="p">}</span> <span class="p">}</span> </code></pre></div> <h3 id="search-records">Search records<a class="headerlink" href="#search-records" title="Permanent link">¶</a></h3> <p><strong>Parameters</strong></p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Location</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>q</code></td> <td>string</td> <td>query</td> <td>Search query used to filter results based on <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-query-string-query.html#query-string-syntax">ElasticSearch's query string syntax</a>.</td> </tr> <tr> <td><code>sort</code></td> <td>string</td> <td>query</td> <td>Sort search results. Customizable. Built-in options are <code>"bestmatch"</code>, <code>"newest"</code>, <code>"oldest"</code>, <code>"updated-desc"</code>, <code>"updated-asc"</code>, <code>"version"</code>, <code>"mostviewed"</code>, <code>"mostdownloaded"</code> (default: <code>"bestmatch"</code> or <code>"newest"</code>).</td> </tr> <tr> <td><code>size</code></td> <td>integer</td> <td>query</td> <td>Specify number of items in the results page (default: 10).</td> </tr> <tr> <td><code>page</code></td> <td>integer</td> <td>query</td> <td>Specify the page of results.</td> </tr> <tr> <td><code>allversions</code> </td> <td>boolean</td> <td>query</td> <td>Specify if all versions should be included (default: <code>False</code>, displays just latest version).</td> </tr> <tr> <td><code>accept</code></td> <td>string</td> <td>header</td> <td>- <code>application/json</code> (default)<br />- <code>application/vnd.inveniordm.v1+json</code></td> </tr> </tbody> </table> <p>Sort options for records can be configured using the <code>RDM_SORT_OPTIONS</code> config variable as described in the <a href="../../customize/search/">search customization</a> section. Note that <code>"bestmatch"</code> is only available as a sort option on requests that provide a query string as a <code>q</code> parameter. Otherwise <code>"bestmatch"</code> is ignored and the default <code>"newest"</code> sort is used. Queries sorted by <code>"mostviewed"</code> and <code>"mostdownloaded"</code> are in descending order.</p> <p><strong>Request</strong></p> <div class="highlight"><pre><span></span><code><span class="nf">GET</span> <span class="nn">/api/records</span> <span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> </code></pre></div> <p><strong>Response</strong></p> <div class="highlight"><pre><span></span><code><span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> <span class="m">200</span> <span class="ne">OK</span> <span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span> <span class="p">{</span> <span class="w"> </span><span class="nt">"aggregations"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="err">...</span><span class="p">},</span> <span class="w"> </span><span class="nt">"hits"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="err">...</span><span class="p">},</span> <span class="w"> </span><span class="nt">"links"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="err">...</span><span class="p">},</span> <span class="w"> </span><span class="nt">"sortBy"</span><span class="p">:</span><span class="w"> </span><span class="err">...</span><span class="p">,</span> <span class="p">}</span> </code></pre></div> <p>Each hit looks like a record above.</p> <h2 id="record-files">Record files<a class="headerlink" href="#record-files" title="Permanent link">¶</a></h2> <p>Used for interacting with files of published records.</p> <h3 id="list-a-records-files">List a record's files<a class="headerlink" href="#list-a-records-files" title="Permanent link">¶</a></h3> <p><code>GET /api/records/{id}/files</code></p> <p><strong>Parameters</strong></p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Location</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>id</code></td> <td>string</td> <td>path</td> <td>Identifier of the record, e.g. <code>cbc2k-q9x58</code></td> </tr> <tr> <td><code>accept</code></td> <td>string</td> <td>header</td> <td>- <code>application/json</code> (default)</td> </tr> </tbody> </table> <p><strong>Request</strong></p> <div class="highlight"><pre><span></span><code><span class="nf">GET</span> <span class="nn">/api/records/{id}/files</span> <span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> </code></pre></div> <p><strong>Response</strong></p> <div class="highlight"><pre><span></span><code><span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> <span class="m">200</span> <span class="ne">OK</span> <span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span> <span class="p">{</span> <span class="w"> </span><span class="nt">"enabled"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span> <span class="w"> </span><span class="nt">"default_preview"</span><span class="p">:</span><span class="w"> </span><span class="s2">"article.pdf"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"order"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span> <span class="w"> </span><span class="nt">"entries"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span> <span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"key"</span><span class="p">:</span><span class="w"> </span><span class="s2">"article.pdf"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2020-11-26 14:30:53.911912"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"updated"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2020-11-26 14:30:53.920544"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"checksum"</span><span class="p">:</span><span class="w"> </span><span class="s2">"md5:71449104d017a6056ac1a5fb58754975"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"mimetype"</span><span class="p">:</span><span class="w"> </span><span class="s2">"application/pdf"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"size"</span><span class="p">:</span><span class="w"> </span><span class="mi">76122</span><span class="p">,</span> <span class="w"> </span><span class="nt">"status"</span><span class="p">:</span><span class="w"> </span><span class="s2">"completed"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"metadata"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="err">...</span><span class="p">},</span> <span class="w"> </span><span class="nt">"file_id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"..."</span><span class="p">,</span> <span class="w"> </span><span class="nt">"version_id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"..."</span><span class="p">,</span> <span class="w"> </span><span class="nt">"bucket_id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"..."</span><span class="p">,</span> <span class="w"> </span><span class="nt">"storage_class"</span><span class="p">:</span><span class="w"> </span><span class="s2">"S"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"links"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"content"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/records/{id}/files/article.pdf/content"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"self"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/records/{id}/files/article.pdf"</span> <span class="w"> </span><span class="p">}</span> <span class="w"> </span><span class="p">}</span> <span class="w"> </span><span class="p">]</span> <span class="w"> </span><span class="nt">"links"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="err">...</span><span class="p">},</span> <span class="p">}</span> </code></pre></div> <h3 id="get-a-record-files-metadata">Get a record file's metadata<a class="headerlink" href="#get-a-record-files-metadata" title="Permanent link">¶</a></h3> <p><code>GET /api/records/{id}/files/{filename}</code></p> <p><strong>Parameters</strong></p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Location</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>id</code></td> <td>string</td> <td>path</td> <td>Identifier of the record, e.g. <code>cbc2k-q9x58</code></td> </tr> <tr> <td><code>filename</code></td> <td>string</td> <td>path</td> <td>Name of a file</td> </tr> <tr> <td><code>accept</code></td> <td>string</td> <td>header</td> <td>- <code>application/json</code> (default)</td> </tr> </tbody> </table> <p><strong>Request</strong></p> <div class="highlight"><pre><span></span><code><span class="nf">GET</span> <span class="nn">/api/records/{id}/files/{filename}</span> <span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> </code></pre></div> <p><strong>Response</strong></p> <div class="highlight"><pre><span></span><code><span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> <span class="m">200</span> <span class="ne">OK</span> <span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span> <span class="p">{</span> <span class="w"> </span><span class="nt">"key"</span><span class="p">:</span><span class="w"> </span><span class="s2">"{filename}"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2020-11-26 14:30:53.911912"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"updated"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2020-11-26 14:30:53.920544"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"checksum"</span><span class="p">:</span><span class="w"> </span><span class="s2">"md5:71449104d017a6056ac1a5fb58754975"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"mimetype"</span><span class="p">:</span><span class="w"> </span><span class="s2">"application/pdf"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"size"</span><span class="p">:</span><span class="w"> </span><span class="mi">76122</span><span class="p">,</span> <span class="w"> </span><span class="nt">"status"</span><span class="p">:</span><span class="w"> </span><span class="s2">"completed"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"metadata"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="err">...</span><span class="p">},</span> <span class="w"> </span><span class="nt">"file_id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"..."</span><span class="p">,</span> <span class="w"> </span><span class="nt">"version_id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"..."</span><span class="p">,</span> <span class="w"> </span><span class="nt">"bucket_id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"..."</span><span class="p">,</span> <span class="w"> </span><span class="nt">"storage_class"</span><span class="p">:</span><span class="w"> </span><span class="s2">"S"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"links"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"content"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/records/{id}/files/{filename}/content"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"self"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/records/{id}/files/{filename}"</span> <span class="w"> </span><span class="p">}</span> <span class="p">}</span> </code></pre></div> <h3 id="download-a-record-file">Download a record file<a class="headerlink" href="#download-a-record-file" title="Permanent link">¶</a></h3> <p><code>GET /api/records/{id}/files/{filename}/content</code></p> <p><strong>Parameters</strong></p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Location</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>id</code></td> <td>string</td> <td>path</td> <td>Identifier of the record, e.g. <code>cbc2k-q9x58</code></td> </tr> <tr> <td><code>filename</code></td> <td>string</td> <td>path</td> <td>Name of a file</td> </tr> </tbody> </table> <p><strong>Request</strong></p> <div class="highlight"><pre><span></span><code><span class="nf">GET</span> <span class="nn">/api/records/{id}/files/{filename}/content</span> <span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> </code></pre></div> <p><strong>Response</strong></p> <div class="highlight"><pre><span></span><code><span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> <span class="m">200</span> <span class="ne">OK</span> <span class="na">Content-Disposition</span><span class="o">:</span> <span class="l">inline</span> <span class="na">Content-Length</span><span class="o">:</span> <span class="l">76122</span> <span class="na">Content-MD5</span><span class="o">:</span> <span class="l">71449104d017a6056ac1a5fb58754975</span> <span class="na">Content-Type</span><span class="o">:</span> <span class="l">image/pdf</span> <span class="na">Date</span><span class="o">:</span> <span class="l">Thu, 26 Nov 2020 18:35:33 GMT</span> <span class="na">ETag</span><span class="o">:</span> <span class="l">"md5:71449104d017a6056ac1a5fb58754975"</span> <span class="na">Last-Modified</span><span class="o">:</span> <span class="l">Thu, 26 Nov 2020 14:30:06 GMT</span> <...file binary data...> </code></pre></div> <h2 id="versions">Versions<a class="headerlink" href="#versions" title="Permanent link">¶</a></h2> <p>Used for interacting with record versions.</p> <h3 id="create-a-new-version">Create a new version<a class="headerlink" href="#create-a-new-version" title="Permanent link">¶</a></h3> <p><code>POST /api/records/{id}/versions</code></p> <p><strong>Parameters</strong></p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Location</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>id</code></td> <td>string</td> <td>path</td> <td>Identifier of the record, e.g. <code>4d0ns-ntd89</code></td> </tr> </tbody> </table> <p><strong>Request</strong></p> <div class="highlight"><pre><span></span><code><span class="nf">POST</span> <span class="nn">/api/records/{id}/versions</span> <span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> </code></pre></div> <p><strong>Response</strong></p> <div class="highlight"><pre><span></span><code><span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> <span class="m">201</span> <span class="ne">OK</span> <span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span> <span class="p">{</span> <span class="w"> </span><span class="nt">"access"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"record"</span><span class="p">:</span><span class="w"> </span><span class="s2">"restricted"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"files"</span><span class="p">:</span><span class="w"> </span><span class="s2">"restricted"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"embargo"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"reason"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span> <span class="w"> </span><span class="nt">"active"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span> <span class="w"> </span><span class="p">}</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="nt">"created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2020-11-27 10:52:23.945755"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"expires_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2020-11-27 10:52:23.945868"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"files"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"enabled"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="nt">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"{new-id}"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"is_published"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span> <span class="w"> </span><span class="nt">"links"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"latest"</span><span class="p">:</span><span class="w"> </span><span class="s2">"{scheme+hostname}/api/records/{id}/versions/latest"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"versions"</span><span class="p">:</span><span class="w"> </span><span class="s2">"{scheme+hostname}/api/records/{id}/versions"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"self_html"</span><span class="p">:</span><span class="w"> </span><span class="s2">"{scheme+hostname}/uploads/{id}"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"publish"</span><span class="p">:</span><span class="w"> </span><span class="s2">"{scheme+hostname}/api/records/{id}/draft/actions/publish"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"latest_html"</span><span class="p">:</span><span class="w"> </span><span class="s2">"{scheme+hostname}/records/{id}/latest"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"self"</span><span class="p">:</span><span class="w"> </span><span class="s2">"{scheme+hostname}/api/records/{id}/draft"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"files"</span><span class="p">:</span><span class="w"> </span><span class="s2">"{scheme+hostname}/api/records/{id}/draft/files"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"access_links"</span><span class="p">:</span><span class="w"> </span><span class="nt">"{scheme+hostname}/api/records/{id}/access/links"</span> <span class="w"> </span><span class="nt">"communities"</span><span class="p">:</span><span class="w"> </span><span class="s2">"{scheme+hostname}/api/records/{id}/communities"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"requests"</span><span class="p">:</span><span class="w"> </span><span class="s2">"{scheme+hostname}/api/records/{id}/requests"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"communities-suggestions"</span><span class="p">:</span><span class="w"> </span><span class="s2">"{scheme+hostname}/api/records/{id}/communities-suggestions"</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="nt">"metadata"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"resource_type"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"image-photo"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"title"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"en"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Photo"</span> <span class="w"> </span><span class="p">}</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="nt">"title"</span><span class="p">:</span><span class="w"> </span><span class="s2">"An Updated Romans story"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"creators"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span> <span class="w"> </span><span class="nt">"person_or_org"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"family_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Brown"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"given_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Troy"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Brown, Troy"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"personal"</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"person_or_org"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"family_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Collins"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"given_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Thomas"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"identifiers"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span> <span class="w"> </span><span class="p">{</span><span class="nt">"scheme"</span><span class="p">:</span><span class="w"> </span><span class="s2">"orcid"</span><span class="p">,</span><span class="w"> </span><span class="nt">"identifier"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0000-0002-1825-0097"</span><span class="p">}</span> <span class="w"> </span><span class="p">],</span> <span class="w"> </span><span class="nt">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Collins, Thomas"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"personal"</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="nt">"affiliations"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span> <span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"01ggx4157"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"European Organization for Nuclear Research"</span> <span class="w"> </span><span class="p">}</span> <span class="w"> </span><span class="p">]</span> <span class="w"> </span><span class="p">}</span> <span class="w"> </span><span class="p">],</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="nt">"parent"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"{parent-id}"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"access"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"owned_by"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"user"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="err">user</span><span class="mi">-</span><span class="err">id</span><span class="p">}</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="nt">"links"</span><span class="p">:</span><span class="w"> </span><span class="p">[]</span> <span class="w"> </span><span class="p">}</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="nt">"pids"</span><span class="p">:</span><span class="w"> </span><span class="p">{},</span> <span class="w"> </span><span class="nt">"revision_id"</span><span class="p">:</span><span class="w"> </span><span class="mi">3</span><span class="p">,</span> <span class="w"> </span><span class="nt">"updated"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2020-11-27 10:52:23.969244"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"versions"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"index"</span><span class="p">:</span><span class="w"> </span><span class="mi">2</span><span class="p">,</span> <span class="w"> </span><span class="nt">"is_latest"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span> <span class="w"> </span><span class="nt">"is_latest_draft"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span> <span class="w"> </span><span class="p">}</span> <span class="p">}</span> </code></pre></div> <p>Notice that a new draft is returned with <code>publication_date</code> and <code>version</code> removed (as those are typically replaced in a new version). The <code>versions.index</code> is also incremented. The <code>{parent-id}</code> connects the different versions together. The new draft version has no files. However, it is possible to link files from the previous version (avoiding the need to re-upload, which would also cause duplication in the file store). See below.</p> <p>Use <a href="#publish-a-draft-record">Publish a draft record</a> to publish it.</p> <h3 id="link-files-from-previous-version">Link files from previous version<a class="headerlink" href="#link-files-from-previous-version" title="Permanent link">¶</a></h3> <p><code>POST /api/records/{id}/draft/actions/files-import</code></p> <p>Links all files from the previous version to the new record.</p> <p><strong>Parameters</strong></p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Location</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>id</code></td> <td>string</td> <td>path</td> <td>Identifier of the new draft version, e.g., <code>1bc9x-3pq5x</code></td> </tr> </tbody> </table> <p><strong>Request</strong></p> <div class="highlight"><pre><span></span><code><span class="nf">POST</span> <span class="nn">/api/records/{id}/draft/actions/files-import</span> <span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> </code></pre></div> <p><strong>Response</strong></p> <div class="highlight"><pre><span></span><code><span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> <span class="m">201</span> <span class="ne">CREATED</span> <span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span> <span class="p">{</span> <span class="w"> </span><span class="nt">"enabled"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span> <span class="w"> </span><span class="nt">"default_preview"</span><span class="p">:</span><span class="w"> </span><span class="s2">"article.pdf"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"order"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span> <span class="w"> </span><span class="nt">"entries"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span> <span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"key"</span><span class="p">:</span><span class="w"> </span><span class="s2">"article.pdf"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2020-11-26 14:30:53.911912"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"updated"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2020-11-26 14:30:53.920544"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"checksum"</span><span class="p">:</span><span class="w"> </span><span class="s2">"md5:71449104d017a6056ac1a5fb58754975"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"mimetype"</span><span class="p">:</span><span class="w"> </span><span class="s2">"application/pdf"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"size"</span><span class="p">:</span><span class="w"> </span><span class="mi">76122</span><span class="p">,</span> <span class="w"> </span><span class="nt">"status"</span><span class="p">:</span><span class="w"> </span><span class="s2">"completed"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"metadata"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="err">...</span><span class="p">},</span> <span class="w"> </span><span class="nt">"file_id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"..."</span><span class="p">,</span> <span class="w"> </span><span class="nt">"version_id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"..."</span><span class="p">,</span> <span class="w"> </span><span class="nt">"bucket_id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"..."</span><span class="p">,</span> <span class="w"> </span><span class="nt">"storage_class"</span><span class="p">:</span><span class="w"> </span><span class="s2">"S"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"links"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="err">...</span><span class="p">}</span> <span class="w"> </span><span class="p">}</span> <span class="w"> </span><span class="p">]</span> <span class="w"> </span><span class="nt">"links"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="err">...</span><span class="p">},</span> <span class="p">}</span> </code></pre></div> <p>Note this call links all files from the previous version. Any files to be removed or updated can be <a href="#delete-a-draft-file">deleted</a> from the draft version and remain attached to the previous version.</p> <h3 id="get-all-versions">Get all versions<a class="headerlink" href="#get-all-versions" title="Permanent link">¶</a></h3> <p><code>GET /api/records/{id}/versions</code></p> <p><strong>Parameters</strong></p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Location</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>id</code></td> <td>string</td> <td>path</td> <td>Identifier of the record, e.g. <code>4d0ns-ntd89</code></td> </tr> </tbody> </table> <p><strong>Request</strong></p> <div class="highlight"><pre><span></span><code><span class="nf">GET</span> <span class="nn">/api/records/{id}/versions</span> <span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> </code></pre></div> <p><strong>Response</strong></p> <div class="highlight"><pre><span></span><code><span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> <span class="m">200</span> <span class="ne">OK</span> <span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span> <span class="p">{</span> <span class="w"> </span><span class="nt">"hits"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="err">...</span><span class="p">},</span> <span class="w"> </span><span class="nt">"sortBy"</span><span class="p">:</span><span class="w"> </span><span class="s2">"version"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"links"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="err">...</span><span class="p">}</span> <span class="p">}</span> </code></pre></div> <h3 id="get-latest-version">Get latest version<a class="headerlink" href="#get-latest-version" title="Permanent link">¶</a></h3> <p>Given a record, it returns its latest version.</p> <p><code>GET /api/records/{id}/versions/latest</code></p> <p><strong>Parameters</strong></p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Location</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>id</code></td> <td>string</td> <td>path</td> <td>Identifier of a record, e.g. <code>cbc2k-q9x58</code></td> </tr> <tr> <td><code>accept</code></td> <td>string</td> <td>header</td> <td>- <code>application/json</code> (default)<br />- <code>application/vnd.inveniordm.v1+json</code></td> </tr> </tbody> </table> <p><strong>Request</strong></p> <div class="highlight"><pre><span></span><code><span class="nf">GET</span> <span class="nn">/api/records/{id}/versions/latest</span> <span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> </code></pre></div> <p><strong>Response</strong></p> <div class="highlight"><pre><span></span><code><span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> <span class="m">200</span> <span class="ne">OK</span> <span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span> <span class="p">{</span> <span class="w"> </span><span class="nt">"access"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"record"</span><span class="p">:</span><span class="w"> </span><span class="s2">"restricted"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"files"</span><span class="p">:</span><span class="w"> </span><span class="s2">"restricted"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"embargo"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"reason"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span> <span class="w"> </span><span class="nt">"active"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="nt">"status"</span><span class="p">:</span><span class="w"> </span><span class="s2">"restricted"</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="nt">"created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2020-11-27 10:52:23.945755"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"expires_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2020-11-27 10:52:23.945868"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"files"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"enabled"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span> <span class="w"> </span><span class="nt">"order"</span><span class="p">:</span><span class="w"> </span><span class="p">[]</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="nt">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"{latest-version-id}"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"is_published"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span> <span class="w"> </span><span class="nt">"links"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"latest"</span><span class="p">:</span><span class="w"> </span><span class="s2">"{scheme+hostname}/api/records/{id}/versions/latest"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"versions"</span><span class="p">:</span><span class="w"> </span><span class="s2">"{scheme+hostname}/api/records/{id}/versions"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"self_html"</span><span class="p">:</span><span class="w"> </span><span class="s2">"{scheme+hostname}/records/{id}"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"latest_html"</span><span class="p">:</span><span class="w"> </span><span class="s2">"{scheme+hostname}/records/{id}/latest"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"self"</span><span class="p">:</span><span class="w"> </span><span class="s2">"{scheme+hostname}/api/records/{id}"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"files"</span><span class="p">:</span><span class="w"> </span><span class="s2">"{scheme+hostname}/api/records/{id}/files"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"access_links"</span><span class="p">:</span><span class="w"> </span><span class="s2">"{scheme+hostname}/api/records/{id}/access/links"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"communities"</span><span class="p">:</span><span class="w"> </span><span class="s2">"{scheme+hostname}/api/records/{id}/communities"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"requests"</span><span class="p">:</span><span class="w"> </span><span class="s2">"{scheme+hostname}/api/records/{id}/requests"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"communities-suggestions"</span><span class="p">:</span><span class="w"> </span><span class="s2">"{scheme+hostname}/api/records/{id}/communities-suggestions"</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="nt">"metadata"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"resource_type"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"image-photo"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"title"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"en"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Photo"</span> <span class="w"> </span><span class="p">}</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="nt">"title"</span><span class="p">:</span><span class="w"> </span><span class="s2">"An Updated Romans story"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"publication_date"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2020-06-01"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"creators"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span> <span class="w"> </span><span class="nt">"person_or_org"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"family_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Brown"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"given_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Troy"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"personal"</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"person_or_org"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"family_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Collins"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"given_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Thomas"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"identifiers"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span> <span class="w"> </span><span class="p">{</span><span class="nt">"scheme"</span><span class="p">:</span><span class="w"> </span><span class="s2">"orcid"</span><span class="p">,</span><span class="w"> </span><span class="nt">"identifier"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0000-0002-1825-0097"</span><span class="p">}</span> <span class="w"> </span><span class="p">],</span> <span class="w"> </span><span class="nt">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Collins, Thomas"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"personal"</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="nt">"affiliations"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span> <span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"01ggx4157"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"European Organization for Nuclear Research"</span> <span class="w"> </span><span class="p">}</span> <span class="w"> </span><span class="p">]</span> <span class="w"> </span><span class="p">}</span> <span class="w"> </span><span class="p">],</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="nt">"parent"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"{parent-id}"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"access"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"owned_by"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"user"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="err">user</span><span class="mi">-</span><span class="err">id</span><span class="p">}</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="nt">"links"</span><span class="p">:</span><span class="w"> </span><span class="p">[]</span> <span class="w"> </span><span class="p">}</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="nt">"pids"</span><span class="p">:</span><span class="w"> </span><span class="p">{},</span> <span class="w"> </span><span class="nt">"revision_id"</span><span class="p">:</span><span class="w"> </span><span class="mi">3</span><span class="p">,</span> <span class="w"> </span><span class="nt">"updated"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2020-11-27 10:52:23.969244"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"versions"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"index"</span><span class="p">:</span><span class="w"> </span><span class="mi">2</span><span class="p">,</span> <span class="w"> </span><span class="nt">"is_latest"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span> <span class="w"> </span><span class="nt">"is_latest_draft"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span> <span class="w"> </span><span class="p">}</span> <span class="p">}</span> </code></pre></div> <h2 id="access-links">Access links<a class="headerlink" href="#access-links" title="Permanent link">¶</a></h2> <p>Access links are URLs that can be shared with others to give them access and permissions to a record/draft.</p> <h3 id="create-an-access-link">Create an access link<a class="headerlink" href="#create-an-access-link" title="Permanent link">¶</a></h3> <p><code>POST /api/records/{id}/access/links</code></p> <p><strong>Parameters</strong></p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Location</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>id</code></td> <td>string</td> <td>path</td> <td>Identifier of the record, e.g. <code>cbc2k-q9x58</code></td> </tr> <tr> <td><code>accept</code></td> <td>string</td> <td>header</td> <td>- <code>application/json</code> (default)<br />- <code>application/vnd.inveniordm.v1+json</code></td> </tr> <tr> <td><code>expires_at</code></td> <td>string</td> <td>body</td> <td><code>ISO 8601 Date</code>Format (YYYY-MM-DD) When the link expires.</td> </tr> <tr> <td><code>permission</code></td> <td>string</td> <td>body</td> <td>Required. Action that can be undertaken with the link (<code>view</code>, <code>preview</code> or <code>edit</code>).</td> </tr> </tbody> </table> <p><strong>Request</strong></p> <div class="highlight"><pre><span></span><code><span class="nf">POST</span> <span class="nn">/api/records/{id}/access/links</span> <span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> <span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span> <span class="p">{</span> <span class="w"> </span><span class="nt">"permission"</span><span class="p">:</span><span class="w"> </span><span class="s2">"view"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"expires_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2024-11-06"</span> <span class="p">}</span> </code></pre></div> <p><strong>Response</strong></p> <div class="highlight"><pre><span></span><code><span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> <span class="m">201</span> <span class="ne">CREATED</span> <span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span> <span class="p">{</span> <span class="w"> </span><span class="nt">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"07fb00f3-928c-4ce9-8d2e-8e9c4dca3092"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"created_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2024-06-12T13:07:09.951029+00:00"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"expires_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2024-11-06"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"permission"</span><span class="p">:</span><span class="w"> </span><span class="s2">"view"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span> <span class="w"> </span><span class="nt">"token"</span><span class="p">:</span><span class="w"> </span><span class="s2">"eyJhbGciOiJIUzUxMiIsImlhdCI6MTcxODE5NzYyOSwiZXhwIjoxNzMwODUxMTk5fQ.eyJpZCI6IjA3ZmIwMGYzLTkyOGMtNGNlOS04ZDJlLThlOWM0ZGNhMzA5MiIsImRhdGEiOnt9LCJyYW5kb20iOiI1NzVjNzEwY2QwNWI3YWFhMTM2MzY3ZmMzZWFkYzA0MSJ9.GPfPBvrbvEu-JMddFXjb5MZKNWRnzAK53oTVOSgfdZOcMIoRfszO39GEglko74dohZiUcJ11jWXj0fwfdq1WnQ"</span> <span class="p">}</span> </code></pre></div> <h3 id="get-an-access-link">Get an access link<a class="headerlink" href="#get-an-access-link" title="Permanent link">¶</a></h3> <p><code>GET /api/records/{id}/access/links/{link-id}</code></p> <p><strong>Parameters</strong></p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Location</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>id</code></td> <td>string</td> <td>path</td> <td>Identifier of the record, e.g. <code>cbc2k-q9x58</code></td> </tr> <tr> <td><code>link-id</code></td> <td>string</td> <td>path</td> <td>Identifier of the link, e.g. <code>3d3320ea-0755-4d93-a76e-e2f2fc655d2a</code></td> </tr> <tr> <td><code>accept</code></td> <td>string</td> <td>header</td> <td>- <code>application/json</code> (default)<br />- <code>application/vnd.inveniordm.v1+json</code></td> </tr> </tbody> </table> <p><strong>Request</strong></p> <div class="highlight"><pre><span></span><code><span class="nf">GET</span> <span class="nn">/api/records/{id}/access/links/{link-id}</span> <span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> <span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span> </code></pre></div> <p><strong>Response</strong></p> <div class="highlight"><pre><span></span><code><span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> <span class="m">200</span> <span class="ne">OK</span> <span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span> <span class="p">{</span> <span class="w"> </span><span class="nt">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"61c2d20f-4c88-440d-9978-dd16a69bf97e"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"created_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2024-06-12T13:23:11.271139+00:00"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"expires_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2024-11-06"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"permission"</span><span class="p">:</span><span class="w"> </span><span class="s2">"view"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span> <span class="w"> </span><span class="nt">"token"</span><span class="p">:</span><span class="w"> </span><span class="s2">"eyJhbGciOiJIUzUxMiIsImlhdCI6MTcxODE5ODU5MSwiZXhwIjoxNzMwODUxMTk5fQ.eyJpZCI6IjYxYzJkMjBmLTRjODgtNDQwZC05OTc4LWRkMTZhNjliZjk3ZSIsImRhdGEiOnt9LCJyYW5kb20iOiI2MWYwZTg4YjgzY2E2ZDhkMjJiMTY0MGFjNmIzMmEwZiJ9.AFEmgQ8_gtEj7dvlZ2MHD9qneKy0UEC1HMByo8J5xVGMYG8PXwuRsyUgeq_k_ZeHybO5W4_Do_P4NVGXsrjHyg"</span> <span class="p">}</span> </code></pre></div> <h3 id="update-an-access-link">Update an access link<a class="headerlink" href="#update-an-access-link" title="Permanent link">¶</a></h3> <p><code>PATCH /api/records/{id}/access/links/{link-id}</code></p> <p><strong>Parameters</strong></p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Location</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>id</code></td> <td>string</td> <td>path</td> <td>Identifier of the record, e.g. <code>cbc2k-q9x58</code></td> </tr> <tr> <td><code>link-id</code></td> <td>string</td> <td>path</td> <td>Identifier of the link, e.g. <code>3d3320ea-0755-4d93-a76e-e2f2fc655d2a</code></td> </tr> <tr> <td><code>accept</code></td> <td>string</td> <td>header</td> <td>- <code>application/json</code> (default)<br />- <code>application/vnd.inveniordm.v1+json</code></td> </tr> <tr> <td><code>expires_at</code></td> <td>string</td> <td>body</td> <td><code>ISO 8601 Date</code>Format (YYYY-MM-DD) When the link expires.</td> </tr> <tr> <td><code>permission</code></td> <td>string</td> <td>body</td> <td>Required. Action that can be undertaken with the link.</td> </tr> </tbody> </table> <p><strong>Request</strong></p> <div class="highlight"><pre><span></span><code><span class="nf">PATCH</span> <span class="nn">/api/records/{id}/access/links/{link-id}</span> <span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> <span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span> <span class="p">{</span> <span class="w"> </span><span class="nt">"permission"</span><span class="p">:</span><span class="w"> </span><span class="s2">"edit"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"expires_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2024-11-06"</span> <span class="p">}</span> </code></pre></div> <p><strong>Response</strong></p> <div class="highlight"><pre><span></span><code><span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> <span class="m">200</span> <span class="ne">OK</span> <span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span> <span class="p">{</span> <span class="w"> </span><span class="nt">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"df672812-6b23-411a-b40a-9bb22787f0a2"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"created_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2024-06-12T12:48:43.724970+00:00"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"expires_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2024-11-06"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"permission"</span><span class="p">:</span><span class="w"> </span><span class="s2">"edit"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span> <span class="w"> </span><span class="nt">"token"</span><span class="p">:</span><span class="w"> </span><span class="s2">"eyJhbGciOiJIUzUxMiJ9.eyJpZCI6ImRmNjcyODEyLTZiMjMtNDExYS1iNDBhLTliYjIyNzg3ZjBhMiIsImRhdGEiOnt9LCJyYW5kb20iOiIwZWE3ZWQ5YTBiZTE3N2ZjMjE4YjNjYzY3M2RiOTI5OSJ9.kqJ_gTvgjEc_-1Jxv-XHqSCUmOpcQDdBzx-T5BP7ybvQItK91wGxmVT_gfHxyHHDQ_7e8_LH1A5TotAZCA8q_w"</span> <span class="p">}</span> </code></pre></div> <h3 id="delete-an-access-link">Delete an access link<a class="headerlink" href="#delete-an-access-link" title="Permanent link">¶</a></h3> <p><code>DELETE /api/records/{id}/access/links/{link-id}</code></p> <p><strong>Parameters</strong></p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Location</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>id</code></td> <td>string</td> <td>path</td> <td>Identifier of the record, e.g. <code>cbc2k-q9x58</code></td> </tr> <tr> <td><code>link-id</code></td> <td>string</td> <td>path</td> <td>Identifier of the link, e.g. <code>3d3320ea-0755-4d93-a76e-e2f2fc655d2a</code></td> </tr> <tr> <td><code>accept</code></td> <td>string</td> <td>header</td> <td>- <code>application/json</code> (default)<br />- <code>application/vnd.inveniordm.v1+json</code></td> </tr> </tbody> </table> <p><strong>Request</strong></p> <div class="highlight"><pre><span></span><code><span class="nf">DELETE</span> <span class="nn">/api/records/{id}/access/links/{link-id}</span> <span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> <span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span> </code></pre></div> <p><strong>Response</strong></p> <div class="highlight"><pre><span></span><code><span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> <span class="m">204</span> <span class="ne">No Content</span> </code></pre></div> <h3 id="list-access-links">List access links<a class="headerlink" href="#list-access-links" title="Permanent link">¶</a></h3> <p><code>GET /api/records/{id}/access/links</code></p> <p><strong>Parameters</strong></p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Location</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>id</code></td> <td>string</td> <td>path</td> <td>Identifier of the record, e.g. <code>cbc2k-q9x58</code></td> </tr> <tr> <td><code>accept</code></td> <td>string</td> <td>header</td> <td>- <code>application/json</code> (default)<br />- <code>application/vnd.inveniordm.v1+json</code></td> </tr> </tbody> </table> <p><strong>Request</strong></p> <div class="highlight"><pre><span></span><code><span class="nf">GET</span> <span class="nn">/api/records/{id}/access/links</span> <span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> <span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span> </code></pre></div> <p><strong>Response</strong></p> <div class="highlight"><pre><span></span><code><span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> <span class="m">200</span> <span class="ne">OK</span> <span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span> <span class="p">{</span> <span class="w"> </span><span class="nt">"hits"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"hits"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span> <span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"61c2d20f-4c88-440d-9978-dd16a69bf97e"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"created_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2024-06-12T13:23:11.271139+00:00"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"expires_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2024-11-06"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"permission"</span><span class="p">:</span><span class="w"> </span><span class="s2">"edit"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span> <span class="w"> </span><span class="nt">"token"</span><span class="p">:</span><span class="w"> </span><span class="s2">"eyJhbGciOiJIUzUxMiIsImlhdCI6MTcxODE5ODU5MSwiZXhwIjoxNzMwODUxMTk5fQ.eyJpZCI6IjYxYzJkMjBmLTRjODgtNDQwZC05OTc4LWRkMTZhNjliZjk3ZSIsImRhdGEiOnt9LCJyYW5kb20iOiI2MWYwZTg4YjgzY2E2ZDhkMjJiMTY0MGFjNmIzMmEwZiJ9.AFEmgQ8_gtEj7dvlZ2MHD9qneKy0UEC1HMByo8J5xVGMYG8PXwuRsyUgeq_k_ZeHybO5W4_Do_P4NVGXsrjHyg"</span> <span class="w"> </span><span class="p">}</span> <span class="w"> </span><span class="p">],</span> <span class="w"> </span><span class="nt">"total"</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span> <span class="w"> </span><span class="p">}</span> <span class="p">}</span> </code></pre></div> <h2 id="user-records">User Records<a class="headerlink" href="#user-records" title="Permanent link">¶</a></h2> <p>Used for interacting with the records and drafts you can edit.</p> <h3 id="list-your-draft-and-published-records">List your draft and published records<a class="headerlink" href="#list-your-draft-and-published-records" title="Permanent link">¶</a></h3> <p><code>GET /api/user/records</code></p> <p><strong>Parameters</strong></p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Location</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>q</code></td> <td>string</td> <td>query</td> <td>Search query used to filter results based on <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-query-string-query.html#query-string-syntax">ElasticSearch's query string syntax</a>.</td> </tr> <tr> <td><code>sort</code></td> <td>string</td> <td>query</td> <td>Sort search results. Customizable. Built-in options are <code>"bestmatch"</code>, <code>"newest"</code>, <code>"oldest"</code>, <code>"updated-desc"</code>, <code>"updated-asc"</code>, <code>"version"</code>, <code>"mostviewed"</code>, <code>"mostdownloaded"</code> (default: <code>"bestmatch"</code> or <code>"newest"</code>).</td> </tr> <tr> <td><code>size</code></td> <td>integer</td> <td>query</td> <td>Specify number of items in the results page (default: 10).</td> </tr> <tr> <td><code>page</code></td> <td>integer</td> <td>query</td> <td>Specify the page of results.</td> </tr> <tr> <td><code>allversions</code> </td> <td>boolean</td> <td>query</td> <td>Specify if all versions should be included.</td> </tr> <tr> <td><code>accept</code></td> <td>string</td> <td>header</td> <td>- <code>application/json</code> (default)<br />- <code>application/vnd.inveniordm.v1+json</code></td> </tr> </tbody> </table> <p>Sort options for records can be configured using the <code>RDM_SORT_OPTIONS</code> config variable as described in the <a href="../../customize/search/">search customization</a> section. Note that <code>"bestmatch"</code> is only available as a sort option on requests that provide a query string as a <code>q</code> parameter. Otherwise <code>"bestmatch"</code> is ignored and the default <code>"newest"</code> sort is used. Queries sorted by <code>"mostviewed"</code> and <code>"mostdownloaded"</code> are in descending order.</p> <p><strong>Request</strong></p> <div class="highlight"><pre><span></span><code><span class="nf">GET</span> <span class="nn">/api/user/records</span> <span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> </code></pre></div> <p><strong>Response</strong></p> <div class="highlight"><pre><span></span><code><span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> <span class="m">200</span> <span class="ne">OK</span> <span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span> <span class="p">{</span> <span class="w"> </span><span class="nt">"aggregations"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="err">...</span><span class="p">},</span> <span class="w"> </span><span class="nt">"hits"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="err">...</span><span class="p">},</span> <span class="w"> </span><span class="nt">"links"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="err">...</span><span class="p">},</span> <span class="w"> </span><span class="nt">"sortBy"</span><span class="p">:</span><span class="w"> </span><span class="err">...</span><span class="p">,</span> <span class="p">}</span> </code></pre></div> </article> </div> <script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script> </div> </main> <footer class="md-footer"> <nav class="md-footer__inner md-grid" aria-label="Footer" > <a href="../rest_api_communities/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Communities"> <div class="md-footer__button md-icon"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg> </div> <div class="md-footer__title"> <span class="md-footer__direction"> Previous </span> <div class="md-ellipsis"> Communities </div> </div> </a> <a href="../rest_api_groups/" class="md-footer__link md-footer__link--next" aria-label="Next: Groups"> <div class="md-footer__title"> <span class="md-footer__direction"> Next </span> <div class="md-ellipsis"> Groups </div> </div> <div class="md-footer__button md-icon"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11z"/></svg> </div> </a> </nav> <div class="md-footer-meta md-typeset"> <div class="md-footer-meta__inner md-grid"> <div class="md-copyright"> <div class="md-copyright__highlight"> Copyright © 2019-2024 CERN, Northwestern University and contributors. </div> Made with <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener"> Material for MkDocs </a> </div> <div class="md-social"> <a href="https://github.com/inveniosoftware" target="_blank" rel="noopener" title="github.com" class="md-social__link"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 496 512"><!--! Font Awesome Free 6.6.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M165.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6m-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3m44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9M244.8 8C106.1 8 0 113.3 0 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C428.2 457.8 496 362.9 496 252 496 113.3 383.5 8 244.8 8M97.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1m-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7m32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1m-11.4-14.7c-1.6 1-1.6 3.6 0 5.9s4.3 3.3 5.6 2.3c1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2"/></svg> </a> </div> </div> </div> </footer> </div> <div class="md-dialog" data-md-component="dialog"> <div class="md-dialog__inner md-typeset"></div> </div> <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.footer", "content.code.copy"], "search": "../../assets/javascripts/workers/search.6ce7567c.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script> <script src="../../assets/javascripts/bundle.525ec568.min.js"></script> </body> </html>