CINXE.COM
API Docs - Mendeley Data
<!doctype html><html lang="en-gb"><head><title>API Docs - Mendeley Data</title><meta name="viewport" content="width=device-width,initial-scale=1"><base href="/api/docs/"/><link rel="shortcut icon" href="https://static.data.mendeley.com/favicon.ico"><script src="https://cdn.cookielaw.org/consent/a2567f1b-8a60-4464-b725-6c59f84a5801/OtAutoBlock.js"></script><script src="https://cdn.cookielaw.org/scripttemplates/otSDKStub.js" charset="UTF-8" data-domain-script="a2567f1b-8a60-4464-b725-6c59f84a5801"></script><script>function OptanonWrapper() { }</script> <script type='text/javascript'>window.NREUM||(NREUM={});NREUM.info = {"agent":"","beacon":"bam.nr-data.net","errorBeacon":"bam.nr-data.net","licenseKey":"NRJS-10516b9ce6a4c633b1f","applicationID":"1487971250","agentToken":null,"applicationTime":111.552806,"transactionName":"NVQHbUpSWRFXUhVQXwweK1ZKXlYOX0sEXWUQWEoT","queueTime":0,"ttGuid":"6ebc3d31382f5c3f"}; (window.NREUM||(NREUM={})).init={privacy:{cookies_enabled:true},ajax:{deny_list:["bam.nr-data.net"]},distributed_tracing:{enabled:true}};(window.NREUM||(NREUM={})).loader_config={agentID:"1588720196",accountID:"2863447",trustKey:"2038175",xpid:"Vg4BUlJXDxABUFlVDgYGVFEB",licenseKey:"NRJS-10516b9ce6a4c633b1f",applicationID:"1487971250"};;/*! For license information please see nr-loader-spa-1.274.0.min.js.LICENSE.txt */ (()=>{var e,t,r={8122:(e,t,r)=>{"use strict";r.d(t,{a:()=>i});var n=r(944);function i(e,t){try{if(!e||"object"!=typeof e)return(0,n.R)(3);if(!t||"object"!=typeof t)return(0,n.R)(4);const r=Object.create(Object.getPrototypeOf(t),Object.getOwnPropertyDescriptors(t)),o=0===Object.keys(r).length?e:r;for(let a in o)if(void 0!==e[a])try{if(null===e[a]){r[a]=null;continue}Array.isArray(e[a])&&Array.isArray(t[a])?r[a]=Array.from(new Set([...e[a],...t[a]])):"object"==typeof e[a]&&"object"==typeof t[a]?r[a]=i(e[a],t[a]):r[a]=e[a]}catch(e){(0,n.R)(1,e)}return r}catch(e){(0,n.R)(2,e)}}},2555:(e,t,r)=>{"use strict";r.d(t,{Vp:()=>c,fn:()=>s,x1:()=>u});var n=r(384),i=r(8122);const o={beacon:n.NT.beacon,errorBeacon:n.NT.errorBeacon,licenseKey:void 0,applicationID:void 0,sa:void 0,queueTime:void 0,applicationTime:void 0,ttGuid:void 0,user:void 0,account:void 0,product:void 0,extra:void 0,jsAttributes:{},userAttributes:void 0,atts:void 0,transactionName:void 0,tNamePlain:void 0},a={};function s(e){try{const t=c(e);return!!t.licenseKey&&!!t.errorBeacon&&!!t.applicationID}catch(e){return!1}}function c(e){if(!e)throw new Error("All info objects require an agent identifier!");if(!a[e])throw new Error("Info for ".concat(e," was never set"));return a[e]}function u(e,t){if(!e)throw new Error("All info objects require an agent identifier!");a[e]=(0,i.a)(t,o);const r=(0,n.nY)(e);r&&(r.info=a[e])}},9417:(e,t,r)=>{"use strict";r.d(t,{D0:()=>h,gD:()=>g,xN:()=>p});var n=r(993);const i=e=>{if(!e||"string"!=typeof e)return!1;try{document.createDocumentFragment().querySelector(e)}catch{return!1}return!0};var o=r(2614),a=r(944),s=r(384),c=r(8122);const u="[data-nr-mask]",d=()=>{const e={mask_selector:"*",block_selector:"[data-nr-block]",mask_input_options:{color:!1,date:!1,"datetime-local":!1,email:!1,month:!1,number:!1,range:!1,search:!1,tel:!1,text:!1,time:!1,url:!1,week:!1,textarea:!1,select:!1,password:!0}};return{ajax:{deny_list:void 0,block_internal:!0,enabled:!0,harvestTimeSeconds:10,autoStart:!0},distributed_tracing:{enabled:void 0,exclude_newrelic_header:void 0,cors_use_newrelic_header:void 0,cors_use_tracecontext_headers:void 0,allowed_origins:void 0},feature_flags:[],generic_events:{enabled:!0,harvestTimeSeconds:30,autoStart:!0},harvest:{tooManyRequestsDelay:60},jserrors:{enabled:!0,harvestTimeSeconds:10,autoStart:!0},logging:{enabled:!0,harvestTimeSeconds:10,autoStart:!0,level:n.p_.INFO},metrics:{enabled:!0,autoStart:!0},obfuscate:void 0,page_action:{enabled:!0},page_view_event:{enabled:!0,autoStart:!0},page_view_timing:{enabled:!0,harvestTimeSeconds:30,autoStart:!0},performance:{capture_marks:!1,capture_measures:!1},privacy:{cookies_enabled:!0},proxy:{assets:void 0,beacon:void 0},session:{expiresMs:o.wk,inactiveMs:o.BB},session_replay:{autoStart:!0,enabled:!1,harvestTimeSeconds:60,preload:!1,sampling_rate:10,error_sampling_rate:100,collect_fonts:!1,inline_images:!1,fix_stylesheets:!0,mask_all_inputs:!0,get mask_text_selector(){return e.mask_selector},set mask_text_selector(t){i(t)?e.mask_selector="".concat(t,",").concat(u):""===t||null===t?e.mask_selector=u:(0,a.R)(5,t)},get block_class(){return"nr-block"},get ignore_class(){return"nr-ignore"},get mask_text_class(){return"nr-mask"},get block_selector(){return e.block_selector},set block_selector(t){i(t)?e.block_selector+=",".concat(t):""!==t&&(0,a.R)(6,t)},get mask_input_options(){return e.mask_input_options},set mask_input_options(t){t&&"object"==typeof t?e.mask_input_options={...t,password:!0}:(0,a.R)(7,t)}},session_trace:{enabled:!0,harvestTimeSeconds:10,autoStart:!0},soft_navigations:{enabled:!0,harvestTimeSeconds:10,autoStart:!0},spa:{enabled:!0,harvestTimeSeconds:10,autoStart:!0},ssl:void 0,user_actions:{enabled:!0}}},l={},f="All configuration objects require an agent identifier!";function h(e){if(!e)throw new Error(f);if(!l[e])throw new Error("Configuration for ".concat(e," was never set"));return l[e]}function p(e,t){if(!e)throw new Error(f);l[e]=(0,c.a)(t,d());const r=(0,s.nY)(e);r&&(r.init=l[e])}function g(e,t){if(!e)throw new Error(f);var r=h(e);if(r){for(var n=t.split("."),i=0;i<n.length-1;i++)if("object"!=typeof(r=r[n[i]]))return;r=r[n[n.length-1]]}return r}},5603:(e,t,r)=>{"use strict";r.d(t,{a:()=>c,o:()=>s});var n=r(384),i=r(8122);const o={accountID:void 0,trustKey:void 0,agentID:void 0,licenseKey:void 0,applicationID:void 0,xpid:void 0},a={};function s(e){if(!e)throw new Error("All loader-config objects require an agent identifier!");if(!a[e])throw new Error("LoaderConfig for ".concat(e," was never set"));return a[e]}function c(e,t){if(!e)throw new Error("All loader-config objects require an agent identifier!");a[e]=(0,i.a)(t,o);const r=(0,n.nY)(e);r&&(r.loader_config=a[e])}},3371:(e,t,r)=>{"use strict";r.d(t,{V:()=>f,f:()=>l});var n=r(8122),i=r(384),o=r(6154),a=r(9324);let s=0;const c={buildEnv:a.F3,distMethod:a.Xs,version:a.xv,originTime:o.WN},u={customTransaction:void 0,disabled:!1,isolatedBacklog:!1,loaderType:void 0,maxBytes:3e4,onerror:void 0,ptid:void 0,releaseIds:{},appMetadata:{},session:void 0,denyList:void 0,timeKeeper:void 0,obfuscator:void 0},d={};function l(e){if(!e)throw new Error("All runtime objects require an agent identifier!");if(!d[e])throw new Error("Runtime for ".concat(e," was never set"));return d[e]}function f(e,t){if(!e)throw new Error("All runtime objects require an agent identifier!");d[e]={...(0,n.a)(t,u),...c},Object.hasOwnProperty.call(d[e],"harvestCount")||Object.defineProperty(d[e],"harvestCount",{get:()=>++s});const r=(0,i.nY)(e);r&&(r.runtime=d[e])}},9324:(e,t,r)=>{"use strict";r.d(t,{F3:()=>i,Xs:()=>o,Yq:()=>a,xv:()=>n});const n="1.274.0",i="PROD",o="CDN",a="^2.0.0-alpha.17"},6154:(e,t,r)=>{"use strict";r.d(t,{A4:()=>s,OF:()=>d,RI:()=>i,WN:()=>h,bv:()=>o,gm:()=>a,lR:()=>f,m:()=>u,mw:()=>c,sb:()=>l});var n=r(1863);const i="undefined"!=typeof window&&!!window.document,o="undefined"!=typeof WorkerGlobalScope&&("undefined"!=typeof self&&self instanceof WorkerGlobalScope&&self.navigator instanceof WorkerNavigator||"undefined"!=typeof globalThis&&globalThis instanceof WorkerGlobalScope&&globalThis.navigator instanceof WorkerNavigator),a=i?window:"undefined"!=typeof WorkerGlobalScope&&("undefined"!=typeof self&&self instanceof WorkerGlobalScope&&self||"undefined"!=typeof globalThis&&globalThis instanceof WorkerGlobalScope&&globalThis),s="complete"===a?.document?.readyState,c=Boolean("hidden"===a?.document?.visibilityState),u=""+a?.location,d=/iPad|iPhone|iPod/.test(a.navigator?.userAgent),l=d&&"undefined"==typeof SharedWorker,f=(()=>{const e=a.navigator?.userAgent?.match(/Firefox[/\s](\d+\.\d+)/);return Array.isArray(e)&&e.length>=2?+e[1]:0})(),h=Date.now()-(0,n.t)()},7295:(e,t,r)=>{"use strict";r.d(t,{Xv:()=>a,gX:()=>i,iW:()=>o});var n=[];function i(e){if(!e||o(e))return!1;if(0===n.length)return!0;for(var t=0;t<n.length;t++){var r=n[t];if("*"===r.hostname)return!1;if(s(r.hostname,e.hostname)&&c(r.pathname,e.pathname))return!1}return!0}function o(e){return void 0===e.hostname}function a(e){if(n=[],e&&e.length)for(var t=0;t<e.length;t++){let r=e[t];if(!r)continue;0===r.indexOf("http://")?r=r.substring(7):0===r.indexOf("https://")&&(r=r.substring(8));const i=r.indexOf("/");let o,a;i>0?(o=r.substring(0,i),a=r.substring(i)):(o=r,a="");let[s]=o.split(":");n.push({hostname:s,pathname:a})}}function s(e,t){return!(e.length>t.length)&&t.indexOf(e)===t.length-e.length}function c(e,t){return 0===e.indexOf("/")&&(e=e.substring(1)),0===t.indexOf("/")&&(t=t.substring(1)),""===e||e===t}},1687:(e,t,r)=>{"use strict";r.d(t,{Ak:()=>c,Ze:()=>l,x3:()=>u});var n=r(7836),i=r(3606),o=r(860),a=r(2646);const s={};function c(e,t){const r={staged:!1,priority:o.P3[t]||0};d(e),s[e].get(t)||s[e].set(t,r)}function u(e,t){e&&s[e]&&(s[e].get(t)&&s[e].delete(t),h(e,t,!1),s[e].size&&f(e))}function d(e){if(!e)throw new Error("agentIdentifier required");s[e]||(s[e]=new Map)}function l(e="",t="feature",r=!1){if(d(e),!e||!s[e].get(t)||r)return h(e,t);s[e].get(t).staged=!0,f(e)}function f(e){const t=Array.from(s[e]);t.every((([e,t])=>t.staged))&&(t.sort(((e,t)=>e[1].priority-t[1].priority)),t.forEach((([t])=>{s[e].delete(t),h(e,t)})))}function h(e,t,r=!0){const o=e?n.ee.get(e):n.ee,s=i.i.handlers;if(!o.aborted&&o.backlog&&s){if(r){const e=o.backlog[t],r=s[t];if(r){for(let t=0;e&&t<e.length;++t)p(e[t],r);Object.entries(r).forEach((([e,t])=>{Object.values(t||{}).forEach((t=>{t[0]?.on&&t[0]?.context()instanceof a.y&&t[0].on(e,t[1])}))}))}}o.isolatedBacklog||delete s[t],o.backlog[t]=null,o.emit("drain-"+t,[])}}function p(e,t){var r=e[1];Object.values(t[r]||{}).forEach((t=>{var r=e[0];if(t[0]===r){var n=t[1],i=e[3],o=e[2];n.apply(i,o)}}))}},7836:(e,t,r)=>{"use strict";r.d(t,{P:()=>c,ee:()=>u});var n=r(384),i=r(8990),o=r(3371),a=r(2646),s=r(5607);const c="nr@context:".concat(s.W),u=function e(t,r){var n={},s={},d={},l=!1;try{l=16===r.length&&(0,o.f)(r).isolatedBacklog}catch(e){}var f={on:p,addEventListener:p,removeEventListener:function(e,t){var r=n[e];if(!r)return;for(var i=0;i<r.length;i++)r[i]===t&&r.splice(i,1)},emit:function(e,r,n,i,o){!1!==o&&(o=!0);if(u.aborted&&!i)return;t&&o&&t.emit(e,r,n);for(var a=h(n),c=g(e),d=c.length,l=0;l<d;l++)c[l].apply(a,r);var p=v()[s[e]];p&&p.push([f,e,r,a]);return a},get:m,listeners:g,context:h,buffer:function(e,t){const r=v();if(t=t||"feature",f.aborted)return;Object.entries(e||{}).forEach((([e,n])=>{s[n]=t,t in r||(r[t]=[])}))},abort:function(){f._aborted=!0,Object.keys(f.backlog).forEach((e=>{delete f.backlog[e]}))},isBuffering:function(e){return!!v()[s[e]]},debugId:r,backlog:l?{}:t&&"object"==typeof t.backlog?t.backlog:{},isolatedBacklog:l};return Object.defineProperty(f,"aborted",{get:()=>{let e=f._aborted||!1;return e||(t&&(e=t.aborted),e)}}),f;function h(e){return e&&e instanceof a.y?e:e?(0,i.I)(e,c,(()=>new a.y(c))):new a.y(c)}function p(e,t){n[e]=g(e).concat(t)}function g(e){return n[e]||[]}function m(t){return d[t]=d[t]||e(f,t)}function v(){return f.backlog}}(void 0,"globalEE"),d=(0,n.Zm)();d.ee||(d.ee=u)},2646:(e,t,r)=>{"use strict";r.d(t,{y:()=>n});class n{constructor(e){this.contextId=e}}},9908:(e,t,r)=>{"use strict";r.d(t,{d:()=>n,p:()=>i});var n=r(7836).ee.get("handle");function i(e,t,r,i,o){o?(o.buffer([e],i),o.emit(e,t,r)):(n.buffer([e],i),n.emit(e,t,r))}},3606:(e,t,r)=>{"use strict";r.d(t,{i:()=>o});var n=r(9908);o.on=a;var i=o.handlers={};function o(e,t,r,o){a(o||n.d,i,e,t,r)}function a(e,t,r,i,o){o||(o="feature"),e||(e=n.d);var a=t[o]=t[o]||{};(a[r]=a[r]||[]).push([e,i])}},3878:(e,t,r)=>{"use strict";function n(e,t){return{capture:e,passive:!1,signal:t}}function i(e,t,r=!1,i){window.addEventListener(e,t,n(r,i))}function o(e,t,r=!1,i){document.addEventListener(e,t,n(r,i))}r.d(t,{DD:()=>o,jT:()=>n,sp:()=>i})},5607:(e,t,r)=>{"use strict";r.d(t,{W:()=>n});const n=(0,r(9566).bz)()},9566:(e,t,r)=>{"use strict";r.d(t,{LA:()=>s,ZF:()=>c,bz:()=>a,el:()=>u});var n=r(6154);const i="xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx";function o(e,t){return e?15&e[t]:16*Math.random()|0}function a(){const e=n.gm?.crypto||n.gm?.msCrypto;let t,r=0;return e&&e.getRandomValues&&(t=e.getRandomValues(new Uint8Array(30))),i.split("").map((e=>"x"===e?o(t,r++).toString(16):"y"===e?(3&o()|8).toString(16):e)).join("")}function s(e){const t=n.gm?.crypto||n.gm?.msCrypto;let r,i=0;t&&t.getRandomValues&&(r=t.getRandomValues(new Uint8Array(e)));const a=[];for(var s=0;s<e;s++)a.push(o(r,i++).toString(16));return a.join("")}function c(){return s(16)}function u(){return s(32)}},2614:(e,t,r)=>{"use strict";r.d(t,{BB:()=>a,H3:()=>n,g:()=>u,iL:()=>c,tS:()=>s,uh:()=>i,wk:()=>o});const n="NRBA",i="SESSION",o=144e5,a=18e5,s={STARTED:"session-started",PAUSE:"session-pause",RESET:"session-reset",RESUME:"session-resume",UPDATE:"session-update"},c={SAME_TAB:"same-tab",CROSS_TAB:"cross-tab"},u={OFF:0,FULL:1,ERROR:2}},1863:(e,t,r)=>{"use strict";function n(){return Math.floor(performance.now())}r.d(t,{t:()=>n})},7485:(e,t,r)=>{"use strict";r.d(t,{D:()=>i});var n=r(6154);function i(e){if(0===(e||"").indexOf("data:"))return{protocol:"data"};try{const t=new URL(e,location.href),r={port:t.port,hostname:t.hostname,pathname:t.pathname,search:t.search,protocol:t.protocol.slice(0,t.protocol.indexOf(":")),sameOrigin:t.protocol===n.gm?.location?.protocol&&t.host===n.gm?.location?.host};return r.port&&""!==r.port||("http:"===t.protocol&&(r.port="80"),"https:"===t.protocol&&(r.port="443")),r.pathname&&""!==r.pathname?r.pathname.startsWith("/")||(r.pathname="/".concat(r.pathname)):r.pathname="/",r}catch(e){return{}}}},944:(e,t,r)=>{"use strict";function n(e,t){"function"==typeof console.debug&&console.debug("New Relic Warning: https://github.com/newrelic/newrelic-browser-agent/blob/main/docs/warning-codes.md#".concat(e),t)}r.d(t,{R:()=>n})},5284:(e,t,r)=>{"use strict";r.d(t,{t:()=>c,B:()=>s});var n=r(7836),i=r(6154);const o="newrelic";const a=new Set,s={};function c(e,t){const r=n.ee.get(t);s[t]??={},e&&"object"==typeof e&&(a.has(t)||(r.emit("rumresp",[e]),s[t]=e,a.add(t),function(e={}){try{i.gm.dispatchEvent(new CustomEvent(o,{detail:e}))}catch(e){}}({loaded:!0})))}},8990:(e,t,r)=>{"use strict";r.d(t,{I:()=>i});var n=Object.prototype.hasOwnProperty;function i(e,t,r){if(n.call(e,t))return e[t];var i=r();if(Object.defineProperty&&Object.keys)try{return Object.defineProperty(e,t,{value:i,writable:!0,enumerable:!1}),i}catch(e){}return e[t]=i,i}},6389:(e,t,r)=>{"use strict";function n(e,t=500,r={}){const n=r?.leading||!1;let i;return(...r)=>{n&&void 0===i&&(e.apply(this,r),i=setTimeout((()=>{i=clearTimeout(i)}),t)),n||(clearTimeout(i),i=setTimeout((()=>{e.apply(this,r)}),t))}}function i(e){let t=!1;return(...r)=>{t||(t=!0,e.apply(this,r))}}r.d(t,{J:()=>i,s:()=>n})},3304:(e,t,r)=>{"use strict";r.d(t,{A:()=>o});var n=r(7836);const i=()=>{const e=new WeakSet;return(t,r)=>{if("object"==typeof r&&null!==r){if(e.has(r))return;e.add(r)}return r}};function o(e){try{return JSON.stringify(e,i())??""}catch(e){try{n.ee.emit("internal-error",[e])}catch(e){}return""}}},5289:(e,t,r)=>{"use strict";r.d(t,{GG:()=>o,sB:()=>a});var n=r(3878);function i(){return"undefined"==typeof document||"complete"===document.readyState}function o(e,t){if(i())return e();(0,n.sp)("load",e,t)}function a(e){if(i())return e();(0,n.DD)("DOMContentLoaded",e)}},384:(e,t,r)=>{"use strict";r.d(t,{NT:()=>o,US:()=>d,Zm:()=>a,bQ:()=>c,dV:()=>s,nY:()=>u,pV:()=>l});var n=r(6154),i=r(1863);const o={beacon:"bam.nr-data.net",errorBeacon:"bam.nr-data.net"};function a(){return n.gm.NREUM||(n.gm.NREUM={}),void 0===n.gm.newrelic&&(n.gm.newrelic=n.gm.NREUM),n.gm.NREUM}function s(){let e=a();return e.o||(e.o={ST:n.gm.setTimeout,SI:n.gm.setImmediate,CT:n.gm.clearTimeout,XHR:n.gm.XMLHttpRequest,REQ:n.gm.Request,EV:n.gm.Event,PR:n.gm.Promise,MO:n.gm.MutationObserver,FETCH:n.gm.fetch,WS:n.gm.WebSocket}),e}function c(e,t){let r=a();r.initializedAgents??={},t.initializedAt={ms:(0,i.t)(),date:new Date},r.initializedAgents[e]=t}function u(e){let t=a();return t.initializedAgents?.[e]}function d(e,t){a()[e]=t}function l(){return function(){let e=a();const t=e.info||{};e.info={beacon:o.beacon,errorBeacon:o.errorBeacon,...t}}(),function(){let e=a();const t=e.init||{};e.init={...t}}(),s(),function(){let e=a();const t=e.loader_config||{};e.loader_config={...t}}(),a()}},2843:(e,t,r)=>{"use strict";r.d(t,{u:()=>i});var n=r(3878);function i(e,t=!1,r,i){(0,n.DD)("visibilitychange",(function(){if(t)return void("hidden"===document.visibilityState&&e());e(document.visibilityState)}),r,i)}},8139:(e,t,r)=>{"use strict";r.d(t,{u:()=>f});var n=r(7836),i=r(3434),o=r(8990),a=r(6154);const s={},c=a.gm.XMLHttpRequest,u="addEventListener",d="removeEventListener",l="nr@wrapped:".concat(n.P);function f(e){var t=function(e){return(e||n.ee).get("events")}(e);if(s[t.debugId]++)return t;s[t.debugId]=1;var r=(0,i.YM)(t,!0);function f(e){r.inPlace(e,[u,d],"-",p)}function p(e,t){return e[1]}return"getPrototypeOf"in Object&&(a.RI&&h(document,f),h(a.gm,f),h(c.prototype,f)),t.on(u+"-start",(function(e,t){var n=e[1];if(null!==n&&("function"==typeof n||"object"==typeof n)){var i=(0,o.I)(n,l,(function(){var e={object:function(){if("function"!=typeof n.handleEvent)return;return n.handleEvent.apply(n,arguments)},function:n}[typeof n];return e?r(e,"fn-",null,e.name||"anonymous"):n}));this.wrapped=e[1]=i}})),t.on(d+"-start",(function(e){e[1]=this.wrapped||e[1]})),t}function h(e,t,...r){let n=e;for(;"object"==typeof n&&!Object.prototype.hasOwnProperty.call(n,u);)n=Object.getPrototypeOf(n);n&&t(n,...r)}},3434:(e,t,r)=>{"use strict";r.d(t,{Jt:()=>o,YM:()=>c});var n=r(7836),i=r(5607);const o="nr@original:".concat(i.W);var a=Object.prototype.hasOwnProperty,s=!1;function c(e,t){return e||(e=n.ee),r.inPlace=function(e,t,n,i,o){n||(n="");const a="-"===n.charAt(0);for(let s=0;s<t.length;s++){const c=t[s],u=e[c];d(u)||(e[c]=r(u,a?c+n:n,i,c,o))}},r.flag=o,r;function r(t,r,n,s,c){return d(t)?t:(r||(r=""),nrWrapper[o]=t,function(e,t,r){if(Object.defineProperty&&Object.keys)try{return Object.keys(e).forEach((function(r){Object.defineProperty(t,r,{get:function(){return e[r]},set:function(t){return e[r]=t,t}})})),t}catch(e){u([e],r)}for(var n in e)a.call(e,n)&&(t[n]=e[n])}(t,nrWrapper,e),nrWrapper);function nrWrapper(){var o,a,d,l;try{a=this,o=[...arguments],d="function"==typeof n?n(o,a):n||{}}catch(t){u([t,"",[o,a,s],d],e)}i(r+"start",[o,a,s],d,c);try{return l=t.apply(a,o)}catch(e){throw i(r+"err",[o,a,e],d,c),e}finally{i(r+"end",[o,a,l],d,c)}}}function i(r,n,i,o){if(!s||t){var a=s;s=!0;try{e.emit(r,n,i,t,o)}catch(t){u([t,r,n,i],e)}s=a}}}function u(e,t){t||(t=n.ee);try{t.emit("internal-error",e)}catch(e){}}function d(e){return!(e&&"function"==typeof e&&e.apply&&!e[o])}},9300:(e,t,r)=>{"use strict";r.d(t,{T:()=>n});const n=r(860).K7.ajax},3333:(e,t,r)=>{"use strict";r.d(t,{TZ:()=>n,Zp:()=>i,mq:()=>s,nf:()=>a,qN:()=>o});const n=r(860).K7.genericEvents,i=["auxclick","click","copy","keydown","paste","scrollend"],o=["focus","blur"],a=4,s=1e3},6774:(e,t,r)=>{"use strict";r.d(t,{T:()=>n});const n=r(860).K7.jserrors},993:(e,t,r)=>{"use strict";r.d(t,{ET:()=>o,TZ:()=>a,p_:()=>i});var n=r(860);const i={ERROR:"ERROR",WARN:"WARN",INFO:"INFO",DEBUG:"DEBUG",TRACE:"TRACE"},o="log",a=n.K7.logging},3785:(e,t,r)=>{"use strict";r.d(t,{R:()=>c,b:()=>u});var n=r(9908),i=r(1863),o=r(860),a=r(3969),s=r(993);function c(e,t,r={},c=s.p_.INFO){(0,n.p)(a.xV,["API/logging/".concat(c.toLowerCase(),"/called")],void 0,o.K7.metrics,e),(0,n.p)(s.ET,[(0,i.t)(),t,r,c],void 0,o.K7.logging,e)}function u(e){return"string"==typeof e&&Object.values(s.p_).some((t=>t===e.toUpperCase().trim()))}},3969:(e,t,r)=>{"use strict";r.d(t,{TZ:()=>n,XG:()=>s,rs:()=>i,xV:()=>a,z_:()=>o});const n=r(860).K7.metrics,i="sm",o="cm",a="storeSupportabilityMetrics",s="storeEventMetrics"},6630:(e,t,r)=>{"use strict";r.d(t,{T:()=>n});const n=r(860).K7.pageViewEvent},782:(e,t,r)=>{"use strict";r.d(t,{T:()=>n});const n=r(860).K7.pageViewTiming},6344:(e,t,r)=>{"use strict";r.d(t,{BB:()=>d,G4:()=>o,Qb:()=>l,TZ:()=>i,Ug:()=>a,_s:()=>s,bc:()=>u,yP:()=>c});var n=r(2614);const i=r(860).K7.sessionReplay,o={RECORD:"recordReplay",PAUSE:"pauseReplay",REPLAY_RUNNING:"replayRunning",ERROR_DURING_REPLAY:"errorDuringReplay"},a=.12,s={DomContentLoaded:0,Load:1,FullSnapshot:2,IncrementalSnapshot:3,Meta:4,Custom:5},c={[n.g.ERROR]:15e3,[n.g.FULL]:3e5,[n.g.OFF]:0},u={RESET:{message:"Session was reset",sm:"Reset"},IMPORT:{message:"Recorder failed to import",sm:"Import"},TOO_MANY:{message:"429: Too Many Requests",sm:"Too-Many"},TOO_BIG:{message:"Payload was too large",sm:"Too-Big"},CROSS_TAB:{message:"Session Entity was set to OFF on another tab",sm:"Cross-Tab"},ENTITLEMENTS:{message:"Session Replay is not allowed and will not be started",sm:"Entitlement"}},d=5e3,l={API:"api"}},5270:(e,t,r)=>{"use strict";r.d(t,{Aw:()=>c,CT:()=>u,SR:()=>s});var n=r(384),i=r(9417),o=r(7767),a=r(6154);function s(e){return!!(0,n.dV)().o.MO&&(0,o.V)(e)&&!0===(0,i.gD)(e,"session_trace.enabled")}function c(e){return!0===(0,i.gD)(e,"session_replay.preload")&&s(e)}function u(e,t){const r=t.correctAbsoluteTimestamp(e);return{originalTimestamp:e,correctedTimestamp:r,timestampDiff:e-r,originTime:a.WN,correctedOriginTime:t.correctedOriginTime,originTimeDiff:Math.floor(a.WN-t.correctedOriginTime)}}},3738:(e,t,r)=>{"use strict";r.d(t,{He:()=>i,Kp:()=>s,Lc:()=>u,Rz:()=>d,TZ:()=>n,bD:()=>o,d3:()=>a,jx:()=>l,uP:()=>c});const n=r(860).K7.sessionTrace,i="bstResource",o="resource",a="-start",s="-end",c="fn"+a,u="fn"+s,d="pushState",l=1e3},3962:(e,t,r)=>{"use strict";r.d(t,{AM:()=>o,O2:()=>s,Qu:()=>c,TZ:()=>a,ih:()=>u,tC:()=>i});var n=r(860);const i=["click","keydown","submit"],o="api",a=n.K7.softNav,s={INITIAL_PAGE_LOAD:"",ROUTE_CHANGE:1,UNSPECIFIED:2},c={INTERACTION:1,AJAX:2,CUSTOM_END:3,CUSTOM_TRACER:4},u={IP:"in progress",FIN:"finished",CAN:"cancelled"}},7378:(e,t,r)=>{"use strict";r.d(t,{$p:()=>x,BR:()=>b,Kp:()=>R,L3:()=>y,Lc:()=>c,NC:()=>o,SG:()=>d,TZ:()=>i,U6:()=>p,UT:()=>m,d3:()=>w,dT:()=>f,e5:()=>A,gx:()=>v,l9:()=>l,oW:()=>h,op:()=>g,rw:()=>u,tH:()=>E,uP:()=>s,wW:()=>T,xq:()=>a});var n=r(384);const i=r(860).K7.spa,o=["click","submit","keypress","keydown","keyup","change"],a=999,s="fn-start",c="fn-end",u="cb-start",d="api-ixn-",l="remaining",f="interaction",h="spaNode",p="jsonpNode",g="fetch-start",m="fetch-done",v="fetch-body-",b="jsonp-end",y=(0,n.dV)().o.ST,w="-start",R="-end",x="-body",T="cb"+R,A="jsTime",E="fetch"},4234:(e,t,r)=>{"use strict";r.d(t,{W:()=>o});var n=r(7836),i=r(1687);class o{constructor(e,t){this.agentIdentifier=e,this.ee=n.ee.get(e),this.featureName=t,this.blocked=!1}deregisterDrain(){(0,i.x3)(this.agentIdentifier,this.featureName)}}},7767:(e,t,r)=>{"use strict";r.d(t,{V:()=>o});var n=r(9417),i=r(6154);const o=e=>i.RI&&!0===(0,n.gD)(e,"privacy.cookies_enabled")},425:(e,t,r)=>{"use strict";r.d(t,{j:()=>j});var n=r(860),i=r(2555),o=r(3371),a=r(9908),s=r(7836),c=r(1687),u=r(5289),d=r(6154),l=r(944),f=r(3969),h=r(384),p=r(6344);const g=["setErrorHandler","finished","addToTrace","addRelease","addPageAction","setCurrentRouteName","setPageViewName","setCustomAttribute","interaction","noticeError","setUserId","setApplicationVersion","start",p.G4.RECORD,p.G4.PAUSE,"log","wrapLogger"],m=["setErrorHandler","finished","addToTrace","addRelease"];var v=r(1863),b=r(2614),y=r(993),w=r(3785),R=r(2646),x=r(3434);function T(e,t,r,n){if("object"!=typeof t||!t||"string"!=typeof r||!r||"function"!=typeof t[r])return(0,l.R)(29);const i=function(e){return(e||s.ee).get("logger")}(e),o=(0,x.YM)(i),a=new R.y(s.P);return a.level=n.level,a.customAttributes=n.customAttributes,o.inPlace(t,[r],"wrap-logger-",a),i}function A(){const e=(0,h.pV)();g.forEach((t=>{e[t]=(...r)=>function(t,...r){let n=[];return Object.values(e.initializedAgents).forEach((e=>{e&&e.api?e.exposed&&e.api[t]&&n.push(e.api[t](...r)):(0,l.R)(38,t)})),n.length>1?n:n[0]}(t,...r)}))}const E={};var S=r(9417),N=r(5603),O=r(5284);const _=e=>{const t=e.startsWith("http");e+="/",r.p=t?e:"https://"+e};let I=!1;function j(e,t={},g,R){let{init:x,info:j,loader_config:P,runtime:C={},exposed:k=!0}=t;C.loaderType=g;const L=(0,h.pV)();j||(x=L.init,j=L.info,P=L.loader_config),(0,S.xN)(e.agentIdentifier,x||{}),(0,N.a)(e.agentIdentifier,P||{}),j.jsAttributes??={},d.bv&&(j.jsAttributes.isWorker=!0),(0,i.x1)(e.agentIdentifier,j);const H=(0,S.D0)(e.agentIdentifier),D=[j.beacon,j.errorBeacon];I||(H.proxy.assets&&(_(H.proxy.assets),D.push(H.proxy.assets)),H.proxy.beacon&&D.push(H.proxy.beacon),A(),(0,h.US)("activatedFeatures",O.B),e.runSoftNavOverSpa&&=!0===H.soft_navigations.enabled&&H.feature_flags.includes("soft_nav")),C.denyList=[...H.ajax.deny_list||[],...H.ajax.block_internal?D:[]],C.ptid=e.agentIdentifier,(0,o.V)(e.agentIdentifier,C),e.ee=s.ee.get(e.agentIdentifier),void 0===e.api&&(e.api=function(e,t,h=!1){t||(0,c.Ak)(e,"api");const g={};var R=s.ee.get(e),x=R.get("tracer");E[e]=b.g.OFF,R.on(p.G4.REPLAY_RUNNING,(t=>{E[e]=t}));var A="api-",S=A+"ixn-";function N(t,r,n,o){const a=(0,i.Vp)(e);return null===r?delete a.jsAttributes[t]:(0,i.x1)(e,{...a,jsAttributes:{...a.jsAttributes,[t]:r}}),I(A,n,!0,o||null===r?"session":void 0)(t,r)}function O(){}g.log=function(e,{customAttributes:t={},level:r=y.p_.INFO}={}){(0,a.p)(f.xV,["API/log/called"],void 0,n.K7.metrics,R),(0,w.R)(R,e,t,r)},g.wrapLogger=(e,t,{customAttributes:r={},level:i=y.p_.INFO}={})=>{(0,a.p)(f.xV,["API/wrapLogger/called"],void 0,n.K7.metrics,R),T(R,e,t,{customAttributes:r,level:i})},m.forEach((e=>{g[e]=I(A,e,!0,"api")})),g.addPageAction=I(A,"addPageAction",!0,n.K7.genericEvents),g.setPageViewName=function(t,r){if("string"==typeof t)return"/"!==t.charAt(0)&&(t="/"+t),(0,o.f)(e).customTransaction=(r||"http://custom.transaction")+t,I(A,"setPageViewName",!0)()},g.setCustomAttribute=function(e,t,r=!1){if("string"==typeof e){if(["string","number","boolean"].includes(typeof t)||null===t)return N(e,t,"setCustomAttribute",r);(0,l.R)(40,typeof t)}else(0,l.R)(39,typeof e)},g.setUserId=function(e){if("string"==typeof e||null===e)return N("enduser.id",e,"setUserId",!0);(0,l.R)(41,typeof e)},g.setApplicationVersion=function(e){if("string"==typeof e||null===e)return N("application.version",e,"setApplicationVersion",!1);(0,l.R)(42,typeof e)},g.start=()=>{try{(0,a.p)(f.xV,["API/start/called"],void 0,n.K7.metrics,R),R.emit("manual-start-all")}catch(e){(0,l.R)(23,e)}},g[p.G4.RECORD]=function(){(0,a.p)(f.xV,["API/recordReplay/called"],void 0,n.K7.metrics,R),(0,a.p)(p.G4.RECORD,[],void 0,n.K7.sessionReplay,R)},g[p.G4.PAUSE]=function(){(0,a.p)(f.xV,["API/pauseReplay/called"],void 0,n.K7.metrics,R),(0,a.p)(p.G4.PAUSE,[],void 0,n.K7.sessionReplay,R)},g.interaction=function(e){return(new O).get("object"==typeof e?e:{})};const _=O.prototype={createTracer:function(e,t){var r={},i=this,o="function"==typeof t;return(0,a.p)(f.xV,["API/createTracer/called"],void 0,n.K7.metrics,R),h||(0,a.p)(S+"tracer",[(0,v.t)(),e,r],i,n.K7.spa,R),function(){if(x.emit((o?"":"no-")+"fn-start",[(0,v.t)(),i,o],r),o)try{return t.apply(this,arguments)}catch(e){const t="string"==typeof e?new Error(e):e;throw x.emit("fn-err",[arguments,this,t],r),t}finally{x.emit("fn-end",[(0,v.t)()],r)}}}};function I(e,t,r,i){return function(){return(0,a.p)(f.xV,["API/"+t+"/called"],void 0,n.K7.metrics,R),i&&(0,a.p)(e+t,[(0,v.t)(),...arguments],r?null:this,i,R),r?void 0:this}}function j(){r.e(478).then(r.bind(r,8778)).then((({setAPI:t})=>{t(e),(0,c.Ze)(e,"api")})).catch((e=>{(0,l.R)(27,e),R.abort()}))}return["actionText","setName","setAttribute","save","ignore","onEnd","getContext","end","get"].forEach((e=>{_[e]=I(S,e,void 0,h?n.K7.softNav:n.K7.spa)})),g.setCurrentRouteName=h?I(S,"routeName",void 0,n.K7.softNav):I(A,"routeName",!0,n.K7.spa),g.noticeError=function(t,r){"string"==typeof t&&(t=new Error(t)),(0,a.p)(f.xV,["API/noticeError/called"],void 0,n.K7.metrics,R),(0,a.p)("err",[t,(0,v.t)(),!1,r,!!E[e]],void 0,n.K7.jserrors,R)},d.RI?(0,u.GG)((()=>j()),!0):j(),g}(e.agentIdentifier,R,e.runSoftNavOverSpa)),void 0===e.exposed&&(e.exposed=k),I=!0}},8374:(e,t,r)=>{r.nc=(()=>{try{return document?.currentScript?.nonce}catch(e){}return""})()},860:(e,t,r)=>{"use strict";r.d(t,{$J:()=>o,K7:()=>n,P3:()=>i});const n={ajax:"ajax",genericEvents:"generic_events",jserrors:"jserrors",logging:"logging",metrics:"metrics",pageAction:"page_action",pageViewEvent:"page_view_event",pageViewTiming:"page_view_timing",sessionReplay:"session_replay",sessionTrace:"session_trace",softNav:"soft_navigations",spa:"spa"},i={[n.pageViewEvent]:1,[n.pageViewTiming]:2,[n.metrics]:3,[n.jserrors]:4,[n.spa]:5,[n.ajax]:6,[n.sessionTrace]:7,[n.softNav]:8,[n.sessionReplay]:9,[n.logging]:10,[n.genericEvents]:11},o={[n.pageViewTiming]:"events",[n.ajax]:"events",[n.spa]:"events",[n.softNav]:"events",[n.metrics]:"jserrors",[n.jserrors]:"jserrors",[n.sessionTrace]:"browser/blobs",[n.sessionReplay]:"browser/blobs",[n.logging]:"browser/logs",[n.genericEvents]:"ins"}}},n={};function i(e){var t=n[e];if(void 0!==t)return t.exports;var o=n[e]={exports:{}};return r[e](o,o.exports,i),o.exports}i.m=r,i.d=(e,t)=>{for(var r in t)i.o(t,r)&&!i.o(e,r)&&Object.defineProperty(e,r,{enumerable:!0,get:t[r]})},i.f={},i.e=e=>Promise.all(Object.keys(i.f).reduce(((t,r)=>(i.f[r](e,t),t)),[])),i.u=e=>({212:"nr-spa-compressor",249:"nr-spa-recorder",478:"nr-spa"}[e]+"-1.274.0.min.js"),i.o=(e,t)=>Object.prototype.hasOwnProperty.call(e,t),e={},t="NRBA-1.274.0.PROD:",i.l=(r,n,o,a)=>{if(e[r])e[r].push(n);else{var s,c;if(void 0!==o)for(var u=document.getElementsByTagName("script"),d=0;d<u.length;d++){var l=u[d];if(l.getAttribute("src")==r||l.getAttribute("data-webpack")==t+o){s=l;break}}if(!s){c=!0;var f={478:"sha512-1vUqEfJPB8Pihje9mv5CfYgkitO1FWcS+UQb84DbXqP8oYctRv4/lzl/MzNLPlRhcY1WVDBGL20I8vm6s2VV7g==",249:"sha512-Y/BeZAh6VSTmUtUNmS5XdyKxL92s30Fyyj8xVW76HSPxcKItL4+x2+kGMZc8pMJnUpZDz1L4eftZQAJh3D8NnA==",212:"sha512-Gn2tQ3qog5Yhrx/gRutkSTYPp+7nkKFt4/mIXg99LxcNpMDAYJZDBYmAACdoHNM86+iq1F3cBcQotFNzjIX8bw=="};(s=document.createElement("script")).charset="utf-8",s.timeout=120,i.nc&&s.setAttribute("nonce",i.nc),s.setAttribute("data-webpack",t+o),s.src=r,0!==s.src.indexOf(window.location.origin+"/")&&(s.crossOrigin="anonymous"),f[a]&&(s.integrity=f[a])}e[r]=[n];var h=(t,n)=>{s.onerror=s.onload=null,clearTimeout(p);var i=e[r];if(delete e[r],s.parentNode&&s.parentNode.removeChild(s),i&&i.forEach((e=>e(n))),t)return t(n)},p=setTimeout(h.bind(null,void 0,{type:"timeout",target:s}),12e4);s.onerror=h.bind(null,s.onerror),s.onload=h.bind(null,s.onload),c&&document.head.appendChild(s)}},i.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},i.p="https://js-agent.newrelic.com/",(()=>{var e={38:0,788:0};i.f.j=(t,r)=>{var n=i.o(e,t)?e[t]:void 0;if(0!==n)if(n)r.push(n[2]);else{var o=new Promise(((r,i)=>n=e[t]=[r,i]));r.push(n[2]=o);var a=i.p+i.u(t),s=new Error;i.l(a,(r=>{if(i.o(e,t)&&(0!==(n=e[t])&&(e[t]=void 0),n)){var o=r&&("load"===r.type?"missing":r.type),a=r&&r.target&&r.target.src;s.message="Loading chunk "+t+" failed.\n("+o+": "+a+")",s.name="ChunkLoadError",s.type=o,s.request=a,n[1](s)}}),"chunk-"+t,t)}};var t=(t,r)=>{var n,o,[a,s,c]=r,u=0;if(a.some((t=>0!==e[t]))){for(n in s)i.o(s,n)&&(i.m[n]=s[n]);if(c)c(i)}for(t&&t(r);u<a.length;u++)o=a[u],i.o(e,o)&&e[o]&&e[o][0](),e[o]=0},r=self["webpackChunk:NRBA-1.274.0.PROD"]=self["webpackChunk:NRBA-1.274.0.PROD"]||[];r.forEach(t.bind(null,0)),r.push=t.bind(null,r.push.bind(r))})(),(()=>{"use strict";i(8374);var e=i(944),t=i(6344),r=i(9566);class n{agentIdentifier;constructor(e=(0,r.LA)(16)){this.agentIdentifier=e}#e(t,...r){if("function"==typeof this.api?.[t])return this.api[t](...r);(0,e.R)(35,t)}addPageAction(e,t){return this.#e("addPageAction",e,t)}setPageViewName(e,t){return this.#e("setPageViewName",e,t)}setCustomAttribute(e,t,r){return this.#e("setCustomAttribute",e,t,r)}noticeError(e,t){return this.#e("noticeError",e,t)}setUserId(e){return this.#e("setUserId",e)}setApplicationVersion(e){return this.#e("setApplicationVersion",e)}setErrorHandler(e){return this.#e("setErrorHandler",e)}addRelease(e,t){return this.#e("addRelease",e,t)}log(e,t){return this.#e("log",e,t)}}class o extends n{#e(t,...r){if("function"==typeof this.api?.[t])return this.api[t](...r);(0,e.R)(35,t)}start(){return this.#e("start")}finished(e){return this.#e("finished",e)}recordReplay(){return this.#e(t.G4.RECORD)}pauseReplay(){return this.#e(t.G4.PAUSE)}addToTrace(e){return this.#e("addToTrace",e)}setCurrentRouteName(e){return this.#e("setCurrentRouteName",e)}interaction(){return this.#e("interaction")}wrapLogger(e,t,r){return this.#e("wrapLogger",e,t,r)}}var a=i(860),s=i(9417);const c=Object.values(a.K7);function u(e){const t={};return c.forEach((r=>{t[r]=function(e,t){return!0===(0,s.gD)(t,"".concat(e,".enabled"))}(r,e)})),t}var d=i(425);var l=i(1687),f=i(4234),h=i(5289),p=i(6154),g=i(5270),m=i(7767),v=i(6389);class b extends f.W{constructor(e,t,r=!0){super(e.agentIdentifier,t),this.auto=r,this.abortHandler=void 0,this.featAggregate=void 0,this.onAggregateImported=void 0,!1===e.init[this.featureName].autoStart&&(this.auto=!1),this.auto?(0,l.Ak)(e.agentIdentifier,t):this.ee.on("manual-start-all",(0,v.J)((()=>{(0,l.Ak)(e.agentIdentifier,this.featureName),this.auto=!0,this.importAggregator(e)})))}importAggregator(t,r={}){if(this.featAggregate||!this.auto)return;let n;this.onAggregateImported=new Promise((e=>{n=e}));const o=async()=>{let o;try{if((0,m.V)(this.agentIdentifier)){const{setupAgentSession:e}=await i.e(478).then(i.bind(i,6526));o=e(t)}}catch(t){(0,e.R)(20,t),this.ee.emit("internal-error",[t]),this.featureName===a.K7.sessionReplay&&this.abortHandler?.()}try{if(t.sharedAggregator)await t.sharedAggregator;else{t.sharedAggregator=i.e(478).then(i.bind(i,9337));const{EventAggregator:e}=await t.sharedAggregator;t.sharedAggregator=new e}if(!this.#t(this.featureName,o))return(0,l.Ze)(this.agentIdentifier,this.featureName),void n(!1);const{lazyFeatureLoader:e}=await i.e(478).then(i.bind(i,6103)),{Aggregate:a}=await e(this.featureName,"aggregate");this.featAggregate=new a(t,r),n(!0)}catch(t){(0,e.R)(34,t),this.abortHandler?.(),(0,l.Ze)(this.agentIdentifier,this.featureName,!0),n(!1),this.ee&&this.ee.abort()}};p.RI?(0,h.GG)((()=>o()),!0):o()}#t(e,t){switch(e){case a.K7.sessionReplay:return(0,g.SR)(this.agentIdentifier)&&!!t;case a.K7.sessionTrace:return!!t;default:return!0}}}var y=i(6630);class w extends b{static featureName=y.T;constructor(e,t=!0){super(e,y.T,t),this.importAggregator(e)}}var R=i(384);var x=i(9908),T=i(2843),A=i(3878),E=i(782),S=i(1863);class N extends b{static featureName=E.T;constructor(e,t=!0){super(e,E.T,t),p.RI&&((0,T.u)((()=>(0,x.p)("docHidden",[(0,S.t)()],void 0,E.T,this.ee)),!0),(0,A.sp)("pagehide",(()=>(0,x.p)("winPagehide",[(0,S.t)()],void 0,E.T,this.ee))),this.importAggregator(e))}}var O=i(3969);class _ extends b{static featureName=O.TZ;constructor(e,t=!0){super(e,O.TZ,t),this.importAggregator(e)}}var I=i(6774),j=i(3304);class P{constructor(e,t,r,n,i){this.name="UncaughtError",this.message="string"==typeof e?e:(0,j.A)(e),this.sourceURL=t,this.line=r,this.column=n,this.__newrelic=i}}function C(e){return H(e)?e:new P(void 0!==e?.message?e.message:e,e?.filename||e?.sourceURL,e?.lineno||e?.line,e?.colno||e?.col,e?.__newrelic)}function k(e){const t="Unhandled Promise Rejection";if(!e?.reason)return;if(H(e.reason))try{return e.reason.message=t+": "+e.reason.message,C(e.reason)}catch(t){return C(e.reason)}const r=C(e.reason);return r.message=t+": "+r?.message,r}function L(e){if(e.error instanceof SyntaxError&&!/:\d+$/.test(e.error.stack?.trim())){const t=new P(e.message,e.filename,e.lineno,e.colno,e.error.__newrelic);return t.name=SyntaxError.name,t}return H(e.error)?e.error:C(e)}function H(e){return e instanceof Error&&!!e.stack}class D extends b{static featureName=I.T;#r=!1;constructor(e,r=!0){super(e,I.T,r);try{this.removeOnAbort=new AbortController}catch(e){}this.ee.on("internal-error",(e=>{this.abortHandler&&(0,x.p)("ierr",[C(e),(0,S.t)(),!0,{},this.#r],void 0,this.featureName,this.ee)})),this.ee.on(t.G4.REPLAY_RUNNING,(e=>{this.#r=e})),p.gm.addEventListener("unhandledrejection",(e=>{this.abortHandler&&(0,x.p)("err",[k(e),(0,S.t)(),!1,{unhandledPromiseRejection:1},this.#r],void 0,this.featureName,this.ee)}),(0,A.jT)(!1,this.removeOnAbort?.signal)),p.gm.addEventListener("error",(e=>{this.abortHandler&&(0,x.p)("err",[L(e),(0,S.t)(),!1,{},this.#r],void 0,this.featureName,this.ee)}),(0,A.jT)(!1,this.removeOnAbort?.signal)),this.abortHandler=this.#n,this.importAggregator(e)}#n(){this.removeOnAbort?.abort(),this.abortHandler=void 0}}var M=i(8990);let K=1;const U="nr@id";function V(e){const t=typeof e;return!e||"object"!==t&&"function"!==t?-1:e===p.gm?0:(0,M.I)(e,U,(function(){return K++}))}function G(e){if("string"==typeof e&&e.length)return e.length;if("object"==typeof e){if("undefined"!=typeof ArrayBuffer&&e instanceof ArrayBuffer&&e.byteLength)return e.byteLength;if("undefined"!=typeof Blob&&e instanceof Blob&&e.size)return e.size;if(!("undefined"!=typeof FormData&&e instanceof FormData))try{return(0,j.A)(e).length}catch(e){return}}}var F=i(8139),B=i(7836),W=i(3434);const z={},q=["open","send"];function Z(t){var r=t||B.ee;const n=function(e){return(e||B.ee).get("xhr")}(r);if(z[n.debugId]++)return n;z[n.debugId]=1,(0,F.u)(r);var i=(0,W.YM)(n),o=p.gm.XMLHttpRequest,a=p.gm.MutationObserver,s=p.gm.Promise,c=p.gm.setInterval,u="readystatechange",d=["onload","onerror","onabort","onloadstart","onloadend","onprogress","ontimeout"],l=[],f=p.gm.XMLHttpRequest=function(t){const r=new o(t),a=n.context(r);try{n.emit("new-xhr",[r],a),r.addEventListener(u,(s=a,function(){var e=this;e.readyState>3&&!s.resolved&&(s.resolved=!0,n.emit("xhr-resolved",[],e)),i.inPlace(e,d,"fn-",y)}),(0,A.jT)(!1))}catch(t){(0,e.R)(15,t);try{n.emit("internal-error",[t])}catch(e){}}var s;return r};function h(e,t){i.inPlace(t,["onreadystatechange"],"fn-",y)}if(function(e,t){for(var r in e)t[r]=e[r]}(o,f),f.prototype=o.prototype,i.inPlace(f.prototype,q,"-xhr-",y),n.on("send-xhr-start",(function(e,t){h(e,t),function(e){l.push(e),a&&(g?g.then(b):c?c(b):(m=-m,v.data=m))}(t)})),n.on("open-xhr-start",h),a){var g=s&&s.resolve();if(!c&&!s){var m=1,v=document.createTextNode(m);new a(b).observe(v,{characterData:!0})}}else r.on("fn-end",(function(e){e[0]&&e[0].type===u||b()}));function b(){for(var e=0;e<l.length;e++)h(0,l[e]);l.length&&(l=[])}function y(e,t){return t}return n}var Y="fetch-",X=Y+"body-",J=["arrayBuffer","blob","json","text","formData"],Q=p.gm.Request,ee=p.gm.Response,te="prototype";const re={};function ne(e){const t=function(e){return(e||B.ee).get("fetch")}(e);if(!(Q&&ee&&p.gm.fetch))return t;if(re[t.debugId]++)return t;function r(e,r,n){var i=e[r];"function"==typeof i&&(e[r]=function(){var e,r=[...arguments],o={};t.emit(n+"before-start",[r],o),o[B.P]&&o[B.P].dt&&(e=o[B.P].dt);var a=i.apply(this,r);return t.emit(n+"start",[r,e],a),a.then((function(e){return t.emit(n+"end",[null,e],a),e}),(function(e){throw t.emit(n+"end",[e],a),e}))})}return re[t.debugId]=1,J.forEach((e=>{r(Q[te],e,X),r(ee[te],e,X)})),r(p.gm,"fetch",Y),t.on(Y+"end",(function(e,r){var n=this;if(r){var i=r.headers.get("content-length");null!==i&&(n.rxSize=i),t.emit(Y+"done",[null,r],n)}else t.emit(Y+"done",[e],n)})),t}var ie=i(7485),oe=i(5603);class ae{constructor(e){this.agentIdentifier=e}generateTracePayload(e){if(!this.shouldGenerateTrace(e))return null;var t=(0,oe.o)(this.agentIdentifier);if(!t)return null;var n=(t.accountID||"").toString()||null,i=(t.agentID||"").toString()||null,o=(t.trustKey||"").toString()||null;if(!n||!i)return null;var a=(0,r.ZF)(),s=(0,r.el)(),c=Date.now(),u={spanId:a,traceId:s,timestamp:c};return(e.sameOrigin||this.isAllowedOrigin(e)&&this.useTraceContextHeadersForCors())&&(u.traceContextParentHeader=this.generateTraceContextParentHeader(a,s),u.traceContextStateHeader=this.generateTraceContextStateHeader(a,c,n,i,o)),(e.sameOrigin&&!this.excludeNewrelicHeader()||!e.sameOrigin&&this.isAllowedOrigin(e)&&this.useNewrelicHeaderForCors())&&(u.newrelicHeader=this.generateTraceHeader(a,s,c,n,i,o)),u}generateTraceContextParentHeader(e,t){return"00-"+t+"-"+e+"-01"}generateTraceContextStateHeader(e,t,r,n,i){return i+"@nr=0-1-"+r+"-"+n+"-"+e+"----"+t}generateTraceHeader(e,t,r,n,i,o){if(!("function"==typeof p.gm?.btoa))return null;var a={v:[0,1],d:{ty:"Browser",ac:n,ap:i,id:e,tr:t,ti:r}};return o&&n!==o&&(a.d.tk=o),btoa((0,j.A)(a))}shouldGenerateTrace(e){return this.isDtEnabled()&&this.isAllowedOrigin(e)}isAllowedOrigin(e){var t=!1,r={};if((0,s.gD)(this.agentIdentifier,"distributed_tracing")&&(r=(0,s.D0)(this.agentIdentifier).distributed_tracing),e.sameOrigin)t=!0;else if(r.allowed_origins instanceof Array)for(var n=0;n<r.allowed_origins.length;n++){var i=(0,ie.D)(r.allowed_origins[n]);if(e.hostname===i.hostname&&e.protocol===i.protocol&&e.port===i.port){t=!0;break}}return t}isDtEnabled(){var e=(0,s.gD)(this.agentIdentifier,"distributed_tracing");return!!e&&!!e.enabled}excludeNewrelicHeader(){var e=(0,s.gD)(this.agentIdentifier,"distributed_tracing");return!!e&&!!e.exclude_newrelic_header}useNewrelicHeaderForCors(){var e=(0,s.gD)(this.agentIdentifier,"distributed_tracing");return!!e&&!1!==e.cors_use_newrelic_header}useTraceContextHeadersForCors(){var e=(0,s.gD)(this.agentIdentifier,"distributed_tracing");return!!e&&!!e.cors_use_tracecontext_headers}}var se=i(9300),ce=i(7295),ue=["load","error","abort","timeout"],de=ue.length,le=(0,R.dV)().o.REQ,fe=(0,R.dV)().o.XHR;class he extends b{static featureName=se.T;constructor(e,t=!0){super(e,se.T,t),this.dt=new ae(e.agentIdentifier),this.handler=(e,t,r,n)=>(0,x.p)(e,t,r,n,this.ee);try{const e={xmlhttprequest:"xhr",fetch:"fetch",beacon:"beacon"};p.gm?.performance?.getEntriesByType("resource").forEach((t=>{if(t.initiatorType in e&&0!==t.responseStatus){const r={status:t.responseStatus},n={rxSize:t.transferSize,duration:Math.floor(t.duration),cbTime:0};pe(r,t.name),this.handler("xhr",[r,n,t.startTime,t.responseEnd,e[t.initiatorType]],void 0,a.K7.ajax)}}))}catch(e){}ne(this.ee),Z(this.ee),function(e,t,r,n){function i(e){var t=this;t.totalCbs=0,t.called=0,t.cbTime=0,t.end=R,t.ended=!1,t.xhrGuids={},t.lastSize=null,t.loadCaptureCalled=!1,t.params=this.params||{},t.metrics=this.metrics||{},e.addEventListener("load",(function(r){T(t,e)}),(0,A.jT)(!1)),p.lR||e.addEventListener("progress",(function(e){t.lastSize=e.loaded}),(0,A.jT)(!1))}function o(e){this.params={method:e[0]},pe(this,e[1]),this.metrics={}}function s(t,r){e.loader_config.xpid&&this.sameOrigin&&r.setRequestHeader("X-NewRelic-ID",e.loader_config.xpid);var i=n.generateTracePayload(this.parsedOrigin);if(i){var o=!1;i.newrelicHeader&&(r.setRequestHeader("newrelic",i.newrelicHeader),o=!0),i.traceContextParentHeader&&(r.setRequestHeader("traceparent",i.traceContextParentHeader),i.traceContextStateHeader&&r.setRequestHeader("tracestate",i.traceContextStateHeader),o=!0),o&&(this.dt=i)}}function c(e,r){var n=this.metrics,i=e[0],o=this;if(n&&i){var a=G(i);a&&(n.txSize=a)}this.startTime=(0,S.t)(),this.body=i,this.listener=function(e){try{"abort"!==e.type||o.loadCaptureCalled||(o.params.aborted=!0),("load"!==e.type||o.called===o.totalCbs&&(o.onloadCalled||"function"!=typeof r.onload)&&"function"==typeof o.end)&&o.end(r)}catch(e){try{t.emit("internal-error",[e])}catch(e){}}};for(var s=0;s<de;s++)r.addEventListener(ue[s],this.listener,(0,A.jT)(!1))}function u(e,t,r){this.cbTime+=e,t?this.onloadCalled=!0:this.called+=1,this.called!==this.totalCbs||!this.onloadCalled&&"function"==typeof r.onload||"function"!=typeof this.end||this.end(r)}function d(e,t){var r=""+V(e)+!!t;this.xhrGuids&&!this.xhrGuids[r]&&(this.xhrGuids[r]=!0,this.totalCbs+=1)}function l(e,t){var r=""+V(e)+!!t;this.xhrGuids&&this.xhrGuids[r]&&(delete this.xhrGuids[r],this.totalCbs-=1)}function f(){this.endTime=(0,S.t)()}function h(e,r){r instanceof fe&&"load"===e[0]&&t.emit("xhr-load-added",[e[1],e[2]],r)}function g(e,r){r instanceof fe&&"load"===e[0]&&t.emit("xhr-load-removed",[e[1],e[2]],r)}function m(e,t,r){t instanceof fe&&("onload"===r&&(this.onload=!0),("load"===(e[0]&&e[0].type)||this.onload)&&(this.xhrCbStart=(0,S.t)()))}function v(e,r){this.xhrCbStart&&t.emit("xhr-cb-time",[(0,S.t)()-this.xhrCbStart,this.onload,r],r)}function b(e){var t,r=e[1]||{};if("string"==typeof e[0]?0===(t=e[0]).length&&p.RI&&(t=""+p.gm.location.href):e[0]&&e[0].url?t=e[0].url:p.gm?.URL&&e[0]&&e[0]instanceof URL?t=e[0].href:"function"==typeof e[0].toString&&(t=e[0].toString()),"string"==typeof t&&0!==t.length){t&&(this.parsedOrigin=(0,ie.D)(t),this.sameOrigin=this.parsedOrigin.sameOrigin);var i=n.generateTracePayload(this.parsedOrigin);if(i&&(i.newrelicHeader||i.traceContextParentHeader))if(e[0]&&e[0].headers)s(e[0].headers,i)&&(this.dt=i);else{var o={};for(var a in r)o[a]=r[a];o.headers=new Headers(r.headers||{}),s(o.headers,i)&&(this.dt=i),e.length>1?e[1]=o:e.push(o)}}function s(e,t){var r=!1;return t.newrelicHeader&&(e.set("newrelic",t.newrelicHeader),r=!0),t.traceContextParentHeader&&(e.set("traceparent",t.traceContextParentHeader),t.traceContextStateHeader&&e.set("tracestate",t.traceContextStateHeader),r=!0),r}}function y(e,t){this.params={},this.metrics={},this.startTime=(0,S.t)(),this.dt=t,e.length>=1&&(this.target=e[0]),e.length>=2&&(this.opts=e[1]);var r,n=this.opts||{},i=this.target;"string"==typeof i?r=i:"object"==typeof i&&i instanceof le?r=i.url:p.gm?.URL&&"object"==typeof i&&i instanceof URL&&(r=i.href),pe(this,r);var o=(""+(i&&i instanceof le&&i.method||n.method||"GET")).toUpperCase();this.params.method=o,this.body=n.body,this.txSize=G(n.body)||0}function w(e,t){if(this.endTime=(0,S.t)(),this.params||(this.params={}),(0,ce.iW)(this.params))return;let n;this.params.status=t?t.status:0,"string"==typeof this.rxSize&&this.rxSize.length>0&&(n=+this.rxSize);const i={txSize:this.txSize,rxSize:n,duration:(0,S.t)()-this.startTime};r("xhr",[this.params,i,this.startTime,this.endTime,"fetch"],this,a.K7.ajax)}function R(e){const t=this.params,n=this.metrics;if(!this.ended){this.ended=!0;for(let t=0;t<de;t++)e.removeEventListener(ue[t],this.listener,!1);t.aborted||(0,ce.iW)(t)||(n.duration=(0,S.t)()-this.startTime,this.loadCazptureCalled||4!==e.readyState?null==t.status&&(t.status=0):T(this,e),n.cbTime=this.cbTime,r("xhr",[t,n,this.startTime,this.endTime,"xhr"],this,a.K7.ajax))}}function T(e,r){e.params.status=r.status;var n=function(e,t){var r=e.responseType;return"json"===r&&null!==t?t:"arraybuffer"===r||"blob"===r||"json"===r?G(e.response):"text"===r||""===r||void 0===r?G(e.responseText):void 0}(r,e.lastSize);if(n&&(e.metrics.rxSize=n),e.sameOrigin){var i=r.getResponseHeader("X-NewRelic-App-Data");i&&((0,x.p)(O.rs,["Ajax/CrossApplicationTracing/Header/Seen"],void 0,a.K7.metrics,t),e.params.cat=i.split(", ").pop())}e.loadCaptureCalled=!0}t.on("new-xhr",i),t.on("open-xhr-start",o),t.on("open-xhr-end",s),t.on("send-xhr-start",c),t.on("xhr-cb-time",u),t.on("xhr-load-added",d),t.on("xhr-load-removed",l),t.on("xhr-resolved",f),t.on("addEventListener-end",h),t.on("removeEventListener-end",g),t.on("fn-end",v),t.on("fetch-before-start",b),t.on("fetch-start",y),t.on("fn-start",m),t.on("fetch-done",w)}(e,this.ee,this.handler,this.dt),this.importAggregator(e)}}function pe(e,t){var r=(0,ie.D)(t),n=e.params||e;n.hostname=r.hostname,n.port=r.port,n.protocol=r.protocol,n.host=r.hostname+":"+r.port,n.pathname=r.pathname,e.parsedOrigin=r,e.sameOrigin=r.sameOrigin}const ge={},me=["pushState","replaceState"];function ve(e){const t=function(e){return(e||B.ee).get("history")}(e);return!p.RI||ge[t.debugId]++||(ge[t.debugId]=1,(0,W.YM)(t).inPlace(window.history,me,"-")),t}var be=i(3738);const{He:ye,bD:we,d3:Re,Kp:xe,TZ:Te,Lc:Ae,uP:Ee,Rz:Se}=be;class Ne extends b{static featureName=Te;constructor(e,t=!0){super(e,Te,t);if(!(0,m.V)(this.agentIdentifier))return void this.deregisterDrain();const r=this.ee;let n;ve(r),this.eventsEE=(0,F.u)(r),this.eventsEE.on(Ee,(function(e,t){this.bstStart=(0,S.t)()})),this.eventsEE.on(Ae,(function(e,t){(0,x.p)("bst",[e[0],t,this.bstStart,(0,S.t)()],void 0,a.K7.sessionTrace,r)})),r.on(Se+Re,(function(e){this.time=(0,S.t)(),this.startPath=location.pathname+location.hash})),r.on(Se+xe,(function(e){(0,x.p)("bstHist",[location.pathname+location.hash,this.startPath,this.time],void 0,a.K7.sessionTrace,r)}));try{n=new PerformanceObserver((e=>{const t=e.getEntries();(0,x.p)(ye,[t],void 0,a.K7.sessionTrace,r)})),n.observe({type:we,buffered:!0})}catch(e){}this.importAggregator(e,{resourceObserver:n})}}var Oe=i(2614);class _e extends b{static featureName=t.TZ;#i;#o;constructor(e,r=!0){let n;super(e,t.TZ,r),this.replayRunning=!1,this.#o=e;try{n=JSON.parse(localStorage.getItem("".concat(Oe.H3,"_").concat(Oe.uh)))}catch(e){}(0,g.SR)(e.agentIdentifier)&&this.ee.on(t.G4.RECORD,(()=>this.#a())),this.#s(n)?(this.#i=n?.sessionReplayMode,this.#c()):this.importAggregator(e),this.ee.on("err",(e=>{this.replayRunning&&(this.errorNoticed=!0,(0,x.p)(t.G4.ERROR_DURING_REPLAY,[e],void 0,this.featureName,this.ee))})),this.ee.on(t.G4.REPLAY_RUNNING,(e=>{this.replayRunning=e}))}#s(e){return e&&(e.sessionReplayMode===Oe.g.FULL||e.sessionReplayMode===Oe.g.ERROR)||(0,g.Aw)(this.agentIdentifier)}#u=!1;async#c(e){if(!this.#u){this.#u=!0;try{const{Recorder:t}=await Promise.all([i.e(478),i.e(249)]).then(i.bind(i,8589));this.recorder??=new t({mode:this.#i,agentIdentifier:this.agentIdentifier,trigger:e,ee:this.ee}),this.recorder.startRecording(),this.abortHandler=this.recorder.stopRecording}catch(e){}this.importAggregator(this.#o,{recorder:this.recorder,errorNoticed:this.errorNoticed})}}#a(){this.featAggregate?this.featAggregate.mode!==Oe.g.FULL&&this.featAggregate.initializeRecording(Oe.g.FULL,!0):(this.#i=Oe.g.FULL,this.#c(t.Qb.API),this.recorder&&this.recorder.parent.mode!==Oe.g.FULL&&(this.recorder.parent.mode=Oe.g.FULL,this.recorder.stopRecording(),this.recorder.startRecording(),this.abortHandler=this.recorder.stopRecording))}}var Ie=i(3962);class je extends b{static featureName=Ie.TZ;constructor(e,t=!0){if(super(e,Ie.TZ,t),!p.RI||!(0,R.dV)().o.MO)return;const r=ve(this.ee);Ie.tC.forEach((e=>{(0,A.sp)(e,(e=>{a(e)}),!0)}));const n=()=>(0,x.p)("newURL",[(0,S.t)(),""+window.location],void 0,this.featureName,this.ee);r.on("pushState-end",n),r.on("replaceState-end",n);try{this.removeOnAbort=new AbortController}catch(e){}(0,A.sp)("popstate",(e=>(0,x.p)("newURL",[e.timeStamp,""+window.location],void 0,this.featureName,this.ee)),!0,this.removeOnAbort?.signal);let i=!1;const o=new((0,R.dV)().o.MO)(((e,t)=>{i||(i=!0,requestAnimationFrame((()=>{(0,x.p)("newDom",[(0,S.t)()],void 0,this.featureName,this.ee),i=!1})))})),a=(0,v.s)((e=>{(0,x.p)("newUIEvent",[e],void 0,this.featureName,this.ee),o.observe(document.body,{attributes:!0,childList:!0,subtree:!0,characterData:!0})}),100,{leading:!0});this.abortHandler=function(){this.removeOnAbort?.abort(),o.disconnect(),this.abortHandler=void 0},this.importAggregator(e,{domObserver:o})}}var Pe=i(7378);const Ce={},ke=["appendChild","insertBefore","replaceChild"];function Le(e){const t=function(e){return(e||B.ee).get("jsonp")}(e);if(!p.RI||Ce[t.debugId])return t;Ce[t.debugId]=!0;var r=(0,W.YM)(t),n=/[?&](?:callback|cb)=([^&#]+)/,i=/(.*)\.([^.]+)/,o=/^(\w+)(\.|$)(.*)$/;function a(e,t){if(!e)return t;const r=e.match(o),n=r[1];return a(r[3],t[n])}return r.inPlace(Node.prototype,ke,"dom-"),t.on("dom-start",(function(e){!function(e){if(!e||"string"!=typeof e.nodeName||"script"!==e.nodeName.toLowerCase())return;if("function"!=typeof e.addEventListener)return;var o=(s=e.src,c=s.match(n),c?c[1]:null);var s,c;if(!o)return;var u=function(e){var t=e.match(i);if(t&&t.length>=3)return{key:t[2],parent:a(t[1],window)};return{key:e,parent:window}}(o);if("function"!=typeof u.parent[u.key])return;var d={};function l(){t.emit("jsonp-end",[],d),e.removeEventListener("load",l,(0,A.jT)(!1)),e.removeEventListener("error",f,(0,A.jT)(!1))}function f(){t.emit("jsonp-error",[],d),t.emit("jsonp-end",[],d),e.removeEventListener("load",l,(0,A.jT)(!1)),e.removeEventListener("error",f,(0,A.jT)(!1))}r.inPlace(u.parent,[u.key],"cb-",d),e.addEventListener("load",l,(0,A.jT)(!1)),e.addEventListener("error",f,(0,A.jT)(!1)),t.emit("new-jsonp",[e.src],d)}(e[0])})),t}const He={};function De(e){const t=function(e){return(e||B.ee).get("promise")}(e);if(He[t.debugId])return t;He[t.debugId]=!0;var r=t.context,n=(0,W.YM)(t),i=p.gm.Promise;return i&&function(){function e(r){var o=t.context(),a=n(r,"executor-",o,null,!1);const s=Reflect.construct(i,[a],e);return t.context(s).getCtx=function(){return o},s}p.gm.Promise=e,Object.defineProperty(e,"name",{value:"Promise"}),e.toString=function(){return i.toString()},Object.setPrototypeOf(e,i),["all","race"].forEach((function(r){const n=i[r];e[r]=function(e){let i=!1;[...e||[]].forEach((e=>{this.resolve(e).then(a("all"===r),a(!1))}));const o=n.apply(this,arguments);return o;function a(e){return function(){t.emit("propagate",[null,!i],o,!1,!1),i=i||!e}}}})),["resolve","reject"].forEach((function(r){const n=i[r];e[r]=function(e){const r=n.apply(this,arguments);return e!==r&&t.emit("propagate",[e,!0],r,!1,!1),r}})),e.prototype=i.prototype;const o=i.prototype.then;i.prototype.then=function(...e){var i=this,a=r(i);a.promise=i,e[0]=n(e[0],"cb-",a,null,!1),e[1]=n(e[1],"cb-",a,null,!1);const s=o.apply(this,e);return a.nextPromise=s,t.emit("propagate",[i,!0],s,!1,!1),s},i.prototype.then[W.Jt]=o,t.on("executor-start",(function(e){e[0]=n(e[0],"resolve-",this,null,!1),e[1]=n(e[1],"resolve-",this,null,!1)})),t.on("executor-err",(function(e,t,r){e[1](r)})),t.on("cb-end",(function(e,r,n){t.emit("propagate",[n,!0],this.nextPromise,!1,!1)})),t.on("propagate",(function(e,r,n){this.getCtx&&!r||(this.getCtx=function(){if(e instanceof Promise)var r=t.context(e);return r&&r.getCtx?r.getCtx():this})}))}(),t}const Me={},Ke="setTimeout",Ue="setInterval",Ve="clearTimeout",Ge="-start",Fe=[Ke,"setImmediate",Ue,Ve,"clearImmediate"];function Be(e){const t=function(e){return(e||B.ee).get("timer")}(e);if(Me[t.debugId]++)return t;Me[t.debugId]=1;var r=(0,W.YM)(t);return r.inPlace(p.gm,Fe.slice(0,2),Ke+"-"),r.inPlace(p.gm,Fe.slice(2,3),Ue+"-"),r.inPlace(p.gm,Fe.slice(3),Ve+"-"),t.on(Ue+Ge,(function(e,t,n){e[0]=r(e[0],"fn-",null,n)})),t.on(Ke+Ge,(function(e,t,n){this.method=n,this.timerDuration=isNaN(e[1])?0:+e[1],e[0]=r(e[0],"fn-",this,n)})),t}const We={};function ze(e){const t=function(e){return(e||B.ee).get("mutation")}(e);if(!p.RI||We[t.debugId])return t;We[t.debugId]=!0;var r=(0,W.YM)(t),n=p.gm.MutationObserver;return n&&(window.MutationObserver=function(e){return this instanceof n?new n(r(e,"fn-")):n.apply(this,arguments)},MutationObserver.prototype=n.prototype),t}const{TZ:qe,d3:Ze,Kp:Ye,$p:Xe,wW:Je,e5:Qe,tH:$e,uP:et,rw:tt,Lc:rt}=Pe;class nt extends b{static featureName=qe;constructor(e,t=!0){if(super(e,qe,t),!p.RI)return;try{this.removeOnAbort=new AbortController}catch(e){}let r,n=0;const i=this.ee.get("tracer"),o=Le(this.ee),a=De(this.ee),s=Be(this.ee),c=Z(this.ee),u=this.ee.get("events"),d=ne(this.ee),l=ve(this.ee),f=ze(this.ee);function h(e,t){l.emit("newURL",[""+window.location,t])}function g(){n++,r=window.location.hash,this[et]=(0,S.t)()}function m(){n--,window.location.hash!==r&&h(0,!0);var e=(0,S.t)();this[Qe]=~~this[Qe]+e-this[et],this[rt]=e}function v(e,t){e.on(t,(function(){this[t]=(0,S.t)()}))}this.ee.on(et,g),a.on(tt,g),o.on(tt,g),this.ee.on(rt,m),a.on(Je,m),o.on(Je,m),this.ee.on("fn-err",((...t)=>{t[2]?.__newrelic?.[e.agentIdentifier]||(0,x.p)("function-err",[...t],void 0,this.featureName,this.ee)})),this.ee.buffer([et,rt,"xhr-resolved"],this.featureName),u.buffer([et],this.featureName),s.buffer(["setTimeout"+Ye,"clearTimeout"+Ze,et],this.featureName),c.buffer([et,"new-xhr","send-xhr"+Ze],this.featureName),d.buffer([$e+Ze,$e+"-done",$e+Xe+Ze,$e+Xe+Ye],this.featureName),l.buffer(["newURL"],this.featureName),f.buffer([et],this.featureName),a.buffer(["propagate",tt,Je,"executor-err","resolve"+Ze],this.featureName),i.buffer([et,"no-"+et],this.featureName),o.buffer(["new-jsonp","cb-start","jsonp-error","jsonp-end"],this.featureName),v(d,$e+Ze),v(d,$e+"-done"),v(o,"new-jsonp"),v(o,"jsonp-end"),v(o,"cb-start"),l.on("pushState-end",h),l.on("replaceState-end",h),window.addEventListener("hashchange",h,(0,A.jT)(!0,this.removeOnAbort?.signal)),window.addEventListener("load",h,(0,A.jT)(!0,this.removeOnAbort?.signal)),window.addEventListener("popstate",(function(){h(0,n>1)}),(0,A.jT)(!0,this.removeOnAbort?.signal)),this.abortHandler=this.#n,this.importAggregator(e)}#n(){this.removeOnAbort?.abort(),this.abortHandler=void 0}}var it=i(3333);class ot extends b{static featureName=it.TZ;constructor(e,t=!0){super(e,it.TZ,t);const r=[e.init.page_action.enabled,e.init.performance.capture_marks,e.init.performance.capture_measures,e.init.user_actions.enabled];p.RI&&e.init.user_actions.enabled&&(it.Zp.forEach((e=>(0,A.sp)(e,(e=>(0,x.p)("ua",[e],void 0,this.featureName,this.ee)),!0))),it.qN.forEach((e=>(0,A.sp)(e,(e=>(0,x.p)("ua",[e],void 0,this.featureName,this.ee)))))),r.some((e=>e))?this.importAggregator(e):this.deregisterDrain()}}var at=i(993),st=i(3785);class ct extends b{static featureName=at.TZ;constructor(e,t=!0){super(e,at.TZ,t);const r=this.ee;this.ee.on("wrap-logger-end",(function([e]){const{level:t,customAttributes:n}=this;(0,st.R)(r,e,n,t)})),this.importAggregator(e)}}new class extends o{constructor(t,r){super(r),p.gm?(this.features={},(0,R.bQ)(this.agentIdentifier,this),this.desiredFeatures=new Set(t.features||[]),this.desiredFeatures.add(w),this.runSoftNavOverSpa=[...this.desiredFeatures].some((e=>e.featureName===a.K7.softNav)),(0,d.j)(this,t,t.loaderType||"agent"),this.run()):(0,e.R)(21)}get config(){return{info:this.info,init:this.init,loader_config:this.loader_config,runtime:this.runtime}}run(){try{const t=u(this.agentIdentifier),r=[...this.desiredFeatures];r.sort(((e,t)=>a.P3[e.featureName]-a.P3[t.featureName])),r.forEach((r=>{if(!t[r.featureName]&&r.featureName!==a.K7.pageViewEvent)return;if(this.runSoftNavOverSpa&&r.featureName===a.K7.spa)return;if(!this.runSoftNavOverSpa&&r.featureName===a.K7.softNav)return;const n=function(e){switch(e){case a.K7.ajax:return[a.K7.jserrors];case a.K7.sessionTrace:return[a.K7.ajax,a.K7.pageViewEvent];case a.K7.sessionReplay:return[a.K7.sessionTrace];case a.K7.pageViewTiming:return[a.K7.pageViewEvent];default:return[]}}(r.featureName).filter((e=>!(e in this.features)));n.length>0&&(0,e.R)(36,{targetFeature:r.featureName,missingDependencies:n}),this.features[r.featureName]=new r(this)}))}catch(t){(0,e.R)(22,t);for(const e in this.features)this.features[e].abortHandler?.();const r=(0,R.Zm)();delete r.initializedAgents[this.agentIdentifier]?.api,delete r.initializedAgents[this.agentIdentifier]?.features,delete this.sharedAggregator;return r.ee.get(this.agentIdentifier).abort(),!1}}}({features:[he,w,N,Ne,_e,_,D,ot,ct,je,nt],loaderType:"spa"})})()})();</script> <style data-styled="true" data-styled-version="6.1.12">.bTxVrA{animation:2s gtRCGH linear infinite;width:50px;height:50px;content:'';display:inline-block;margin-left:-25px;}/*!sc*/ .bTxVrA path{fill:#007398;}/*!sc*/ data-styled.g2[id="sc-gJhJTp"]{content:"bTxVrA,"}/*!sc*/ .kbdkrj{font-family:helvetica,sans;width:100%;text-align:center;font-size:25px;margin:30px 0 20px 0;color:#007398;}/*!sc*/ data-styled.g3[id="sc-elDIKY"]{content:"kbdkrj,"}/*!sc*/ @keyframes gtRCGH{0%{transform:rotate(0deg);}100%{transform:rotate(360deg);}}/*!sc*/ data-styled.g140[id="sc-keyframes-gtRCGH"]{content:"gtRCGH,"}/*!sc*/ </style><link href="app.css?d2057de55211601232da" rel="stylesheet"></head><body><div id="container"><header id="gh-cnt" class="mdui-public-header"><a class="anchor gh-skip-navigation" href="#main-content"><span class="anchor-text">Skip to main content</span></a><div id="gh-main-cnt" class="u-flex-center-ver u-position-relative gh-sides-padding"><a id="gh-branding" class="u-flex-center-ver" aria-label="Mendeley Data homepage" href="/"><svg class="mdui-logo" viewBox="0 0 168 24" height="31.428" width="219.996" fill="#1A1A1A" aria-hidden="true"><path d="M3.72257576,23.9678528 C2.51900984,23.8192855 1.52496806,23.1839143 0.792286958,22.2659656 C-0.218307663,21.0022877 -0.308912698,18.1090796 0.792286958,17.0275785 C1.89174421,15.9458633 2.97922243,15.3556617 4.43674381,15.5097949 C7.41124613,15.443432 7.85163887,13.1547684 7.01267109,8.83561436 C6.7053545,8.07030034 6.56944694,7.24932711 6.59732542,6.42921018 C6.5156502,4.22168062 7.64429273,2.04433546 9.72603053,0.860078912 C9.97759018,0.71600721 10.2398221,0.598480665 10.5033607,0.491871886 C10.5763239,0.461045251 10.6479803,0.435784537 10.7211613,0.407954936 C10.8013119,0.379054966 10.8829871,0.348014257 10.9661869,0.32425206 C11.6130546,0.109535986 12.302829,-0.00734833768 13.0237489,0.000358321003 C15.2633921,0.020695337 17.2133606,1.19681708 18.3058482,2.94344564 C19.8043161,4.55884693 20.5594306,5.5408037 22.0239216,5.5408037 C23.5652962,5.5408037 24.2424382,4.55884693 25.7413417,2.94344564 C26.8340471,1.19681708 28.7837978,0.020695337 31.0232232,0.000358321003 C31.743054,-0.00734833768 32.434353,0.109535986 33.0816563,0.32425206 C33.1648561,0.348014257 33.2445711,0.379054966 33.3271176,0.407954936 C33.3994273,0.435784537 33.4723905,0.461045251 33.5433935,0.491871886 C33.8080212,0.598480665 34.0693819,0.71600721 34.3226839,0.860078912 C36.4020259,2.04433546 37.5315397,4.22168062 37.4494288,6.42921018 C37.4768717,7.24932711 37.3429244,8.07030034 37.0345188,8.83561436 C36.1946798,13.1547684 36.6357259,15.443432 39.6119707,15.5097949 C40.8963406,15.3749283 42.0955505,15.834973 42.9380031,16.672644 C42.9380031,16.672644 43.9847526,17.6860696 43.9997808,19.5151166 C44.0176405,21.759895 42.9380031,22.6390964 42.9380031,22.6390964 C42.2656527,23.3498216 41.3561176,23.8402647 40.3250497,23.9678528 C38.0046025,24.2542836 35.9466049,22.5947831 35.727062,20.2615922 C35.6551878,19.4740145 35.8032922,18.7101989 36.1173606,18.0337256 C39.3682518,11.0258039 23.3370412,10.8658908 26.0440845,17.4809869 C26.0499651,17.4895498 26.0573703,17.4970424 26.0632509,17.5088165 C27.3437004,19.5213248 26.6500056,22.1375213 24.5210051,23.3478949 C23.7391011,23.7923122 22.8718192,23.9789846 22.0239216,23.9447328 C21.1764596,23.9789846 20.310049,23.7923122 19.5268382,23.3478949 C17.3965308,22.1375213 16.7026182,19.5213248 17.9835034,17.5088165 C17.9906908,17.4970424 17.9963536,17.4895498 18.002452,17.4809869 C20.710802,10.8658908 4.67980924,11.0258039 7.92939367,18.0337256 C8.24215528,18.7101989 8.39265547,19.4740145 8.31991008,20.2615922 C8.10058492,22.5947831 6.04149837,24.2542836 3.72257576,23.9678528 Z M22.4817979,7 C20.0076627,7 18,8.7895507 18,11.0005046 C18,12.2372663 18.6297264,13.3428442 19.6189734,14.0760615 C20.0490415,14.440551 20.5896792,14.7067534 21.2469914,14.8427811 C21.6395247,14.9440955 22.054217,15 22.4817979,15 L22.5007914,15 L22.5188805,15 C22.9462352,15 23.3627365,14.9440955 23.7530086,14.8427811 C24.4116775,14.7067534 24.9505062,14.440551 25.3814788,14.0760615 C26.3704997,13.3428442 27,12.2372663 27,11.0005046 C27,8.7895507 24.9932417,7 22.5188805,7 C22.5120971,7 22.5062181,7.00161457 22.5007914,7.00161457 C22.494008,7.00161457 22.4885813,7 22.4817979,7 Z"></path><g transform="translate(52.000000, 5.000000)"><path d="M10.2262574,0.9702 L12.0399505,0.9702 L12.916901,12.9312 L11.3623069,12.9312 L10.7444554,3.03 L6.23951485,13.0698 L2.1730495,3.0696 L1.47487129,12.9312 L0,12.9312 L0.876950495,0.9702 L2.81083168,0.9702 L4.46507921,5.0298 C5.40182178,7.347 6.03960396,9.0498 6.37842574,9.9804 C6.69731683,9.129 7.33509901,7.5246 8.4119604,5.0892 L10.2262574,0.9702 Z"></path><path d="M16.5026139,8.2578 L16.5026139,8.5548 C16.5026139,10.6932 17.5589406,11.862 19.4529604,11.862 C20.5092871,11.862 21.7449901,11.4066 22.2837228,10.9314 L22.4033069,12.318 C21.6060792,12.7932 20.6693366,13.1694 18.9746238,13.1694 C16.7025248,13.1694 14.9081584,11.427 14.9081584,8.4762 C14.9081584,5.3874 16.6028713,3.7236 18.9347624,3.7236 C21.7057327,3.7236 22.5627525,5.1492 22.5627525,8.2584 L16.5026139,8.2584 L16.5026139,8.2578 Z M21.167,7.0698 C21.1072079,5.3274 20.3299109,5.0106 18.834505,5.0106 C18.4159604,5.0106 17.7383168,5.1888 17.6386634,5.2878 C17.5190792,5.4066 16.820901,5.9412 16.6614554,7.0698 L21.167,7.0698 Z"></path><path d="M31.949505,12.9312 L30.4148416,12.9312 C30.4148416,12.9312 30.4945644,10.8522 30.4746337,9.0498 C30.4746337,9.0498 30.4746337,7.8618 30.454703,7.149 C30.4148416,5.7828 30.2952574,5.0892 28.9194356,5.0892 C28.441099,5.0892 27.8033168,5.2476 27.663802,5.3268 C27.464495,5.4258 26.5875446,6.3366 26.168396,6.9108 L26.168396,12.9312 L24.6337327,12.9312 L24.6337327,6.456 C24.6337327,5.7432 24.613802,5.1294 24.5540099,4.6734 L24.4742871,3.9606 L25.8893663,3.9606 L26.1285347,5.2872 C26.8659703,4.3962 27.7030594,3.723 29.0589505,3.723 C30.6733366,3.723 31.7701287,4.2378 31.9295743,6.0798 C32.009297,6.9708 31.9893663,7.8618 31.9893663,8.7534 C31.9899703,10.2378 31.949505,12.9312 31.949505,12.9312 Z"></path><path d="M42.2536733,12.9312 L40.8385941,12.9312 C40.778802,12.7134 40.6990792,12.2382 40.6592178,11.862 C39.7623366,12.7926 39.0448317,13.1688 37.8489901,13.1688 C35.6964752,13.1688 34.0017624,11.2878 34.0017624,8.4954 C34.0017624,5.4654 35.776198,3.723 38.5864257,3.723 C39.4434455,3.723 39.9417129,3.822 40.5601683,4.119 L40.5601683,0 L42.0948317,0 L42.0948317,10.4562 C42.0948317,11.169 42.1147624,11.763 42.1745545,12.219 L42.2536733,12.9312 Z M40.5595644,6.6936 C40.5595644,5.4264 39.9018515,5.0304 38.4463069,5.0304 C37.8677129,5.0304 36.9907624,5.1294 36.7914554,5.3274 C36.5522871,5.5254 35.6753366,6.6342 35.6753366,8.3574 C35.6753366,10.7538 37.0904158,11.8626 38.0875545,11.8626 C39.1438812,11.8626 40.0407624,11.0706 40.5595644,10.2984 L40.5595644,6.6936 Z"></path><path d="M45.7608713,8.2578 L45.7608713,8.5548 C45.7608713,10.6932 46.817198,11.862 48.7112178,11.862 C49.7675446,11.862 51.0032475,11.4066 51.5419802,10.9314 L51.6615644,12.318 C50.8643366,12.7932 49.9275941,13.1694 48.2328812,13.1694 C45.9607822,13.1694 44.1664158,11.427 44.1664158,8.4762 C44.1664158,5.3874 45.8611287,3.7236 48.1930198,3.7236 C50.9639901,3.7236 51.8210099,5.1492 51.8210099,8.2584 L45.7608713,8.2584 L45.7608713,8.2578 Z M50.4252574,7.0698 C50.3654653,5.3274 49.5881683,5.0106 48.0927624,5.0106 C47.6742178,5.0106 46.9965743,5.1888 46.8969208,5.2878 C46.7773366,5.4066 46.0791584,5.9412 45.9197129,7.0698 L50.4252574,7.0698 Z"></path><polygon points="53.8925941 0 55.4272574 0 55.4272574 12.9312 53.8925941 12.9312"></polygon><path d="M59.093901,8.2578 L59.093901,8.5548 C59.093901,10.6932 60.1508317,11.862 62.0442475,11.862 C63.1011782,11.862 64.3368812,11.4066 64.8756139,10.9314 L64.9945941,12.318 C64.1973663,12.7932 63.2606238,13.1694 61.5659109,13.1694 C59.2932079,13.1694 57.4994455,11.427 57.4994455,8.4762 C57.4994455,5.3874 59.1941584,3.7236 61.5260495,3.7236 C64.2970198,3.7236 65.1534356,5.1492 65.1534356,8.2584 L59.093901,8.2584 L59.093901,8.2578 Z M63.7588911,7.0698 C63.699099,5.3274 62.921802,5.0106 61.426396,5.0106 C61.0084554,5.0106 60.3308119,5.1888 60.2311584,5.2878 C60.1115743,5.4066 59.413396,5.9412 59.2539505,7.0698 L63.7588911,7.0698 Z"></path><path d="M70.3154851,10.8522 L72.6679109,3.9606 L74.1826436,3.9606 L70.8336832,13.347 C70.1566436,15.2478 69.4983267,16.8918 69.4983267,16.8918 L67.8640099,16.8918 C67.8640099,16.8918 68.5615842,15.4062 69.0797822,14.1588 L69.5587228,13.0302 L66.0503168,3.9606 L67.6840297,3.9606 L70.3154851,10.8522 Z"></path><path d="M83.8683564,12.9312 L79.742099,12.9312 L79.742099,0.9702 L84.0477327,0.9702 C88.2935743,0.9702 89.7690495,4.1784 89.7690495,6.9108 C89.7684455,9.525 88.2537129,12.9312 83.8683564,12.9312 Z M83.7886337,2.2374 L81.3166238,2.2374 L81.3166238,11.6634 L83.5893267,11.6634 C86.6393267,11.6634 87.9946139,9.9006 87.9946139,6.9108 C87.9946139,4.8714 87.0379406,2.2374 83.7886337,2.2374 Z"></path><path d="M98.2389901,12.9312 C98.1393366,12.6342 98.0590099,12.3372 98.0197525,12.0798 L97.9593564,11.7036 C97.2219208,12.8124 96.3250396,13.1892 95.1889901,13.1892 C93.0159406,13.1892 91.3218317,11.565 91.3218317,8.6544 C91.3218317,5.5452 92.8371683,3.7236 95.647396,3.7236 C96.4651584,3.7236 97.3813663,3.981 97.920099,4.674 L98.2589208,3.9612 L99.4547624,3.9612 L99.3158515,5.2284 L99.3158515,10.2582 C99.3158515,10.9314 99.5151584,12.2976 99.7337921,12.9318 L98.2389901,12.9318 L98.2389901,12.9312 Z M97.7799802,7.9212 C97.7799802,5.9214 97.0425446,5.0298 95.6872574,5.0298 C94.9697525,5.0298 94.2123861,5.2278 94.0722673,5.3664 C93.833099,5.604 92.9760792,6.4554 92.9760792,8.436 C92.9760792,11.0106 94.1719208,11.8818 95.4480891,11.8818 C96.4246931,11.8818 97.2019901,11.1888 97.7799802,9.8022 L97.7799802,7.9212 Z"></path><path d="M106.827911,12.7134 C106.289178,12.951 105.452693,13.1886 104.754515,13.1886 C103.578604,13.1886 102.740911,12.5352 102.740911,10.9512 L102.740911,5.1492 L101.106594,5.1492 L101.106594,3.9612 L102.740911,3.9612 L102.740911,1.5642 L104.236317,1.5642 L104.236317,3.9606 L106.608673,3.9606 L106.608673,5.1486 L104.236317,5.1486 L104.236317,10.4556 C104.236317,11.4654 104.495416,11.8614 105.19299,11.8614 C105.671327,11.8614 106.150267,11.6634 106.708327,11.4456 L106.827911,12.7134 Z"></path><path d="M114.521762,12.9312 C114.422109,12.6342 114.341782,12.3372 114.302525,12.0798 L114.242129,11.7036 C113.504693,12.8124 112.607812,13.1892 111.471762,13.1892 C109.298713,13.1892 107.604604,11.565 107.604604,8.6544 C107.604604,5.5452 109.119941,3.7236 111.930168,3.7236 C112.747931,3.7236 113.664139,3.981 114.202871,4.674 L114.541693,3.9612 L115.737535,3.9612 L115.598624,5.2284 L115.598624,10.2582 C115.598624,10.9314 115.797931,12.2976 116.016564,12.9318 L114.521762,12.9318 L114.521762,12.9312 Z M114.062752,7.9212 C114.062752,5.9214 113.325317,5.0298 111.97003,5.0298 C111.252525,5.0298 110.495158,5.2278 110.35504,5.3664 C110.115871,5.604 109.258851,6.4554 109.258851,8.436 C109.258851,11.0106 110.454693,11.8818 111.730861,11.8818 C112.707465,11.8818 113.484762,11.1888 114.062752,9.8022 L114.062752,7.9212 Z"></path></g></svg></a><div id="gh-nav-cnt" class="u-flex-center-ver"> <nav aria-label="utilities" class="gh-nav gh-nav-utilities gh-nav-h"><ul class="gh-nav-list u-list-reset"><li class="gh-nav-item gh-move-to-spine"><a class="anchor button-link-primary gh-nav-action gh-icon-btn" href="/faq" tabindex="0" id="aa-globalheader-help" data-aa-region="aa-globalheader-help" data-aa-name="aa-globalheader-help" title="FAQ"><span class="anchor-text"></span><svg focusable="false" role="img" aria-label="FAQ" viewBox="0 0 114 128" width="21.375" height="24" class="gh-icon icon-help"><path d="m57 8c-14.7 0-28.5 5.72-38.9 16.1-10.38 10.4-16.1 24.22-16.1 38.9 0 30.32 24.68 55 55 55 14.68 0 28.5-5.72 38.88-16.1 10.4-10.4 16.12-24.2 16.12-38.9 0-30.32-24.68-55-55-55zm0 1e1c24.82 0 45 20.18 45 45 0 12.02-4.68 23.32-13.18 31.82s-19.8 13.18-31.82 13.18c-24.82 0-45-20.18-45-45 0-12.02 4.68-23.32 13.18-31.82s19.8-13.18 31.82-13.18zm-0.14 14c-11.55 0.26-16.86 8.43-16.86 18v2h1e1v-2c0-4.22 2.22-9.66 8-9.24 5.5 0.4 6.32 5.14 5.78 8.14-1.1 6.16-11.78 9.5-11.78 20.5v6.6h1e1v-5.56c0-8.16 11.22-11.52 12-21.7 0.74-9.86-5.56-16.52-16-16.74-0.39-0.01-0.76-0.01-1.14 0zm-4.86 5e1v1e1h1e1v-1e1h-1e1z"></path><rect x="0" y="0" width="100%" height="100%" stroke="none" opacity="0"><title>FAQ</title></rect></svg></a></li></ul></nav></div><div class="gh-profile-container"><button id="gh-signin-btn" class="button button-medium u-margin-left-s gh-move-to-spine button-primary" type="button"><span class="button-text">Sign In / Register</span></button></div><div id="gh-mobile-menu" class=""><div class="gh-hamburger u-fill-grey7 u-margin-left-m"><button class="button-link button-medium u-flex-center-ver button-link-primary" aria-label="Toggle mobile menu" aria-expanded="false" type="button"><svg class="gh-hamburger-svg-el gh-hamburger-closed" role="img" aria-hidden="true" height="18" width="40"><path d="M0 14h40v2H0zm0-7h40v2H0zm0-7h40v2H0z"></path></svg></button></div><div id="gh-overlay" class="u-overlay u-display-none" role="button" tabindex="-1"></div><div id="gh-drawer" aria-label="Mobile menu" class="" role="navigation"><header id="gh-drawer-header" class="u-padding-s-xs text-s"><div class="gh-dh-opt"><div><p class="u-margin-bottom-s"></p><div class="gh-dh-actions"><button class="button-link button-medium button-link-secondary" type="button"><span class="button-link-text">Sign In / Register</span></button></div></div></div></header><div id="gh-mob-inst-cnt"></div><nav aria-label="utilities" class="gh-nav gh-nav-utilities gh-nav-v"><ul class="gh-nav-list u-list-reset"><li class="gh-nav-item"><a class="anchor button-link-primary gh-nav-action" href="/faq" tabindex="0" id="aa-globalheader-help" data-aa-region="aa-globalheader-help" data-aa-name="aa-globalheader-help" title="FAQ"><span class="anchor-text">FAQ</span></a></li></ul></nav></div></div></div><div id="gh-sub-header" class="u-flex-center-ver gh-sides-padding gh-move-to-spine"></div></header><main id="main-content"><div style="text-align:center"><div color="#007398" class="sc-elDIKY kbdkrj">Loading ...</div><svg class="sc-gJhJTp bTxVrA" version="1.1" width="512" height="512" viewBox="0 0 512 512"><path d="M275.682 147.999c0 10.864-8.837 19.661-19.682 19.661v0c-10.875 0-19.681-8.796-19.681-19.661v-96.635c0-10.885 8.806-19.661 19.681-19.661v0c10.844 0 19.682 8.776 19.682 19.661v96.635z"></path><path d="M275.682 460.615c0 10.865-8.837 19.682-19.682 19.682v0c-10.875 0-19.681-8.817-19.681-19.682v-96.604c0-10.885 8.806-19.681 19.681-19.681v0c10.844 0 19.682 8.796 19.682 19.682v96.604z"></path><path d="M147.978 236.339c10.885 0 19.681 8.755 19.681 19.641v0c0 10.885-8.796 19.702-19.681 19.702h-96.624c-10.864 0-19.661-8.817-19.661-19.702v0c0-10.885 8.796-19.641 19.661-19.641h96.624z"></path><path d="M460.615 236.339c10.865 0 19.682 8.755 19.682 19.641v0c0 10.885-8.817 19.702-19.682 19.702h-96.584c-10.885 0-19.722-8.817-19.722-19.702v0c0-10.885 8.837-19.641 19.722-19.641h96.584z"></path><path d="M193.546 165.703c7.69 7.66 7.68 20.142 0 27.822v0c-7.701 7.701-20.162 7.701-27.853 0.020l-68.311-68.322c-7.68-7.701-7.68-20.142 0-27.863v0c7.68-7.68 20.121-7.68 27.822 0l68.342 68.342z"></path><path d="M414.597 386.775c7.7 7.68 7.7 20.163 0.021 27.863v0c-7.7 7.659-20.142 7.659-27.843-0.062l-68.311-68.26c-7.68-7.7-7.68-20.204 0-27.863v0c7.68-7.7 20.163-7.7 27.842 0l68.291 68.322z"></path><path d="M165.694 318.464c7.69-7.7 20.153-7.7 27.853 0v0c7.68 7.659 7.69 20.163 0 27.863l-68.342 68.322c-7.67 7.659-20.142 7.659-27.822-0.062v0c-7.68-7.68-7.68-20.122 0-27.801l68.311-68.322z"></path><path d="M386.775 97.362c7.7-7.68 20.142-7.68 27.822 0v0c7.7 7.68 7.7 20.183 0.021 27.863l-68.322 68.311c-7.68 7.68-20.163 7.68-27.843-0.020v0c-7.68-7.68-7.68-20.162 0-27.822l68.322-68.332z"></path></svg></div></main><footer class="mdui-footer"><div class="footer-container"><div class="footer-contents"><div role="img" aria-label="Digital Commons Data"><svg class="mdui-logo" viewBox="0 0 222.69 47.877" height="47.877" width="222.69" aria-hidden="true"><path fill="#FF8200" d="m7.5371 21.553h-6.832v-19.936h7.1289c7.0303 0 9.4727 5.3477 9.4727 9.9023-1e-4 4.3565-2.5084 10.033-9.7696 10.033zm-0.1318-17.822h-4.0928v15.71h3.7627c5.0498 0 7.2939-2.9375 7.2939-7.9209 0-3.4005-1.5839-7.7891-6.9638-7.7891z"></path><path fill="#FF8200" d="m22.32 3.9941c-0.8911 0-1.6504-0.9238-1.6504-1.8477 0-0.8916 0.7261-1.8164 1.6504-1.8164 0.8911 0 1.6831 0.8594 1.6831 1.7832s-0.792 1.8809-1.6831 1.8809zm-1.2539 2.6075h2.541v14.951h-2.541v-14.951z"></path><path fill="#FF8200" d="m29.877 23.434c0 2.3438 0.9243 2.9375 3.3008 2.9375 2.8052 0 4.6533-0.8906 4.6533-3.7617 0-0.6602-0.0659-1.7168-0.0659-3.0703-1.1553 1.2871-2.3765 1.9473-4.3564 1.9473-3.5645 0-6.3701-2.4746-6.3701-7.0625 0-5.1816 2.4756-8.2188 7.1289-8.2188 1.3535 0 2.9048 0.3965 3.7959 1.584l0.561-1.1875h1.98l-0.231 2.1123v11.057c0 1.1553 0.0332 2.7393 0.0332 3.1689 0 3.5312-2.5083 5.6104-7.0303 5.6104-3.2671 0-6.0068-1.0234-6.0068-4.6201l2.6074-0.4961zm7.8554-10.23c0-3.334-1.2212-4.8193-3.4658-4.8193-1.188 0-2.4424 0.3301-2.6733 0.5615-0.396 0.3955-1.8154 1.8477-1.8154 5.1484 0 4.1914 1.8154 5.2148 3.9609 5.2148 1.7163 0 3.2344-1.2539 3.9937-2.8057v-3.2997z"></path><path fill="#FF8200" d="m46.146 3.9941c-0.8911 0-1.6504-0.9238-1.6504-1.8477 0-0.8916 0.7266-1.8164 1.6504-1.8164 0.8911 0 1.6831 0.8594 1.6831 1.7832s-0.792 1.8809-1.6831 1.8809zm-1.2539 2.6075h2.541v14.951h-2.541v-14.951z"></path><path fill="#FF8200" d="m59.874 21.19c-0.8911 0.3965-2.2773 0.793-3.4321 0.793-1.9473 0-3.3335-1.0898-3.3335-3.7305v-9.67h-2.7065v-1.9804h2.7065v-3.9942h2.4751v3.9941h3.9277v1.9805h-3.9277v8.8457c0 1.6826 0.4292 2.3428 1.5845 2.3428 0.792 0 1.584-0.3301 2.5083-0.6934l0.1977 2.1124z"></path><path fill="#FF8200" d="m72.612 21.553c-0.165-0.4951-0.2969-0.9902-0.3628-1.4199l-0.0991-0.627c-1.2212 1.8486-2.7065 2.4766-4.5879 2.4766-3.5972 0-6.4028-2.707-6.4028-7.5586 0-5.1816 2.5083-8.2188 7.1621-8.2188 1.353 0 2.8716 0.4297 3.7627 1.584l0.561-1.1875h1.98l-0.231 2.1123v8.3838c0 1.1211 0.3301 3.3984 0.6934 4.4551h-2.4756zm-0.7588-8.3496c0-3.334-1.2212-4.8193-3.4658-4.8193-1.188 0-2.4424 0.3301-2.6733 0.5615-0.396 0.3955-1.8154 1.8145-1.8154 5.1152 0 4.291 1.9805 5.7432 4.0928 5.7432 1.6172 0 2.9043-1.1553 3.8618-3.4658v-3.1348z"></path><path fill="#FF8200" d="M79.0132,0h2.541v21.5527h-2.541V0z"></path><path fill="#FF8200" d="m107.72 20.793c-1.749 0.8916-4.2246 1.1562-5.7754 1.1562-5.644 0-10.694-3.6973-10.694-10.232 0-5.6758 3.7954-10.495 11.023-10.495 2.5088 0 4.291 0.5947 5.4458 1.1553l-0.165 2.5078c-1.8149-1.0225-4.0596-1.3857-5.7427-1.3857-5.0825 0-7.5908 3.6963-7.5908 7.8877 0 4.7207 3.2012 8.252 7.7891 8.252 1.4189 0 3.5645-0.3301 5.5444-1.3867l0.165 2.5409z"></path><path fill="#FF8200" d="m116.86 21.949c-4.1587 0-6.9312-3.1035-6.9312-7.8555 0-4.3896 2.5415-7.8887 7.2939-7.8887 4.1919 0 6.9644 3.0039 6.9644 7.8887 0 4.6211-2.8056 7.8555-7.3271 7.8555zm0.0327-13.565c-1.188 0-2.2441 0.5283-2.541 0.8252-0.3301 0.3301-1.6836 2.1455-1.6836 4.7197 0 4.7529 2.5415 5.8418 4.522 5.8418 1.0562 0 2.2114-0.4619 2.5742-0.8252 0.3633-0.3633 1.6831-2.0791 1.6831-4.6211 0-2.7715-0.8911-5.9404-4.5547-5.9404z"></path><path fill="#FF8200" d="m149.34 21.553h-2.541s0.1318-3.4648 0.0986-6.4688c0 0 0-1.9805-0.0332-3.168-0.0654-2.2773-0.2637-3.4336-2.541-3.4336-0.792 0-1.8486 0.2646-2.0791 0.3965-0.3301 0.165-1.7822 1.6836-2.4756 2.6406v10.033h-2.541v-10.033c0-2.0137-0.5283-3.0371-2.5088-3.0371-0.792 0-1.8486 0.2646-2.0791 0.3965-0.3301 0.165-1.7822 1.6836-2.4756 2.6406v10.033h-2.541v-10.793c0-1.1875-0.0332-2.2109-0.1323-2.9707l-0.1318-1.1875h2.3433l0.396 2.2109c1.2212-1.4844 2.6079-2.6074 4.8521-2.6074 2.3428 0 3.9932 0.5947 4.5547 2.8057 1.2539-1.584 2.8047-2.8057 5.0498-2.8057 2.6729 0 4.4883 0.8584 4.752 3.9277 0.1328 1.4854 0.0996 2.9707 0.0996 4.4561-2e-4 2.4757-0.0666 6.9639-0.0666 6.9639z"></path><path fill="#FF8200" d="m175.61 21.553h-2.541s0.1318-3.4648 0.0986-6.4688c0 0 0-1.9805-0.0332-3.168-0.0654-2.2773-0.2637-3.4336-2.541-3.4336-0.792 0-1.8486 0.2646-2.0791 0.3965-0.3301 0.165-1.7822 1.6836-2.4756 2.6406v10.033h-2.541v-10.033c0-2.0137-0.5283-3.0371-2.5088-3.0371-0.792 0-1.8486 0.2646-2.0791 0.3965-0.3301 0.165-1.7822 1.6836-2.4756 2.6406v10.033h-2.541v-10.793c0-1.1875-0.0332-2.2109-0.1318-2.9707l-0.1328-1.1875h2.3438l0.3965 2.2109c1.2207-1.4844 2.6074-2.6074 4.8516-2.6074 2.3428 0 3.9932 0.5947 4.5547 2.8057 1.2539-1.584 2.8047-2.8057 5.0498-2.8057 2.6729 0 4.4883 0.8584 4.752 3.9277 0.1328 1.4854 0.0996 2.9707 0.0996 4.4561-2e-4 2.4757-0.0666 6.9639-0.0666 6.9639z"></path><path fill="#FF8200" d="m185.9 21.949c-4.1582 0-6.9307-3.1035-6.9307-7.8555 0-4.3896 2.541-7.8887 7.2939-7.8887 4.1914 0 6.9639 3.0039 6.9639 7.8887 1e-4 4.6211-2.8046 7.8555-7.3271 7.8555zm0.0332-13.565c-1.1875 0-2.2441 0.5283-2.541 0.8252-0.3301 0.3301-1.6836 2.1455-1.6836 4.7197 0 4.7529 2.542 5.8418 4.5215 5.8418 1.0566 0 2.2119-0.4619 2.5752-0.8252 0.3623-0.3633 1.6826-2.0791 1.6826-4.6211 0-2.7715-0.8906-5.9404-4.5547-5.9404z"></path><path fill="#FF8200" d="m208.77 21.553h-2.541s0.1318-3.4648 0.0986-6.4688c0 0 0-1.9805-0.0332-3.168-0.0654-2.2773-0.2637-3.4336-2.541-3.4336-0.792 0-1.8486 0.2646-2.0791 0.3965-0.3301 0.165-1.7822 1.6836-2.4756 2.6406v10.033h-2.541v-10.793c0-1.1875-0.0332-2.2109-0.1318-2.9707l-0.1328-1.1875h2.3438l0.3965 2.2109c1.2207-1.4844 2.6074-2.6074 4.8516-2.6074 2.6729 0 4.4883 0.8584 4.752 3.9277 0.1328 1.4854 0.0996 2.9707 0.0996 4.4561-2e-4 2.4758-0.0666 6.964-0.0666 6.964z"></path><path fill="#FF8200" d="m217.25 21.982c-1.6836 0-3.499-0.4297-4.6543-1.2217l0.2979-2.376c1.0889 0.6924 2.2109 1.5176 4.1582 1.5176 2.1123 0 3.1025-0.957 3.1025-2.1123 0-3.0361-7.459-2.8711-7.459-7.4912 0-2.2451 1.749-4.0938 5.3467-4.0938 1.9805 0 3.2676 0.5615 4.291 1.123l-0.2646 2.376c-1.2871-1.1885-2.9375-1.4521-3.9932-1.4521-1.6836 0-2.8389 0.6602-2.8389 1.8477 0 3.0039 7.459 2.7402 7.459 7.4922 0 2.2119-1.6504 4.3906-5.4453 4.3906z"></path><path fill="#888B8D" d="m5.1738 47.553h-5.1738v-15.096h5.3989c5.3237 0 7.1733 4.0488 7.1733 7.498 1e-4 3.2989-1.8993 7.5977-7.3984 7.5977zm-0.0996-13.496h-3.0996v11.896h2.8496c3.8237 0 5.5234-2.2246 5.5234-5.998 1e-4 -2.5742-1.1997-5.8985-5.2734-5.8985z"></path><path fill="#888B8D" d="m23.198 47.553c-0.125-0.375-0.2246-0.75-0.2749-1.0742l-0.0747-0.4756c-0.9248 1.3994-2.0498 1.874-3.4741 1.874-2.7246 0-4.8491-2.0488-4.8491-5.7227 0-3.9238 1.8999-6.2236 5.4238-6.2236 1.0249 0 2.1743 0.3252 2.8491 1.2002l0.4253-0.9004h1.4995l-0.1748 1.5996v6.3486c0 0.8496 0.2495 2.5742 0.5249 3.374h-1.875zm-0.5747-6.3232c0-2.5244-0.9248-3.6494-2.6245-3.6494-0.8994 0-1.8491 0.25-2.0244 0.4248-0.2998 0.2998-1.3745 1.375-1.3745 3.874 0 3.25 1.4995 4.3496 3.0991 4.3496 1.2246 0 2.1997-0.875 2.9243-2.625v-2.374z"></path><path fill="#888B8D" d="m33.974 47.277c-0.6748 0.3008-1.7246 0.5996-2.5996 0.5996-1.4746 0-2.5244-0.8242-2.5244-2.8242v-7.3223h-2.0493v-1.5h2.0493v-3.0244h1.8745v3.0244h2.9741v1.5h-2.9741v6.6982c0 1.2744 0.3252 1.7744 1.1997 1.7744 0.6001 0 1.1997-0.25 1.8994-0.5254l0.1504 1.5997z"></path><path fill="#888B8D" d="m43.623 47.553c-0.1245-0.375-0.2246-0.75-0.2749-1.0742l-0.0747-0.4756c-0.9248 1.3994-2.0498 1.874-3.4741 1.874-2.7246 0-4.8491-2.0488-4.8491-5.7227 0-3.9238 1.8999-6.2236 5.4238-6.2236 1.0249 0 2.1743 0.3252 2.8491 1.2002l0.4253-0.9004h1.4995l-0.1748 1.5996v6.3486c0 0.8496 0.2495 2.5742 0.5244 3.374h-1.8745zm-0.5747-6.3232c0-2.5244-0.9248-3.6494-2.6245-3.6494-0.8994 0-1.8491 0.25-2.0244 0.4248-0.2998 0.2998-1.3745 1.375-1.3745 3.874 0 3.25 1.4995 4.3496 3.0991 4.3496 1.2246 0 2.1997-0.875 2.9243-2.625v-2.374z"></path></svg></div><div class="links"><ul class="mdui-text-small"><li><a href="/">Home</a></li><li><span class="separator">|</span></li><li><a href="/about">About</a></li><li><span class="separator">|</span></li><li><a href="/accessibility">Accessibility Statement</a></li><li><span class="separator">|</span></li><li><a href="/archive-process">Archive Policy</a></li><li><span class="separator">|</span></li><li><a href="/file-formats">File Formats</a></li><li><span class="separator">|</span></li><li><a href="/api/docs">API Docs</a></li><li><span class="separator">|</span></li><li><a href="/oai?verb=Identify">OAI</a></li><li><span class="separator">|</span></li><li><a href="/mission">Mission</a></li></ul><ul class="mdui-text-smaller"><li><a href="https://www.mendeley.com/terms/">Terms of Use</a></li><li><span class="separator">|</span></li><li><a href="https://www.elsevier.com/legal/privacy-policy">Privacy Policy</a></li><li><span class="separator">|</span></li><li><button id="ot-sdk-btn" type="button" class="mdui-button action ot-sdk-show-settings">Cookie Settings</button></li></ul><ul class="copyright mdui-text-smaller"><li>All content on this site: Copyright 漏 2024 Elsevier inc, its licensors, and contributors. All rights are reserved, including those for text and data mining, AI training and similar technologies. For all open access content, the Creative Commons licensing terms apply.</li></ul></div></div></div></footer></div><script src="https://static.data.mendeley.com/scripts/script-v2.0.4.min.js" data-ot-ignore></script><script data-ot-ignore>window.__state = {"environment":"live","error":null,"institution":null,"location":{"hostname":"data.mendeley.com","pathname":"/api/docs/"},"s3":"https://static.data.mendeley.com","spec":{"openapi":"3.0.3","info":{"title":"Digital Commons Data API","description":"# Introduction\nDigital Commons Data API lets you find and manage research data, you can find out more about Digital Commons Data on [our FAQs page](https://data.mendeley.com/faq)\n\n> **NOTE from 1st October 2024 the Digital Commons Data APIs will no longer accept traffic via api.mendeley.com**,\n> use https://api.data.mendeley.com instead. Additionally, authorization via Mendeley Oauth will no longer be supported\n> on this date any existing clients will need to migrate to the Authentication documented below.\n\nIf you just want to harvest our entire repository of public dataset records, there's no need to reach out to register a client. Instead, please go to the [OAI-PMH](#tag/oai-pmh) section for additional information and instructions.\n\n# Authentication\nOur APIs use OpenID Connect (OIDC) which extends the [OAuth 2.0](https://datatracker.ietf.org/doc/html/rfc6749) authorization protocol for use as an additional authentication protocol, refer to the\n[OpenID Connect specifications](https://openid.net/specs/openid-connect-core-1_0.html) for more details.\n\nUsing the standard OIDC/OAuth 2.0 `authorization_code` flow, your client application can authenticate a user the result provided three tokens, which can be used to make API calls on behalf of the user:\n\n- `Access token`: A token that can be sent in API requests (as part of the `Authorization` header), this token has a short expiry.\n- `Refresh token`: A token that can be used to create a new access token without requiring the user to login again.\n- `Identity token`: A token containing claims (information) about the logged in user like name, email and roles.\n\nDigital Commons Data partially supports `client_credentials` flow, however since the result of this flow does not contain a authenticated user (resource owner) some endpoints\ndo not support access tokens from this flow.\n \nIt is highly recommended to use a [OAuth2 or OIDC client library](https://oauth.net/code/) to implement the authorization flows and obtain tokens.\n\n## Register a Client\nTo use our APIs you will need to register a client, currently you will need to [get in touch](mailto:data-queries@mendeley.com?subject=Digital%20Commons%20Data%20API%20client%20request) providing:\n- A contact email address\n- Company or personal name\n- Brief description of the use case for using the API\n\nIf you just want to harvest our entire repository of public dataset records, there's no need to reach out to register a client. Instead, please go to the [OAI-PMH](#tag/oai-pmh) section for additional information and instructions.\n\n## Obtain a Token Using Authorization Code flow\nSteps:\n1. Authorize user\n2. Exchange authorization code for tokens\n3. Use access token in an API request\n\n### Authorize user\n```\nGET https://auth.data.mendeley.com/oauth2/authorize?response_type=code&client_id=\u003cYOUR-CLIENT-ID>&redirect_uri=\u003cYOUR-REDIRECT-URI>&scope=openid%20profile%20email%20dcd:profile&state=\u003cRANDOM-STRING>\n```\nThe above URL will redirect the user to sign in to the Digital Commons Data application. Once signed in, the response triggers an HTTP 302 status, redirecting back to \u003cYOUR CALLBACK URL> with a code query parameter. This is the authorization code required for the next stage.\n\n### Exchange authorization code for tokens\n```\ncurl -X POST \\\n -H \"Content-Type: application/x-www-form-urlencoded\" \\\n -u \"\u003cYOUR CLIENT ID>:\u003cYOUR CLIENT SECRET>\" \\\n -d \"grant_type=authorization_code&code=\u003cYOUR AUTH CODE>&redirect_uri=\u003cYOUR REDIRECT URI> https://auth.data.mendeley.com/oauth2/token\n```\nExample response:\n```\n {\n \"access_token\":\"aaa.bbb.ccc\",\n \"refresh_token\":\"def\",\n \"scope\":\"openid profile email dcd:profile\",\n \"id_token\":\"iii.ttt\",\n \"token_type\":\"Bearer\",\n \"expires_in\":299\n}\n```\n\n### Use access token in an API request\nUsing the `access_token` value from the previous response, set the `Authorization` Bearer token, for example:\n```\ncurl -X GET \\\n -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer aaa.bbb.ccc\" \\\n https://api.data.mendeley.com/datasets\n```\n\n## Obtain a Token Using Client Credentials flow\nSteps:\n1. Create an access token\n3. Use access token in an API request\n\n### Create an access token\n```\ncurl -X POST \\\n -H \"Content-Type: application/x-www-form-urlencoded\" \\\n -u \"\u003cYOUR CLIENT ID>:\u003cYOUR CLIENT SECRET>\" \\\n -d \"grant_type=client_credentials&scope=\u003cYOUR REQUESTED SCOPES> https://auth.data.mendeley.com/oauth2/token\n```\nExample response:\n```\n{\n \"access_token\":\"aaa.bbb.ccc\",\n \"token_type\":\"Bearer\",\n \"expires_in\":299\n}\n```\n\n### Use access token in an API request\nUsing the `access_token` value from the previous response, set the `Authorization` Bearer token, for example:\n```\ncurl -X GET \\\n -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer aaa.bbb.ccc\" \\\n https://api.data.mendeley.com/datasets\n```\n\n## OAuth2 Server Details\n\n\u003cSecurityDefinitions />\n","termsOfService":"https://data.mendeley.com/terms/","version":""},"servers":[{"url":"https://api.data.mendeley.com","description":"API Gateway"}],"security":[{"OAuth2":["openid","profile","email","dcd:profile"]}],"tags":[{"name":"draft-datasets","description":"Draft datasets","x-displayName":"Draft Datasets"},{"name":"public-datasets","description":"Public datasets\n\nIf you just want to harvest our entire repository of public dataset records, there's no need to reach out to register a client. Instead, please go to the [OAI-PMH](#tag/oai-pmh) section for additional information and instructions.\n","x-displayName":"Public Datasets"},{"name":"files","description":"Files associated with research data","x-displayName":"Files"},{"name":"licences","description":"Licences for datasets","x-displayName":"Licences"},{"name":"draft-collections","description":"Draft collections","x-displayName":"Draft Collections"},{"name":"public-collections","description":"Public collections","x-displayName":"Public Collections"},{"name":"workspaces","description":"Project workspaces","x-displayName":"Workspaces"},{"name":"templates","description":"Project templates","x-displayName":"Templates"},{"name":"audit-log","description":"Audit Log","x-displayName":"Audit Log"},{"name":"dataset-management","description":"Dataset Management","x-displayName":"Dataset Management"},{"name":"featured-sections","description":"Featured Sections","x-displayName":"Featured Sections"},{"name":"metrics","description":"Metrics","x-displayName":"Metrics"},{"name":"moderation","description":"Moderation","x-displayName":"Moderation"},{"name":"oai-pmh","description":"Digital Commons Data supports harvesting our entire repository of public dataset records using the [Open Archives Initiative Protocol for Metadata Harvesting (OAI-PMH)](https://www.openarchives.org/OAI/openarchivesprotocol.html#Repository) standard. Refer to the full [OAI-PMH specification](https://www.openarchives.org/OAI/openarchivesprotocol.html#ProtocolMessages) for how to interact with this service.\n\nThe base URL for the Digital Commons Data OAI-PMH repository is `https://data.mendeley.com/oai` or you can [browse it here](https://data.mendeley.com/oai?verb=Identify) note that the OAI-PMH repository\nis open access and does not require authorization.\n","x-displayName":"OAI-PMH"},{"name":"user-management","description":"User Management","x-displayName":"User Management"},{"name":"search","description":"Digital Commons Data uses the [Data Monitor](https://www.elsevier.com/products/data-monitor) Search API to index and search research data. See the [API documentation for the Search API](https://docs.datasearch.elsevier.com/swagger-ui/index.html)\n","x-displayName":"Search"},{"name":"institutions","description":"Institutions","x-displayName":"Institutions"}],"paths":{"/uploads":{"post":{"tags":["files"],"summary":"Upload a file","description":"Upload file content","operationId":"64e7c745_uploads","parameters":[{"name":"Content-Length","in":"header","required":false,"style":"simple","explode":false,"schema":{"type":"integer","format":"int64"}},{"name":"Content-Disposition","in":"header","description":"The content disposition of the file to upload","required":false,"style":"simple","explode":false,"schema":{"$ref":"#/components/schemas/ContentDisposition"}},{"name":"Content-Type","in":"header","description":"The MIME type of the file to upload","required":false,"style":"simple","explode":false,"schema":{"type":"string","default":"application/octet-stream"}},{"name":"access_restriction_level","in":"query","description":"Whether the file being uploaded is confidential","required":false,"style":"form","explode":true,"schema":{"type":"string"}}],"requestBody":{"description":"The file (to upload) as a stream","content":{"*/*":{"schema":{"type":"object"}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileMetadata"}}}},"400":{"description":"Bad request, the content-type and/or the file to upload is not valid or missing."}}},"servers":[{"url":"https://uploads.data.mendeley.com"}]},"/uploads/transfer":{"post":{"tags":["transfer"],"summary":"Transfer file from external source","description":"Transfer file from external source","operationId":"64e7c745_transfer","requestBody":{"description":"Transfer file request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransferRequest"}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileMetadata"}}}},"400":{"description":"Bad request, the request object was invalid."}}},"servers":[{"url":"https://uploads.data.mendeley.com"}]},"/active-data-manager":{"get":{"tags":["workspaces"],"summary":"Get workspace discovery details","description":"Root discovery endpoint","operationId":"c71cc27_get","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RootResourceResponse"}}}}}}},"/active-data-manager/enumerators/actor_types":{"get":{"tags":["workspaces"],"summary":"Get actor-type enumerators","description":"List the actor types available","operationId":"c71cc27_get_1","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EnumeratorResourceResponse"}}}}}}}},"/active-data-manager/enumerators/content_states":{"get":{"tags":["workspaces"],"summary":"Get content-state enumerators","description":"List the content states available","operationId":"c71cc27_get_2","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EnumeratorResourceResponse"}}}}}}}},"/active-data-manager/enumerators/content_types":{"get":{"tags":["workspaces"],"summary":"Get content-type enumerators","description":"List the content types available","operationId":"c71cc27_get_3","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EnumeratorResourceResponse"}}}}}}}},"/active-data-manager/enumerators":{"get":{"description":"Enumerators discovery endpoint","operationId":"c71cc27_get_4","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnumeratorsResourceResponse"}}}}}}},"/active-data-manager/enumerators/event_entity_types":{"get":{"tags":["workspaces"],"summary":"Get entity-type enumerators","description":"List the event entity types available","operationId":"c71cc27_get_5","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EnumeratorResourceResponse"}}}}}}}},"/active-data-manager/enumerators/event_operation_types":{"get":{"tags":["workspaces"],"summary":"Get event-operation-type enumerators","description":"List the event operation types available","operationId":"c71cc27_get_6","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EnumeratorResourceResponse"}}}}}}}},"/active-data-manager/enumerators/owner_types":{"get":{"tags":["workspaces"],"summary":"Get owner-type enumerators","description":"List the owner types available","operationId":"c71cc27_get_7","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EnumeratorResourceResponse"}}}}}}}},"/active-data-manager/enumerators/permissions":{"get":{"tags":["workspaces"],"summary":"Get permission enumerators","description":"List the permissions available","operationId":"c71cc27_get_8","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EnumeratorResourceResponse"}}}}}}}},"/active-data-manager/enumerators/workspace_types":{"get":{"tags":["workspaces"],"summary":"Get workspace-type enumerators","description":"List the workspace types available","operationId":"c71cc27_get_9","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EnumeratorResourceResponse"}}}}}}}},"/active-data-manager/events":{"get":{"operationId":"c71cc27_get_10","responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/active-data-manager/my":{"get":{"description":"Current user discovery endpoint","operationId":"c71cc27_get_11","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MyResourceResponse"}}}}}}},"/active-data-manager/my/entitlements":{"get":{"tags":["workspaces"],"summary":"Get my entitlements for workspaces","description":"Current user entitlements for workspaces","operationId":"c71cc27_get_12","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MyEntitlementsResourceResponse"}}}}}}},"/active-data-manager/templates":{"get":{"tags":["templates"],"summary":"Get template discovery details","description":"Templates discovery endpoint","operationId":"c71cc27_get_13","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TemplatesResourceResponse"}}}}}}},"/active-data-manager/templates/containers/{container_id}":{"get":{"tags":["templates"],"summary":"Get a template container","description":"Retrieves a specific template container","operationId":"c71cc27_get_14","parameters":[{"name":"If-None-Match","in":"header","description":"If-None-Match conditional header (ETag)","required":false,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"container_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TemplateContainerResourceResponse"}}}}}},"delete":{"tags":["templates"],"summary":"Delete a template container","description":"Deletes a specific template container","operationId":"c71cc27_delete","parameters":[{"name":"If-Match","in":"query","description":"If-Match conditional header (ETag)","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"container_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"No Content"}}}},"/active-data-manager/templates/containers":{"get":{"tags":["templates"],"summary":"Get template containers","description":"List/query template containers","operationId":"c71cc27_get_15","parameters":[{"name":"$start","in":"query","description":"Start offset for items to be retrieved (0 - n)","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int64"}},{"name":"$limit","in":"query","description":"Limit of number of items to be retrieved (page size) [default = 100]","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int64"}},{"name":"$page","in":"query","description":"Page number for items to be retrieved (1 - n)","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int64"}},{"name":"Range","in":"header","description":"Range header (use tokens 'start', 'limit' or 'page')","required":false,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"$sort","in":"query","description":"Property, or properties, to sort result by (comma separated)","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"$properties","in":"query","description":"Properties to be returned","required":false,"style":"form","explode":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TemplateContainerResourceResponse"}}}}},"206":{"description":"Partial Content"}}},"post":{"tags":["templates"],"summary":"Create a template container","description":"Creates a new template container","operationId":"c71cc27_post","requestBody":{"description":"Add Template Container Request","content":{"application/json":{"schema":{"required":["name"],"type":"object","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"},"name":{"type":"string"},"state":{"type":"string"},"owner_id":{"type":"string"},"owner_type":{"type":"string"}},"additionalProperties":{"type":"object"}}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TemplateContainerResourceResponse"}}}}}}},"/active-data-manager/templates/containers/{container_id}/allowed_types/{content_type}":{"get":{"tags":["templates"],"summary":"Get template container allowed content-type","description":"Retrieves a specific template container allowed type","operationId":"c71cc27_get_16","parameters":[{"name":"If-None-Match","in":"header","description":"If-None-Match conditional header (ETag)","required":false,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"container_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}},{"name":"content_type","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AllowedTypeResourceResponse"}}}}}},"delete":{"tags":["templates"],"summary":"Delete a template container allowed content-type","description":"Deletes a specific template container allowed type","operationId":"c71cc27_delete_1","parameters":[{"name":"If-Match","in":"header","description":"If-Match conditional header (ETag)","required":false,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"container_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}},{"name":"content_type","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"}}}},"/active-data-manager/templates/containers/{container_id}/allowed_types":{"get":{"tags":["templates"],"summary":"Get template container allowed content-types","description":"List template container allowed types","operationId":"c71cc27_get_17","parameters":[{"name":"If-None-Match","in":"header","description":"If-None-Match conditional header (ETag)","required":false,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"container_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AllowedTypeResourceResponse"}}}}}}},"post":{"tags":["templates"],"summary":"Create a template container allowed content-type","description":"Add an allowed content type to a template container","operationId":"c71cc27_post_1","parameters":[{"name":"If-Match","in":"header","description":"If-Match conditional header (ETag)","required":false,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"container_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Add Workspace Container Request","content":{"application/json":{"schema":{"required":["content_type"],"type":"object","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"},"content_type":{"type":"string"}},"additionalProperties":{"type":"object"}}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AllowedTypeResourceResponse"}}}}}},"delete":{"tags":["templates"],"summary":"Delete template container allowed content-types","description":"Clear all allowed types of a template container","operationId":"c71cc27_delete_2","parameters":[{"name":"If-Match","in":"header","description":"If-Match conditional header (ETag)","required":false,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"container_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"No Content"}}}},"/active-data-manager/templates/containers/{container_id}/properties/{property_name}":{"get":{"tags":["templates"],"summary":"Get a template container property","description":"Retrieves a specific template container property","operationId":"c71cc27_get_18","parameters":[{"name":"If-None-Match","in":"header","description":"If-None-Match conditional header (ETag)","required":false,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"container_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}},{"name":"property_name","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PropertyResponse"}}}}}},"put":{"tags":["templates"],"summary":"Update a template container property","description":"Updates specific template container property","operationId":"c71cc27_put","parameters":[{"name":"If-Match","in":"header","description":"If-Match conditional header (ETag)","required":false,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"container_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}},{"name":"property_name","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"description":"Update Property Request","content":{"application/json":{"schema":{"type":"object","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"}},"additionalProperties":{"type":"object"}}}}},"responses":{"204":{"description":"No Content"}}}},"/active-data-manager/templates/workspaces/{workspace_id}":{"get":{"tags":["templates"],"summary":"Get a template workspace","description":"Retrieves a specific template workspace","operationId":"c71cc27_get_19","parameters":[{"name":"If-None-Match","in":"header","description":"If-None-Match conditional header (ETag)","required":false,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"workspace_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TemplateWorkspaceResourceResponse"}}}}}},"delete":{"tags":["templates"],"summary":"Delete a template workspace","description":"Deletes a specific template workspace","operationId":"c71cc27_delete_3","parameters":[{"name":"If-Match","in":"header","description":"If-Match conditional header (ETag)","required":false,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"workspace_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"No Content"}}}},"/active-data-manager/templates/workspaces":{"get":{"tags":["templates"],"summary":"Get template workspaces","description":"List/query template workspaces","operationId":"c71cc27_get_20","parameters":[{"name":"$start","in":"query","description":"Start offset for items to be retrieved (0 - n)","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int64"}},{"name":"$limit","in":"query","description":"Limit of number of items to be retrieved (page size) [default = 100]","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int64"}},{"name":"$page","in":"query","description":"Page number for items to be retrieved (1 - n)","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int64"}},{"name":"Range","in":"header","description":"Range header (use tokens 'start', 'limit' or 'page')","required":false,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"$sort","in":"query","description":"Property, or properties, to sort result by (comma separated)","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"$properties","in":"query","description":"Properties to be returned","required":false,"style":"form","explode":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TemplateWorkspaceResourceResponse"}}}}},"206":{"description":"Partial Content"}}},"post":{"tags":["templates"],"summary":"Create a template workspace","description":"Creates a new template workspace","operationId":"c71cc27_post_2","requestBody":{"description":"Add Template Workspace Request","content":{"application/json":{"schema":{"required":["title","type"],"type":"object","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"},"title":{"type":"string"},"owner_id":{"type":"string"},"owner_type":{"type":"string"},"type":{"type":"string"},"description":{"type":"string"}},"additionalProperties":{"type":"object"}}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TemplateWorkspaceResourceResponse"}}}}}}},"/active-data-manager/templates/workspaces/{workspace_id}/containers/{container_id}":{"get":{"tags":["templates"],"summary":"Get a template workspace container","description":"Retrieves a specific template workspace container link","operationId":"c71cc27_get_21","parameters":[{"name":"If-None-Match","in":"header","description":"If-None-Match conditional header (ETag)","required":false,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"workspace_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}},{"name":"container_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TemplateWorkspaceContainerResourceResponse"}}}}}},"delete":{"tags":["templates"],"summary":"Delete a template workspace container","description":"Deletes a specific template workspace container","operationId":"c71cc27_delete_4","parameters":[{"name":"If-Match","in":"header","description":"If-Match conditional header (ETag)","required":false,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"workspace_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}},{"name":"container_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"No Content"}}}},"/active-data-manager/templates/workspaces/{workspace_id}/containers":{"get":{"tags":["templates"],"summary":"Get template workspace containers","description":"List/query template workspace containers","operationId":"c71cc27_get_22","parameters":[{"name":"$start","in":"query","description":"Start offset for items to be retrieved (0 - n)","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int64"}},{"name":"$limit","in":"query","description":"Limit of number of items to be retrieved (page size) [default = 100]","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int64"}},{"name":"$page","in":"query","description":"Page number for items to be retrieved (1 - n)","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int64"}},{"name":"Range","in":"header","description":"Range header (use tokens 'start', 'limit' or 'page')","required":false,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"If-None-Match","in":"header","description":"If-None-Match conditional header (ETag)","required":false,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"workspace_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}},{"name":"$sort","in":"query","description":"Property, or properties, to sort result by (comma separated)","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"$properties","in":"query","description":"Properties to be returned","required":false,"style":"form","explode":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TemplateWorkspaceContainerResourceResponse"}}}}},"206":{"description":"Partial Content"}}},"post":{"tags":["templates"],"summary":"Create a template workspace container","description":"Adds a container to template workspace","operationId":"c71cc27_post_3","parameters":[{"name":"If-Match","in":"header","description":"If-Match conditional header (ETag)","required":false,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"workspace_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Add template workspace container request","content":{"application/json":{"schema":{"required":["$link"],"type":"object","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"},"$link":{"type":"string"},"link_order":{"type":"integer","format":"int64"}},"additionalProperties":{"type":"object"}}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TemplateWorkspaceContainerResourceResponse"}}}}}}},"/active-data-manager/templates/workspaces/{workspace_id}/metadatas/{template_id}":{"get":{"tags":["templates"],"summary":"Get a template workspace metadata","description":"Retrieve a specific custom metadata template of a template workspace","operationId":"c71cc27_get_23","parameters":[{"name":"workspace_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}},{"name":"template_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceMetadatasTemplatesResourceResponse"}}}}}},"delete":{"tags":["templates"],"summary":"Delete a template workspace metadata","description":"Remove a specific custom metadata template from a template workspace","operationId":"c71cc27_delete_5","parameters":[{"name":"workspace_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}},{"name":"template_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"No Content"}}}},"/active-data-manager/templates/workspaces/{workspace_id}/metadatas":{"get":{"tags":["templates"],"summary":"Get template workspace metadata","description":"List/query template workspace metadata","operationId":"c71cc27_get_24","parameters":[{"name":"$start","in":"query","description":"Start offset for items to be retrieved (0 - n)","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int64"}},{"name":"$limit","in":"query","description":"Limit of number of items to be retrieved (page size) [default = 100]","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int64"}},{"name":"$page","in":"query","description":"Page number for items to be retrieved (1 - n)","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int64"}},{"name":"Range","in":"header","description":"Range header (use tokens 'start', 'limit' or 'page')","required":false,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"workspace_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}},{"name":"$sort","in":"query","description":"Property, or properties, to sort result by (comma separated)","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"$properties","in":"query","description":"Properties to be returned","required":false,"style":"form","explode":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/WorkspaceMetadatasTemplatesResourceResponse"}}}}},"206":{"description":"Partial Content"}}},"post":{"tags":["templates"],"summary":"Create a template workspace metadata","description":"Adds custom metadata to a template workspace","operationId":"c71cc27_post_4","parameters":[{"name":"If-Match","in":"header","description":"If-Match conditional header (ETag)","required":false,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"workspace_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Add template workspace container request","content":{"application/json":{"schema":{"required":["$link","content_type","media_sub_type","media_top_level_type"],"type":"object","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"},"$link":{"type":"string"},"content_type":{"type":"string"},"media_top_level_type":{"type":"string"},"media_sub_type":{"type":"string"}},"additionalProperties":{"type":"object"}}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceMetadatasTemplatesResourceResponse"}}}}}}},"/active-data-manager/templates/workspaces/{workspace_id}/properties/{property_name}":{"get":{"tags":["templates"],"summary":"Get a template workspace property","description":"Retrieves specific template workspace property","operationId":"c71cc27_get_25","parameters":[{"name":"If-None-Match","in":"header","description":"If-None-Match conditional header (ETag)","required":false,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"workspace_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}},{"name":"property_name","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PropertyResponse"}}}}}},"put":{"tags":["templates"],"summary":"Update a template workspace property","description":"Updates specific template workspace property","operationId":"c71cc27_put_1","parameters":[{"name":"If-Match","in":"header","description":"If-Match conditional header (ETag)","required":false,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"workspace_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}},{"name":"property_name","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"description":"Update Property Request","content":{"application/json":{"schema":{"type":"object","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"}},"additionalProperties":{"type":"object"}}}}},"responses":{"204":{"description":"No Content"}}}},"/active-data-manager/templates/workspaces/{workspace_id}/roles/{role_id}":{"get":{"tags":["templates"],"summary":"Get a template workspace role","description":"Retrieves specific template workspace role","operationId":"c71cc27_get_26","parameters":[{"name":"If-None-Match","in":"header","description":"If-None-Match conditional header (ETag)","required":false,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"workspace_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}},{"name":"role_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceRoleResourceResponse"}}}}}},"delete":{"tags":["templates"],"summary":"Delete a template workspace role","description":"Deletes specific template workspace role","operationId":"c71cc27_delete_6","parameters":[{"name":"If-Match","in":"header","description":"If-Match conditional header (ETag)","required":false,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"workspace_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}},{"name":"role_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"No Content"}}}},"/active-data-manager/templates/workspaces/{workspace_id}/roles":{"get":{"tags":["templates"],"summary":"Get template workspace roles","description":"List/query template workspace roles","operationId":"c71cc27_get_27","parameters":[{"name":"$start","in":"query","description":"Start offset for items to be retrieved (0 - n)","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int64"}},{"name":"$limit","in":"query","description":"Limit of number of items to be retrieved (page size) [default = 100]","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int64"}},{"name":"$page","in":"query","description":"Page number for items to be retrieved (1 - n)","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int64"}},{"name":"Range","in":"header","description":"Range header (use tokens 'start', 'limit' or 'page')","required":false,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"If-None-Match","in":"header","description":"If-None-Match conditional header (ETag)","required":false,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"workspace_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}},{"name":"$sort","in":"query","description":"Property, or properties, to sort result by (comma separated)","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"$properties","in":"query","description":"Properties to be returned","required":false,"style":"form","explode":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceRoleResourceResponse"}}}},"206":{"description":"Partial Content"}}},"post":{"tags":["templates"],"summary":"Create a template workspace role","description":"Adds a template role to a template workspace","operationId":"c71cc27_post_5","parameters":[{"name":"If-Match","in":"header","description":"If-Match conditional header (ETag)","required":false,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"workspace_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Add template workspace container request","content":{"application/json":{"schema":{"required":["title"],"type":"object","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"},"title":{"type":"string"}},"additionalProperties":{"type":"object"}}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceRoleResourceResponse"}}}}}}},"/active-data-manager/templates/workspaces/{workspace_id}/roles/{role_id}/permissions/{permission_id}":{"get":{"tags":["templates"],"summary":"Get template workspace role permission","description":"Retrieves specific template workspace role","operationId":"c71cc27_get_28","parameters":[{"name":"If-None-Match","in":"header","description":"If-None-Match conditional header (ETag)","required":false,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"workspace_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}},{"name":"role_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}},{"name":"permission_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TemplateWorkspaceRolePermissionResourceResponse"}}}}}},"delete":{"tags":["templates"],"summary":"Delete a template workspace role permission","description":"Deletes specific template workspace role permission","operationId":"c71cc27_delete_7","parameters":[{"name":"If-Match","in":"header","description":"If-Match conditional header (ETag)","required":false,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"workspace_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}},{"name":"role_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}},{"name":"permission_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"No Content"}}}},"/active-data-manager/templates/workspaces/{workspace_id}/roles/{role_id}/permissions":{"get":{"tags":["templates"],"summary":"Get template workspace role permissions","description":"List/query template workspace role permissions","operationId":"c71cc27_get_29","parameters":[{"name":"$start","in":"query","description":"Start offset for items to be retrieved (0 - n)","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int64"}},{"name":"$limit","in":"query","description":"Limit of number of items to be retrieved (page size) [default = 100]","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int64"}},{"name":"$page","in":"query","description":"Page number for items to be retrieved (1 - n)","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int64"}},{"name":"Range","in":"header","description":"Range header (use tokens 'start', 'limit' or 'page')","required":false,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"If-None-Match","in":"header","description":"If-None-Match conditional header (ETag)","required":false,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"workspace_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}},{"name":"role_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}},{"name":"$sort","in":"query","description":"Property, or properties, to sort result by (comma separated)","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"$properties","in":"query","description":"Properties to be returned","required":false,"style":"form","explode":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TemplateWorkspaceRolePermissionResourceResponse"}}}},"206":{"description":"Partial Content"}}},"post":{"tags":["templates"],"summary":"Create a template workspace role permission","description":"Adds a template role permission to a template workspace","operationId":"c71cc27_post_6","parameters":[{"name":"If-Match","in":"header","description":"If-Match conditional header (ETag)","required":false,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"workspace_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}},{"name":"role_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Add template workspace role permission request","content":{"application/json":{"schema":{"type":"object","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"},"permission":{"type":"string"}},"additionalProperties":{"type":"object"}}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TemplateWorkspaceRolePermissionResourceResponse"}}}}}}},"/active-data-manager/workspaces/{workspace_id}":{"get":{"tags":["workspaces"],"summary":"Get a workspace","description":"Retrieves a specific workspace","operationId":"c71cc27_get_30","parameters":[{"name":"If-None-Match","in":"header","description":"If-None-Match conditional header (ETag)","required":false,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"workspace_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}},{"name":"$properties","in":"query","description":"Properties to be returned","required":false,"style":"form","explode":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceResourceResponse"}}}}}},"delete":{"tags":["workspaces"],"summary":"Delete a workspace","description":"Deletes a workspace and all its components","operationId":"c71cc27_delete_8","parameters":[{"name":"force","in":"query","description":"Force deletion without confirmation","required":false,"style":"form","explode":true,"schema":{"type":"boolean"}},{"name":"workspace_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"No Content"},"304":{"description":"Not Modified (returns requested datetime in X-Time-Delete-Requested header)"}}}},"/active-data-manager/workspaces":{"get":{"tags":["workspaces"],"summary":"Get workspaces","description":"List/query workspaces","operationId":"c71cc27_get_31","parameters":[{"name":"$start","in":"query","description":"Start offset for items to be retrieved (0 - n)","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int64"}},{"name":"$limit","in":"query","description":"Limit of number of items to be retrieved (page size) [default = 100]","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int64"}},{"name":"$page","in":"query","description":"Page number for items to be retrieved (1 - n)","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int64"}},{"name":"Range","in":"header","description":"Range header (use tokens 'start', 'limit' or 'page')","required":false,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"contains","in":"query","description":"Filter workspaces to those that contain the specified content URI","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"member_only","in":"query","description":"Filter workspaces to only those that the current user is a member of","required":false,"style":"form","explode":true,"schema":{"type":"boolean"}},{"name":"$sort","in":"query","description":"Property, or properties, to sort result by (comma separated)","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"$properties","in":"query","description":"Properties to be returned","required":false,"style":"form","explode":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceResourceResponse"}}}},"206":{"description":"Partial Content"}}},"post":{"tags":["workspaces"],"summary":"Create a workspace","description":"Creates a new workspace","operationId":"c71cc27_post_7","requestBody":{"description":"Add Workspace Request","content":{"application/json":{"schema":{"required":["title","type"],"type":"object","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"},"title":{"type":"string"},"description":{"type":"string"},"type":{"type":"string"},"from_template":{"$ref":"#/components/schemas/RequestRefProperty"},"pure_project_id":{"type":"string"},"containers":{"type":"array","items":{"$ref":"#/components/schemas/AddWorkspaceContainerRequest"}},"metadatas":{"type":"array","items":{"$ref":"#/components/schemas/AddWorkspaceMetadataTemplateRequest"}},"roles":{"type":"array","items":{"required":["title"],"type":"array","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"},"title":{"type":"string"},"permissions":{"type":"array","items":{"$ref":"#/components/schemas/AddWorkspaceRolePermissionRequest"}},"members":{"type":"array","items":{"$ref":"#/components/schemas/AddWorkspaceRoleMemberRequest"}}},"items":{"type":"object"}}},"contents":{"type":"array","items":{"$ref":"#/components/schemas/AddContentsRequest"}}},"additionalProperties":{"type":"object"}}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceResourceResponse"}}}}}}},"/active-data-manager/workspaces/{workspace_id}/containers/{container_id}":{"get":{"tags":["workspaces"],"summary":"Get a workspace container","description":"Retrieves a specific workspace container","operationId":"c71cc27_get_32","parameters":[{"name":"If-None-Match","in":"header","description":"If-None-Match conditional header (ETag)","required":false,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"workspace_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}},{"name":"container_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}},{"name":"$properties","in":"query","description":"Properties to be returned","required":false,"style":"form","explode":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceContainerResourceResponse"}}}}}},"delete":{"tags":["workspaces"],"summary":"Delete a workspace container","description":"Deletes a specific container in a workspace","operationId":"c71cc27_delete_9","parameters":[{"name":"If-Match","in":"header","description":"If-Match conditional header (ETag)","required":false,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"workspace_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}},{"name":"container_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"No Content"}}}},"/active-data-manager/workspaces/{workspace_id}/containers":{"get":{"tags":["workspaces"],"summary":"Get workspace containers","description":"List/query containers in a workspace","operationId":"c71cc27_get_33","parameters":[{"name":"$start","in":"query","description":"Start offset for items to be retrieved (0 - n)","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int64"}},{"name":"$limit","in":"query","description":"Limit of number of items to be retrieved (page size) [default = 100]","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int64"}},{"name":"$page","in":"query","description":"Page number for items to be retrieved (1 - n)","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int64"}},{"name":"Range","in":"header","description":"Range header (use tokens 'start', 'limit' or 'page')","required":false,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"$sort","in":"query","description":"Property, or properties, to sort result by (comma separated)","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"$properties","in":"query","description":"Properties to be returned","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"workspace_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/WorkspaceContainerResourceResponse"}}}}},"206":{"description":"Partial Content"}}},"post":{"tags":["workspaces"],"summary":"Create a workspace container","description":"Creates a new workspace container","operationId":"c71cc27_post_8","parameters":[{"name":"If-Match","in":"header","description":"If-Match conditional header (ETag)","required":false,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"workspace_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Add Workspace Container Request","content":{"application/json":{"schema":{"required":["name"],"type":"object","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"},"name":{"type":"string"},"state":{"type":"string"},"order":{"type":"integer","format":"int64"},"from_template":{"$ref":"#/components/schemas/RequestRefProperty"},"contents":{"type":"array","items":{"$ref":"#/components/schemas/AddContentsRequest"}},"allowed_types":{"type":"array","items":{"$ref":"#/components/schemas/AddAllowedTypeRequest"}}},"additionalProperties":{"type":"object"}}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceContainerResourceResponse"}}}}}}},"/active-data-manager/workspaces/{workspace_id}/containers/{container_id}/allowed_types/{content_type}":{"get":{"tags":["workspaces"],"summary":"Get a workspace container allowed content-type","description":"Retrieves a specific workspace container allowed type","operationId":"c71cc27_get_34","parameters":[{"name":"If-None-Match","in":"header","description":"If-None-Match conditional header (ETag)","required":false,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"workspace_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}},{"name":"container_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}},{"name":"content_type","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AllowedTypeResourceResponse"}}}}}},"delete":{"tags":["workspaces"],"summary":"Delete a workspace container allowed content-type","description":"Deletes a specific allowed content type from a workspace container","operationId":"c71cc27_delete_10","parameters":[{"name":"If-Match","in":"header","description":"If-Match conditional header (ETag)","required":false,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"workspace_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}},{"name":"container_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}},{"name":"content_type","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"}}}},"/active-data-manager/workspaces/{workspace_id}/containers/{container_id}/allowed_types":{"get":{"tags":["workspaces"],"summary":"Get workspace container allowed content-types","description":"List workspace container allowed types","operationId":"c71cc27_get_35","parameters":[{"name":"If-None-Match","in":"header","description":"If-None-Match conditional header (ETag)","required":false,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"workspace_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}},{"name":"container_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AllowedTypeResourceResponse"}}}}}}},"post":{"tags":["workspaces"],"summary":"Create a workspace container allowed content-type","description":"Add an allowed type to a workspace container","operationId":"c71cc27_post_9","parameters":[{"name":"If-Match","in":"header","description":"If-Match conditional header (ETag)","required":false,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"workspace_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}},{"name":"container_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Add Workspace Container Request","content":{"application/json":{"schema":{"required":["content_type"],"type":"object","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"},"content_type":{"type":"string"}},"additionalProperties":{"type":"object"}}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AllowedTypeResourceResponse"}}}}}},"delete":{"tags":["workspaces"],"summary":"Delete workspace container allowed content-types","description":"Deletes all workspace container allowed types","operationId":"c71cc27_delete_11","parameters":[{"name":"If-Match","in":"header","description":"If-Match conditional header (ETag)","required":false,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"workspace_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}},{"name":"container_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"No Content"}}}},"/active-data-manager/workspaces/{workspace_id}/containers/{container_id}/contents":{"get":{"tags":["workspaces"],"summary":"Get workspace container contents","description":"List workspace container content","operationId":"c71cc27_get_36","parameters":[{"name":"If-Match","in":"header","description":"If-Match conditional header (ETag)","required":false,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"$start","in":"query","description":"Start offset for items to be retrieved (0 - n)","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int64"}},{"name":"$limit","in":"query","description":"Limit of number of items to be retrieved (page size) [default = 100]","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int64"}},{"name":"$page","in":"query","description":"Page number for items to be retrieved (1 - n)","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int64"}},{"name":"Range","in":"header","description":"Range header (use tokens 'start', 'limit' or 'page')","required":false,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"workspace_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}},{"name":"container_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/WorkspaceContainerContentResourceResponse"}}}}},"206":{"description":"Partial Content"}}},"post":{"tags":["workspaces"],"summary":"Create a workspace container content","description":"Adds content to a workspace container","operationId":"c71cc27_post_10","parameters":[{"name":"workspace_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}},{"name":"container_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Add Workspace Container Request","content":{"application/json":{"schema":{"type":"object","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"},"content":{"$ref":"#/components/schemas/RequestRefProperty"}},"additionalProperties":{"type":"object"}}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceContainerContentResourceResponse"}}}}}}},"/active-data-manager/workspaces/{workspace_id}/containers/{container_id}/properties/{property_name}":{"get":{"tags":["workspaces"],"summary":"Get a workspace container property","description":"Gets a specific property of a workspace container","operationId":"c71cc27_get_37","parameters":[{"name":"workspace_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}},{"name":"container_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}},{"name":"property_name","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PropertyResponse"}}}}}},"put":{"tags":["workspaces"],"summary":"Update a workspace container property","description":"Updates specific workspace container property","operationId":"c71cc27_put_2","parameters":[{"name":"If-Match","in":"header","description":"If-Match conditional header (ETag)","required":false,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"workspace_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}},{"name":"container_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}},{"name":"property_name","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"description":"Update Container Property Request","content":{"application/json":{"schema":{"type":"object","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"}},"additionalProperties":{"type":"object"}}}}},"responses":{"204":{"description":"No Content"}}}},"/active-data-manager/workspaces/{workspace_id}/contents/{content_id}":{"get":{"tags":["workspaces"],"summary":"Get a workspace content","description":"Retrieves specific content from within a workspace","operationId":"c71cc27_get_38","parameters":[{"name":"workspace_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}},{"name":"content_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceContainerContentResourceResponse"}}}}}},"delete":{"tags":["workspaces"],"summary":"Delete a workspace content","description":"Remove a specific content item from a workspace","operationId":"c71cc27_delete_12","parameters":[{"name":"If-Match","in":"header","description":"If-Match conditional header (ETag)","required":false,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"workspace_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}},{"name":"content_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"No Content"}}}},"/active-data-manager/workspaces/{workspace_id}/contents":{"get":{"tags":["workspaces"],"summary":"Get workspace contents","description":"List/query contents of a workspace","operationId":"c71cc27_get_39","parameters":[{"name":"$start","in":"query","description":"Start offset for items to be retrieved (0 - n)","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int64"}},{"name":"$limit","in":"query","description":"Limit of number of items to be retrieved (page size) [default = 100]","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int64"}},{"name":"$page","in":"query","description":"Page number for items to be retrieved (1 - n)","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int64"}},{"name":"Range","in":"header","description":"Range header (use tokens 'start', 'limit' or 'page')","required":false,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"If-None-Match","in":"header","description":"If-None-Match conditional header (ETag)","required":false,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"state","in":"query","description":"Filter workspace contents by state draft or published","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"$sort","in":"query","description":"Property, or properties, to sort result by (comma separated)","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"$properties","in":"query","description":"Properties to be returned","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"workspace_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/WorkspaceContainerContentResourceResponse"}}}}},"206":{"description":"Partial Content"}}},"post":{"tags":["workspaces"],"summary":"Create a workspace content","description":"Add content to workspace (into the first appropriate container)","operationId":"c71cc27_post_11","parameters":[{"name":"workspace_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Add Workspace Container Request","content":{"application/json":{"schema":{"type":"object","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"},"content":{"$ref":"#/components/schemas/RequestRefProperty"}},"additionalProperties":{"type":"object"}}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceContainerContentResourceResponse"}}}}}}},"/active-data-manager/workspaces/{workspace_id}/events":{"get":{"tags":["workspaces"],"summary":"Get workspace events","description":"List/query events on a workspace","operationId":"c71cc27_get_40","parameters":[{"name":"$start","in":"query","description":"Start offset for items to be retrieved (0 - n)","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int64"}},{"name":"$limit","in":"query","description":"Limit of number of items to be retrieved (page size) [default = 100]","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int64"}},{"name":"$page","in":"query","description":"Page number for items to be retrieved (1 - n)","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int64"}},{"name":"Range","in":"header","description":"Range header (use tokens 'start', 'limit' or 'page')","required":false,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"$sort","in":"query","description":"Property, or properties, to sort result by (comma separated)","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"$properties","in":"query","description":"Properties to be returned","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"workspace_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/WorkspaceEventResponse"}}}}},"206":{"description":"Partial Content"}}}},"/active-data-manager/workspaces/{workspace_id}/invitees/{invitee_id}":{"get":{"tags":["workspaces"],"summary":"Get a workspace invitee","description":"Get workspace invitee","operationId":"c71cc27_get_41","parameters":[{"name":"workspace_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}},{"name":"invitee_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceInviteeResponse"}}}}}},"delete":{"tags":["workspaces"],"summary":"Delete a workspace invitee","description":"Removes invitation from workspace for invitee","operationId":"c71cc27_delete_13","parameters":[{"name":"workspace_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}},{"name":"invitee_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"No Content"}}}},"/active-data-manager/workspaces/{workspace_id}/invitees":{"get":{"tags":["workspaces"],"summary":"Get workspace invitees","description":"List/query invitees of the workspace","operationId":"c71cc27_get_42","parameters":[{"name":"$start","in":"query","description":"Start offset for items to be retrieved (0 - n)","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int64"}},{"name":"$limit","in":"query","description":"Limit of number of items to be retrieved (page size) [default = 100]","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int64"}},{"name":"$page","in":"query","description":"Page number for items to be retrieved (1 - n)","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int64"}},{"name":"Range","in":"header","description":"Range header (use tokens 'start', 'limit' or 'page')","required":false,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"$sort","in":"query","description":"Property, or properties, to sort result by (comma separated)","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"$properties","in":"query","description":"Properties to be returned","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"workspace_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/WorkspaceInviteeResponse"}}}}},"206":{"description":"Partial Content"}}},"post":{"tags":["workspaces"],"summary":"Create a workspace invitee","description":"Invites non-registered users to be invited and track their progress","operationId":"c71cc27_post_12","parameters":[{"name":"workspace_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Non-registered user email(s) to be invited","content":{"application/json":{"schema":{"required":["email"],"type":"array","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"},"email":{"type":"string"}},"items":{"type":"object"}}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceInviteeResponse"}}}}}}},"/active-data-manager/workspaces/{workspace_id}/invitees/{invitee_id}/status":{"put":{"tags":["workspaces"],"summary":"Update a workspace invitation status","description":"Updates a workspace invitation status","operationId":"c71cc27_put_3","parameters":[{"name":"If-Match","in":"header","description":"If-Match conditional header (ETag)","required":false,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"workspace_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}},{"name":"invitee_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Update Status Request","content":{"application/json":{"schema":{"type":"object","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"},"status":{"type":"string"}},"additionalProperties":{"type":"object"}}}}},"responses":{"204":{"description":"No Content"}}}},"/active-data-manager/workspaces/{workspace_id}/members/{actor_id}":{"get":{"tags":["workspaces"],"summary":"Get a workspace member","description":"Retrieve a specific workspace member","operationId":"c71cc27_get_43","parameters":[{"name":"workspace_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}},{"name":"actor_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceMemberResponse"}}}}}},"delete":{"tags":["workspaces"],"summary":"Delete a workspace member","description":"Removes a specific member from a workspace","operationId":"c71cc27_delete_14","parameters":[{"name":"workspace_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}},{"name":"actor_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"No Content"}}}},"/active-data-manager/workspaces/{workspace_id}/members":{"get":{"tags":["workspaces"],"summary":"Get workspace members","description":"List/query members of the workspace","operationId":"c71cc27_get_44","parameters":[{"name":"$start","in":"query","description":"Start offset for items to be retrieved (0 - n)","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int64"}},{"name":"$limit","in":"query","description":"Limit of number of items to be retrieved (page size) [default = 100]","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int64"}},{"name":"$page","in":"query","description":"Page number for items to be retrieved (1 - n)","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int64"}},{"name":"Range","in":"header","description":"Range header (use tokens 'start', 'limit' or 'page')","required":false,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"$sort","in":"query","description":"Property, or properties, to sort result by (comma separated)","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"$properties","in":"query","description":"Properties to be returned","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"workspace_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/WorkspaceMemberResponse"}}}}},"206":{"description":"Partial Content"}}},"post":{"tags":["workspaces"],"summary":"Create a workspace member","description":"Adds a workspace member with one or more roles","operationId":"c71cc27_post_13","parameters":[{"name":"workspace_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Adds a member (user/group) to a workspace with one or more roles","content":{"application/json":{"schema":{"type":"object","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"},"actor":{"$ref":"#/components/schemas/RequestRefProperty"},"roles":{"type":"array","items":{"$ref":"#/components/schemas/RequestRefProperty"}}},"additionalProperties":{"type":"object"}}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceMemberRolesResponse"}}}}}}},"/active-data-manager/workspaces/{workspace_id}/members/{actor_id}/permissions":{"get":{"tags":["workspaces"],"summary":"Get workspace member permissions","description":"List/query effective permissions for a workspace member","operationId":"c71cc27_get_45","parameters":[{"name":"$sort","in":"query","description":"Property, or properties, to sort result by (comma separated)","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"$properties","in":"query","description":"Properties to be returned","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"workspace_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}},{"name":"actor_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/WorkspaceMemberResponse"}}}}}}}},"/active-data-manager/workspaces/{workspace_id}/members/{actor_id}/roles":{"get":{"tags":["workspaces"],"summary":"Get workspace member roles","description":"List/query effective roles for a workspace member","operationId":"c71cc27_get_46","parameters":[{"name":"$start","in":"query","description":"Start offset for items to be retrieved (0 - n)","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int64"}},{"name":"$limit","in":"query","description":"Limit of number of items to be retrieved (page size) [default = 100]","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int64"}},{"name":"$page","in":"query","description":"Page number for items to be retrieved (1 - n)","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int64"}},{"name":"Range","in":"header","description":"Range header (use tokens 'start', 'limit' or 'page')","required":false,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"$sort","in":"query","description":"Property, or properties, to sort result by (comma separated)","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"$properties","in":"query","description":"Properties to be returned","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"workspace_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}},{"name":"actor_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/WorkspaceMemberRoleResponse"}}}}},"206":{"description":"Partial Content"}}}},"/active-data-manager/workspaces/{workspace_id}/metadatas/{template_id}":{"get":{"tags":["workspaces"],"summary":"Get a workspace metadata","description":"Retrieves specific workspace metadata template","operationId":"c71cc27_get_47","parameters":[{"name":"workspace_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}},{"name":"template_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceMetadatasTemplatesResourceResponse"}}}}}},"delete":{"tags":["workspaces"],"summary":"Delete a workspace metadata","description":"Deletes a specific metadata template in a workspace","operationId":"c71cc27_delete_15","parameters":[{"name":"If-Match","in":"header","description":"If-Match conditional header (ETag)","required":false,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"workspace_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}},{"name":"template_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"No Content"}}}},"/active-data-manager/workspaces/{workspace_id}/metadatas":{"get":{"tags":["workspaces"],"summary":"Get workspace metadata","description":"List/query workspaces metadata templates","operationId":"c71cc27_get_48","parameters":[{"name":"$start","in":"query","description":"Start offset for items to be retrieved (0 - n)","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int64"}},{"name":"$limit","in":"query","description":"Limit of number of items to be retrieved (page size) [default = 100]","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int64"}},{"name":"$page","in":"query","description":"Page number for items to be retrieved (1 - n)","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int64"}},{"name":"Range","in":"header","description":"Range header (use tokens 'start', 'limit' or 'page')","required":false,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"workspace_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}},{"name":"$sort","in":"query","description":"Property, or properties, to sort result by (comma separated)","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"$properties","in":"query","description":"Properties to be returned","required":false,"style":"form","explode":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/WorkspaceMetadatasTemplatesResourceResponse"}}}}},"206":{"description":"Partial Content"}}},"post":{"tags":["workspaces"],"summary":"Create workspace metadata","description":"Adds metadata templates to a workspace","operationId":"c71cc27_post_14","parameters":[{"name":"If-Match","in":"header","description":"If-Match conditional header (ETag)","required":false,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"workspace_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Add workspace metadata template request","content":{"application/json":{"schema":{"required":["$link","content_type","media_sub_type","media_top_level_type"],"type":"object","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"},"$link":{"type":"string"},"content_type":{"type":"string"},"media_top_level_type":{"type":"string"},"media_sub_type":{"type":"string"}},"additionalProperties":{"type":"object"}}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceMetadatasTemplatesResourceResponse"}}}}}}},"/active-data-manager/workspaces/{workspace_id}/properties/{property_name}":{"get":{"tags":["workspaces"],"summary":"Get a workspace property","description":"Retrieves specific workspace property","operationId":"c71cc27_get_49","parameters":[{"name":"If-None-Match","in":"header","description":"If-None-Match conditional header (ETag)","required":false,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"workspace_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}},{"name":"property_name","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PropertyResponse"}}}}}},"put":{"tags":["workspaces"],"summary":"Update a workspace property","description":"Updates specific workspace property","operationId":"c71cc27_put_4","parameters":[{"name":"If-Match","in":"header","description":"If-Match conditional header (ETag)","required":false,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"workspace_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}},{"name":"property_name","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"description":"Update Property Request","content":{"application/json":{"schema":{"type":"object","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"}},"additionalProperties":{"type":"object"}}}}},"responses":{"204":{"description":"No Content"}}}},"/active-data-manager/workspaces/{workspace_id}/roles/{role_id}":{"get":{"tags":["workspaces"],"summary":"Get a workspace role","description":"Retrieves a specific workspace role","operationId":"c71cc27_get_50","parameters":[{"name":"If-None-Match","in":"header","description":"If-None-Match conditional header (ETag)","required":false,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"workspace_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}},{"name":"role_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceRoleResourceResponse"}}}}}},"delete":{"tags":["workspaces"],"summary":"Delete a workspace role","description":"Deletes a specific role in a workspace","operationId":"c71cc27_delete_16","parameters":[{"name":"If-Match","in":"header","description":"If-Match conditional header (ETag)","required":false,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"workspace_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}},{"name":"role_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"No Content"}}}},"/active-data-manager/workspaces/{workspace_id}/roles":{"get":{"tags":["workspaces"],"summary":"Get workspace roles","description":"List/query workspace roles","operationId":"c71cc27_get_51","parameters":[{"name":"$start","in":"query","description":"Start offset for items to be retrieved (0 - n)","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int64"}},{"name":"$limit","in":"query","description":"Limit of number of items to be retrieved (page size) [default = 100]","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int64"}},{"name":"$page","in":"query","description":"Page number for items to be retrieved (1 - n)","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int64"}},{"name":"Range","in":"header","description":"Range header (use tokens 'start', 'limit' or 'page')","required":false,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"workspace_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}},{"name":"$sort","in":"query","description":"Property, or properties, to sort result by (comma separated)","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"$properties","in":"query","description":"Properties to be returned","required":false,"style":"form","explode":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceRoleResourceResponse"}}}},"206":{"description":"Partial Content"}}},"post":{"tags":["workspaces"],"summary":"Create a workspace role","description":"Creates a new Workspace Role","operationId":"c71cc27_post_15","parameters":[{"name":"If-Match","in":"header","description":"If-Match conditional header (ETag)","required":false,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"workspace_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Add Workspace Role Request","content":{"application/json":{"schema":{"required":["title"],"type":"object","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"},"title":{"type":"string"}},"additionalProperties":{"type":"object"}}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceRoleResourceResponse"}}}}}}},"/active-data-manager/workspaces/{workspace_id}/roles/{role_id}/members/{member_id}":{"get":{"tags":["workspaces"],"summary":"Get a workspace role member","description":"Retrieves a specific member of a workspace role","operationId":"c71cc27_get_52","parameters":[{"name":"If-None-Match","in":"header","description":"If-None-Match conditional header (ETag)","required":false,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"workspace_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}},{"name":"role_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}},{"name":"member_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceRoleMemberResourceResponse"}}}}}},"delete":{"tags":["workspaces"],"summary":"Delete a workspace role member","description":"Removes a specific member from a workspace role","operationId":"c71cc27_delete_17","parameters":[{"name":"workspace_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}},{"name":"role_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}},{"name":"member_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"No Content"}}}},"/active-data-manager/workspaces/{workspace_id}/roles/{role_id}/members":{"get":{"tags":["workspaces"],"summary":"Get workspace role members","description":"List/query members of a workspace role","operationId":"c71cc27_get_53","parameters":[{"name":"$start","in":"query","description":"Start offset for items to be retrieved (0 - n)","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int64"}},{"name":"$limit","in":"query","description":"Limit of number of items to be retrieved (page size) [default = 100]","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int64"}},{"name":"$page","in":"query","description":"Page number for items to be retrieved (1 - n)","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int64"}},{"name":"Range","in":"header","description":"Range header (use tokens 'start', 'limit' or 'page')","required":false,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"workspace_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}},{"name":"role_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}},{"name":"$sort","in":"query","description":"Property, or properties, to sort result by (comma separated)","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"$properties","in":"query","description":"Properties to be returned","required":false,"style":"form","explode":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/WorkspaceRoleMemberResourceResponse"}}}}},"206":{"description":"Partial Content"}}},"post":{"tags":["workspaces"],"summary":"Create a workspace role member","description":"Adds a new member to a workspace role","operationId":"c71cc27_post_16","parameters":[{"name":"workspace_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}},{"name":"role_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Adds a member (user/group) to a workspace role","content":{"application/json":{"schema":{"type":"object","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"},"actor":{"$ref":"#/components/schemas/RequestRefProperty"}},"additionalProperties":{"type":"object"}}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceRoleMemberResourceResponse"}}}}}}},"/active-data-manager/workspaces/{workspace_id}/roles/{role_id}/permissions/{permission_id}":{"get":{"tags":["workspaces"],"summary":"Get a workspace role permission","description":"Retrieves a specific permission of a workspace role","operationId":"c71cc27_get_54","parameters":[{"name":"If-None-Match","in":"header","description":"If-None-Match conditional header (ETag)","required":false,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"workspace_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}},{"name":"role_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}},{"name":"permission_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceRolePermissionResourceResponse"}}}}}},"delete":{"tags":["workspaces"],"summary":"Delete a workspace role permission","description":"Deletes a specific permission from a role","operationId":"c71cc27_delete_18","parameters":[{"name":"If-Match","in":"header","description":"If-Match conditional header (ETag)","required":false,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"workspace_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}},{"name":"role_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}},{"name":"permission_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"No Content"}}}},"/active-data-manager/workspaces/{workspace_id}/roles/{role_id}/permissions":{"get":{"tags":["workspaces"],"summary":"Get workspace role permissions","description":"List/query workspace role permissions","operationId":"c71cc27_get_55","parameters":[{"name":"$start","in":"query","description":"Start offset for items to be retrieved (0 - n)","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int64"}},{"name":"$limit","in":"query","description":"Limit of number of items to be retrieved (page size) [default = 100]","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int64"}},{"name":"$page","in":"query","description":"Page number for items to be retrieved (1 - n)","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int64"}},{"name":"Range","in":"header","description":"Range header (use tokens 'start', 'limit' or 'page')","required":false,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"workspace_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}},{"name":"role_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}},{"name":"$sort","in":"query","description":"Property, or properties, to sort result by (comma separated)","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"$properties","in":"query","description":"Properties to be returned","required":false,"style":"form","explode":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/WorkspaceRolePermissionResourceResponse"}}}}},"206":{"description":"Partial Content"}}},"post":{"tags":["workspaces"],"summary":"Create a workspace role permission","description":"Add a new workspace role permission","operationId":"c71cc27_post_17","parameters":[{"name":"workspace_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}},{"name":"role_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Add a permission to a workspace role","content":{"application/json":{"schema":{"type":"object","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"},"permission":{"type":"string"},"container":{"$ref":"#/components/schemas/RequestRefProperty"},"collection":{"$ref":"#/components/schemas/RequestRefProperty"}},"additionalProperties":{"type":"object"}}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceRolePermissionResourceResponse"}}}}}}},"/active-data-manager/workspaces/{workspace_id}/roles/{role_id}/properties/{property_name}":{"get":{"tags":["workspaces"],"summary":"Get a workspace role property","description":"Retrieves specific workspace role property","operationId":"c71cc27_get_56","parameters":[{"name":"If-None-Match","in":"header","description":"If-None-Match conditional header (ETag)","required":false,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"workspace_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}},{"name":"role_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}},{"name":"property_name","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PropertyResponse"}}}}}},"put":{"tags":["workspaces"],"summary":"Update a workspace role property","description":"Updates specific workspace role property","operationId":"c71cc27_put_5","parameters":[{"name":"If-Match","in":"header","description":"If-Match conditional header (ETag)","required":false,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"workspace_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}},{"name":"role_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}},{"name":"property_name","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"description":"Update Property Request","content":{"application/json":{"schema":{"type":"object","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"}},"additionalProperties":{"type":"object"}}}},"required":true},"responses":{"204":{"description":"No Content"}}}},"/active-data-entities":{"get":{"description":"Root discovery endpoint","operationId":"1cbd515e_get","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/active-data-entities/collections/drafts/{collection_id}":{"get":{"tags":["draft-collections"],"summary":"Get a draft collection","description":"Retrieve a specific draft collection","operationId":"1cbd515e_get_1","parameters":[{"name":"$properties","in":"query","description":"Properties to be expanded","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"collection_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}},"delete":{"tags":["draft-collections"],"summary":"Delete a draft collection","description":"Delete a specific draft collection","operationId":"1cbd515e_delete","parameters":[{"name":"collection_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"No Content"},"404":{"description":"Not Found"}}},"patch":{"tags":["draft-collections"],"summary":"Update a draft collection","description":"Patch a specific collection","operationId":"1cbd515e_patch","parameters":[{"name":"If-Match","in":"header","description":"If-Match conditional header (ETag)","required":false,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"collection_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Details for the patch.","content":{"application/json":{"schema":{"type":"object","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"}},"additionalProperties":{"type":"object"}}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"},"412":{"description":"Precondition Failed"},"422":{"description":"Unprocessable Entity"}}}},"/active-data-entities/collections/drafts":{"get":{"tags":["public-collections"],"summary":"Get draft collections","description":"Retrieves draft collections","operationId":"1cbd515e_get_2","parameters":[{"name":"$start","in":"query","description":"Start offset for items to be retrieved (0 - n)","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int64"}},{"name":"$limit","in":"query","description":"Limit of number of items to be retrieved (page size) [default = 100]","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int64"}},{"name":"$page","in":"query","description":"Page number for items to be retrieved (1 - n)","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int64"}},{"name":"Range","in":"header","description":"Range header (use tokens 'start', 'limit' or 'page')","required":false,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"$properties","in":"query","description":"Properties to be expanded","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"$sort","in":"query","description":"Property, or properties, to sort result by (comma separated). Prefix the property with '-' to sort in descending order","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"content_id","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Model"}}}}},"206":{"description":"Partial Content","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Model"}}}}}}},"post":{"tags":["public-collections"],"summary":"Create a draft collection","description":"Create a new draft collection","operationId":"1cbd515e_post","requestBody":{"description":"Details of the new collection to create.","content":{"application/json":{"schema":{"required":["categories","contributors","id","institutions","name"],"type":"object","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"},"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"categories":{"type":"array","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"}},"items":{"type":"object"}},"contributors":{"type":"array","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"}},"items":{"type":"object"}},"institutions":{"type":"array","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"}},"items":{"type":"object"}}},"additionalProperties":{"type":"object"}}}},"required":true},"responses":{"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"422":{"description":"Unprocessable Entity"}}}},"/active-data-entities/collections/drafts/{collection_id}/categories":{"get":{"tags":["draft-collections"],"summary":"Get the categories for a draft collection ","description":"Retrieve categories for a specific draft collection","operationId":"1cbd515e_get_3","parameters":[{"name":"collection_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK"}}}},"/active-data-entities/collections/drafts/{collection_id}/contents/{content_id}":{"get":{"tags":["draft-collections"],"summary":"Get specific content of a draft collection","description":"Retrieve a specific draft collection content","operationId":"1cbd515e_get_4","parameters":[{"name":"collection_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}},{"name":"content_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"}}},"delete":{"tags":["draft-collections"],"summary":"Delete content from a draft collection","description":"Delete a specific draft collection content","operationId":"1cbd515e_delete_1","parameters":[{"name":"collection_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}},{"name":"content_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"404":{"description":"Not Found"}}}},"/active-data-entities/collections/drafts/{collection_id}/contents":{"get":{"tags":["draft-collections"],"summary":"Get contents of a draft collection","description":"Retrieves contents of the specified collection","operationId":"1cbd515e_get_5","parameters":[{"name":"$start","in":"query","description":"Start offset for items to be retrieved (0 - n)","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int64"}},{"name":"$limit","in":"query","description":"Limit of number of items to be retrieved (page size) [default = 100]","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int64"}},{"name":"$page","in":"query","description":"Page number for items to be retrieved (1 - n)","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int64"}},{"name":"Range","in":"header","description":"Range header (use tokens 'start', 'limit' or 'page')","required":false,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"$properties","in":"query","description":"Properties to be expanded","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"$sort","in":"query","description":"Property, or properties, to sort result by (comma separated). Prefix the property with '-' to sort in descending order","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"collection_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Model"}}}}},"206":{"description":"Partial Content","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Model"}}}}},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"}}},"post":{"tags":["draft-collections"],"summary":"Add content to a draft collection","description":"Add a content to a specific draft collection","operationId":"1cbd515e_post_1","parameters":[{"name":"collection_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Details of the content to add.","content":{"application/json":{"schema":{"required":["id"],"type":"object","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"},"id":{"type":"string"}},"additionalProperties":{"type":"object"}}}},"required":true},"responses":{"201":{"description":"Created"},"204":{"description":"No Content"},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"}}}},"/active-data-entities/collections/drafts/{collection_id}/contents/{content_id}/source":{"get":{"tags":["draft-collections"],"summary":"Get the source content of a draft collection","description":"Redirect to the source url of the specific content of a specific draft collection","operationId":"1cbd515e_redirect","parameters":[{"name":"collection_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}},{"name":"content_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"303":{"description":"See Other"},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"}}}},"/active-data-entities/collections/drafts/{collection_id}/contributors":{"get":{"tags":["draft-collections"],"summary":"Get contributors for a draft collection","description":"Retrieve contributors for a specific draft collection","operationId":"1cbd515e_get_6","parameters":[{"name":"collection_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK"}}}},"/active-data-entities/collections/drafts/{collection_id}/institutions":{"get":{"tags":["draft-collections"],"summary":"Get institutions for a draft collection","description":"Retrieve institutions for a specific draft collection","operationId":"1cbd515e_get_7","parameters":[{"name":"collection_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK"}}}},"/active-data-entities/collections/publics/{collection_id}":{"get":{"tags":["public-collections"],"summary":"Get a public collection","description":"Retrieve a specific public collection","operationId":"1cbd515e_get_8","parameters":[{"name":"$properties","in":"query","description":"Properties to be expanded","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"collection_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"}}},"delete":{"tags":["public-collections"],"summary":"Delete a public collection","description":"Delete a specific published collection","operationId":"1cbd515e_delete_2","parameters":[{"name":"collection_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"No Content"},"404":{"description":"Not Found"}}}},"/active-data-entities/collections/publics":{"post":{"tags":["public-collections"],"summary":"Publish a draft collection","description":"Publish a draft collection","operationId":"1cbd515e_post_2","requestBody":{"description":"Id of the draft collection to publish.","content":{"application/json":{"schema":{"required":["id"],"type":"object","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"},"id":{"type":"string"}},"additionalProperties":{"type":"object"}}}},"required":true},"responses":{"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"422":{"description":"Unprocessable Entity"}}}},"/active-data-entities/datasets/confidentials/{dataset_id}/{version}/files/{file_id}/contents":{"get":{"tags":["draft-datasets"],"summary":"Get draft file contents of a confidential dataset","description":"Retrieve draft file contents for a specific confidential dataset file","operationId":"1cbd515e_get_9","parameters":[{"name":"dataset_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"version","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"integer","format":"int64"}},{"name":"file_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}},{"name":"$context","in":"query","description":"The URI of the request context (e.g. the URI of a workspace)","required":false,"style":"form","explode":true,"schema":{"type":"string"}}],"responses":{"302":{"description":"Found"},"404":{"description":"File not found"}}}},"/active-data-entities/datasets/drafts/{dataset_id}":{"get":{"tags":["draft-datasets"],"summary":"Get draft dataset","description":"Retrieve a specific draft dataset","operationId":"1cbd515e_get_10","parameters":[{"name":"$properties","in":"query","description":"Properties to be expanded","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"dataset_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"$context","in":"query","description":"The URI of the request context (e.g. the URI of a workspace)","required":false,"style":"form","explode":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model"}}}}}},"delete":{"tags":["draft-datasets"],"summary":"Delete/Revert a draft dataset","description":"Deletes a draft dataset, or reverts latest changes to most recent public version","operationId":"1cbd515e_delete_3","parameters":[{"name":"dataset_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"$context","in":"query","description":"The URI of the request context (e.g. the URI of a workspace)","required":false,"style":"form","explode":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"}}},"patch":{"tags":["draft-datasets"],"summary":"Update properties of a draft dataset","description":"Patches a draft dataset with updated properties","operationId":"1cbd515e_patch_1","parameters":[{"name":"dataset_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"$context","in":"query","description":"The URI of the request context (e.g. the URI of a workspace)","required":false,"style":"form","explode":true,"schema":{"type":"string"}}],"requestBody":{"description":"Details for the patch.","content":{"application/json":{"schema":{"type":"object","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"}},"additionalProperties":{"type":"object"}}}},"required":true},"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/active-data-entities/datasets/drafts":{"get":{"tags":["draft-datasets"],"summary":"Get draft datasets for current user","description":"Retrieves current users datasets","operationId":"1cbd515e_get_11","parameters":[{"name":"$start","in":"query","description":"Start offset for items to be retrieved (0 - n)","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int64"}},{"name":"$limit","in":"query","description":"Limit of number of items to be retrieved (page size) [default = 100]","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int64"}},{"name":"$page","in":"query","description":"Page number for items to be retrieved (1 - n)","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int64"}},{"name":"Range","in":"header","description":"Range header (use tokens 'start', 'limit' or 'page')","required":false,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"$properties","in":"query","description":"Properties to be expanded","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"$sort","in":"query","description":"Property, or properties, to sort result by (comma separated). Prefix the property with '-' to sort in descending order","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"categories","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Model"}}}}},"206":{"description":"Partial Content","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Model"}}}}}}},"post":{"tags":["draft-datasets"],"summary":"Create draft dataset","description":"Creates a new draft dataset","operationId":"1cbd515e_post_3","requestBody":{"description":"Creates a new dataset","content":{"application/json":{"schema":{"required":["name"],"type":"object","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"},"name":{"type":"string"},"description":{"type":"string"},"method":{"type":"string"},"is_confidential":{"type":"boolean"}},"additionalProperties":{"type":"object"}}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model"}}}}}}},"/active-data-entities/datasets/drafts/{dataset_id}/articles/{doi}":{"get":{"tags":["draft-datasets"],"summary":"Get article for a draft dataset","description":"Retrieve specific article for a specific draft dataset","operationId":"1cbd515e_get_12","parameters":[{"name":"dataset_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"doi","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"$context","in":"query","description":"The URI of the request context (e.g. the URI of a workspace)","required":false,"style":"form","explode":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model"}}}}}},"delete":{"tags":["draft-datasets"],"summary":"Delete article from a draft dataset","description":"Delete an article for a specific draft dataset","operationId":"1cbd515e_delete_4","parameters":[{"name":"dataset_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"doi","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"$context","in":"query","description":"The URI of the request context (e.g. the URI of a workspace)","required":false,"style":"form","explode":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"}}}},"/active-data-entities/datasets/drafts/{dataset_id}/articles":{"get":{"tags":["draft-datasets"],"summary":"Get articles for a draft dataset","description":"Retrieve articles for a specific draft dataset","operationId":"1cbd515e_get_13","parameters":[{"name":"$properties","in":"query","description":"Properties to be expanded","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"dataset_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"$context","in":"query","description":"The URI of the request context (e.g. the URI of a workspace)","required":false,"style":"form","explode":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Model"}}}}},"206":{"description":"Partial Content"}}},"post":{"tags":["draft-datasets"],"summary":"Add article for a draft dataset","description":"Add article for a specific draft dataset","operationId":"1cbd515e_post_4","parameters":[{"name":"dataset_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"$context","in":"query","description":"The URI of the request context (e.g. the URI of a workspace)","required":false,"style":"form","explode":true,"schema":{"type":"string"}}],"requestBody":{"description":"Add draft dataset article request","content":{"application/json":{"schema":{"required":["doi","title"],"type":"object","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"},"doi":{"type":"string"},"title":{"type":"string"},"pii":{"type":"string"},"journal":{"required":["issn","name"],"type":"object","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"},"issn":{"type":"string"},"name":{"type":"string"}},"additionalProperties":{"type":"object"}}},"additionalProperties":{"type":"object"}}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model"}}}}}}},"/active-data-entities/datasets/drafts/{dataset_id}/categories":{"get":{"tags":["draft-datasets"],"summary":"Get categories for a draft dataset","description":"Retrieve categories for a specific draft dataset","operationId":"1cbd515e_get_14","parameters":[{"name":"dataset_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"$context","in":"query","description":"The URI of the request context (e.g. the URI of a workspace)","required":false,"style":"form","explode":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Model"}}}}}}},"post":{"tags":["draft-datasets"],"summary":"Add category for a draft dataset","description":"Add a category to a specific draft dataset","operationId":"1cbd515e_post_5","parameters":[{"name":"dataset_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"$context","in":"query","description":"The URI of the request context (e.g. the URI of a workspace)","required":false,"style":"form","explode":true,"schema":{"type":"string"}}],"requestBody":{"description":"Add draft dataset category request","content":{"application/json":{"schema":{"required":["id","label"],"type":"object","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"},"id":{"type":"string"},"label":{"type":"string"}},"additionalProperties":{"type":"object"}}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model"}}}}}}},"/active-data-entities/datasets/drafts/{dataset_id}/categories/{category_uri}":{"get":{"tags":["draft-datasets"],"summary":"Get category for a draft dataset","description":"Retrieve a category for a specific draft dataset","operationId":"1cbd515e_get_15","parameters":[{"name":"dataset_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"category_uri","in":"path","required":true,"style":"simple","explode":false,"schema":{"pattern":".*","type":"string"}},{"name":"$context","in":"query","description":"The URI of the request context (e.g. the URI of a workspace)","required":false,"style":"form","explode":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model"}}}}}},"delete":{"tags":["draft-datasets"],"summary":"Delete category for a draft dataset","description":"Delete a category for a specific draft dataset","operationId":"1cbd515e_delete_5","parameters":[{"name":"dataset_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"category_uri","in":"path","required":true,"style":"simple","explode":false,"schema":{"pattern":".*","type":"string"}},{"name":"$context","in":"query","description":"The URI of the request context (e.g. the URI of a workspace)","required":false,"style":"form","explode":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"}}}},"/active-data-entities/datasets/drafts/{dataset_id}/contributors/{contributor_id}":{"get":{"tags":["draft-datasets"],"summary":"Get contributor for a draft dataset","description":"Retrieve a contributor for a specific draft dataset","operationId":"1cbd515e_get_16","parameters":[{"name":"dataset_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"contributor_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"integer","format":"int64"}},{"name":"$context","in":"query","description":"The URI of the request context (e.g. the URI of a workspace)","required":false,"style":"form","explode":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model"}}}}}},"delete":{"tags":["draft-datasets"],"summary":"Delete contributor for a draft dataset","description":"Delete a contributor for a specific draft dataset","operationId":"1cbd515e_delete_6","parameters":[{"name":"dataset_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"contributor_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"integer","format":"int64"}},{"name":"$context","in":"query","description":"The URI of the request context (e.g. the URI of a workspace)","required":false,"style":"form","explode":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"}}},"patch":{"tags":["draft-datasets"],"summary":"Update contributor for a draft dataset","description":"Update contributor for a specific draft dataset","operationId":"1cbd515e_patch_2","parameters":[{"name":"dataset_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"contributor_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"integer","format":"int64"}},{"name":"$context","in":"query","description":"The URI of the request context (e.g. the URI of a workspace)","required":false,"style":"form","explode":true,"schema":{"type":"string"}}],"requestBody":{"description":"Add draft dataset contributor request","content":{"application/json":{"schema":{"type":"object","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"}},"additionalProperties":{"type":"object"}}}},"required":true},"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/active-data-entities/datasets/drafts/{dataset_id}/contributors":{"get":{"tags":["draft-datasets"],"summary":"Get contributors for a draft dataset","description":"Retrieve contributors for a specific draft dataset","operationId":"1cbd515e_get_17","parameters":[{"name":"dataset_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"$context","in":"query","description":"The URI of the request context (e.g. the URI of a workspace)","required":false,"style":"form","explode":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Model"}}}}}}},"post":{"tags":["draft-datasets"],"summary":"Add contributors to a draft dataset","description":"Add a contributor to a specific draft dataset","operationId":"1cbd515e_post_6","parameters":[{"name":"dataset_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"$context","in":"query","description":"The URI of the request context (e.g. the URI of a workspace)","required":false,"style":"form","explode":true,"schema":{"type":"string"}}],"requestBody":{"description":"Add draft dataset contributor request","content":{"application/json":{"schema":{"required":["contribution","first_name","institution","last_name","orcid_id","permission"],"type":"object","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"},"first_name":{"type":"string"},"last_name":{"type":"string"},"email":{"type":"string"},"contribution":{"type":"string"},"institution":{"type":"string"},"institution_id":{"type":"string"},"permission":{"type":"string"},"order":{"type":"integer","format":"int64"},"orcid_id":{"type":"string"},"profile":{"required":["$ref"],"type":"object","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"},"$ref":{"type":"string"}},"additionalProperties":{"type":"object"}}},"additionalProperties":{"type":"object"}}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model"}}}}}}},"/active-data-entities/datasets/drafts/{dataset_id}/contributors/{contributor_id}/properties/{property_name}":{"put":{"tags":["draft-datasets"],"summary":"Update property for a draft dataset contributor","description":"Updates a specific property for a specific draft dataset contributor","operationId":"1cbd515e_put","parameters":[{"name":"dataset_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"contributor_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"integer","format":"int64"}},{"name":"property_name","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"$context","in":"query","description":"The URI of the request context (e.g. the URI of a workspace)","required":false,"style":"form","explode":true,"schema":{"type":"string"}}],"requestBody":{"description":"Update draft dataset contributor property request","content":{"application/json":{"schema":{"type":"object","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"}},"additionalProperties":{"type":"object"}}}},"required":true},"responses":{"204":{"description":"No Content"}}}},"/active-data-entities/datasets/drafts/{dataset_id}/events":{"get":{"tags":["draft-datasets"],"summary":"Get events for a draft dataset","description":"Retrieve events for a specific draft dataset","operationId":"1cbd515e_get_18","parameters":[{"name":"$start","in":"query","description":"Start offset for items to be retrieved (0 - n)","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int64"}},{"name":"$limit","in":"query","description":"Limit of number of items to be retrieved (page size) [default = 100]","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int64"}},{"name":"$page","in":"query","description":"Page number for items to be retrieved (1 - n)","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int64"}},{"name":"Range","in":"header","description":"Range header (use tokens 'start', 'limit' or 'page')","required":false,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"$properties","in":"query","description":"Properties to be expanded","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"$sort","in":"query","description":"Property, or properties, to sort result by (comma separated). Prefix the property with '-' to sort in descending order","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"dataset_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"$context","in":"query","description":"The URI of the request context (e.g. the URI of a workspace)","required":false,"style":"form","explode":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DraftDatasetEventsResource"}}}}},"206":{"description":"Partial Content"}}}},"/active-data-entities/datasets/drafts/{dataset_id}/files/{file_id}":{"get":{"tags":["draft-datasets"],"summary":"Get file for a draft dataset","description":"Retrieve a specific file for a draft dataset","operationId":"1cbd515e_get_19","parameters":[{"name":"dataset_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"file_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}},{"name":"$context","in":"query","description":"The URI of the request context (e.g. the URI of a workspace)","required":false,"style":"form","explode":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model"}}}}}},"delete":{"tags":["draft-datasets"],"summary":"Delete file for a draft dataset","description":"Delete a specific file for a draft dataset","operationId":"1cbd515e_delete_7","parameters":[{"name":"dataset_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"file_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}},{"name":"$context","in":"query","description":"The URI of the request context (e.g. the URI of a workspace)","required":false,"style":"form","explode":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"}}}},"/active-data-entities/datasets/drafts/{dataset_id}/files":{"get":{"tags":["draft-datasets"],"summary":"Get files for a draft dataset","description":"Retrieve files for a specific draft dataset","operationId":"1cbd515e_get_20","parameters":[{"name":"$start","in":"query","description":"Start offset for items to be retrieved (0 - n)","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int64"}},{"name":"$limit","in":"query","description":"Limit of number of items to be retrieved (page size) [default = 100]","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int64"}},{"name":"$page","in":"query","description":"Page number for items to be retrieved (1 - n)","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int64"}},{"name":"Range","in":"header","description":"Range header (use tokens 'start', 'limit' or 'page')","required":false,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"$properties","in":"query","description":"Properties to be expanded","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"$sort","in":"query","description":"Property, or properties, to sort result by (comma separated). Prefix the property with '-' to sort in descending order","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"dataset_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"$context","in":"query","description":"The URI of the request context (e.g. the URI of a workspace)","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"$parent","in":"query","description":"List/query files that are child of this folder or specify 'root' (If omitted, all files are listed)","required":false,"style":"form","explode":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Model"}}}}},"206":{"description":"Partial Content","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Model"}}}}}}},"post":{"tags":["draft-datasets"],"summary":"Add file to a draft dataset","description":"Add a file to a specific draft dataset","operationId":"1cbd515e_post_7","parameters":[{"name":"dataset_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"$context","in":"query","description":"The URI of the request context (e.g. the URI of a workspace)","required":false,"style":"form","explode":true,"schema":{"type":"string"}}],"requestBody":{"description":"Add draft dataset file request","content":{"application/json":{"schema":{"required":["description","filename","media_type","ticket_id"],"type":"object","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"},"size":{"type":"integer","format":"int64"},"ticket_id":{"type":"string"},"filename":{"type":"string"},"description":{"type":"string"},"parent_folder":{"$ref":"#/components/schemas/RefRequest"},"media_type":{"type":"string"}},"additionalProperties":{"type":"object"}}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model"}}}}}}},"/active-data-entities/datasets/drafts/{dataset_id}/files/{file_id}/contents":{"get":{"tags":["draft-datasets"],"summary":"Get file contents for a draft dataset file","description":"Retrieve file contents for a specific draft dataset file","operationId":"1cbd515e_get_21","parameters":[{"name":"dataset_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"file_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}},{"name":"$context","in":"query","description":"The URI of the request context (e.g. the URI of a workspace)","required":false,"style":"form","explode":true,"schema":{"type":"string"}}],"responses":{"302":{"description":"Found"},"404":{"description":"Not Found"}}}},"/active-data-entities/datasets/drafts/{dataset_id}/files/{file_id}/properties/{property_name}":{"get":{"tags":["draft-datasets"],"summary":"Get specific property for a draft dataset file","description":"Retrieves a specific property of a specific draft dataset file","operationId":"1cbd515e_get_22","parameters":[{"name":"dataset_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"file_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}},{"name":"property_name","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"$context","in":"query","description":"The URI of the request context (e.g. the URI of a workspace)","required":false,"style":"form","explode":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DraftDatasetPropertyResourceResponse"}}}}}},"put":{"tags":["draft-datasets"],"summary":"Update specific property for a draft dataset file","description":"Updates a specific property of a specific draft dataset file","operationId":"1cbd515e_put_1","parameters":[{"name":"dataset_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"file_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}},{"name":"property_name","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"$context","in":"query","description":"The URI of the request context (e.g. the URI of a workspace)","required":false,"style":"form","explode":true,"schema":{"type":"string"}}],"requestBody":{"description":"Update draft dataset property request","content":{"application/json":{"schema":{"required":["description","filename"],"type":"object","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"},"filename":{"type":"string"},"description":{"type":"string"},"parent_folder":{"$ref":"#/components/schemas/RefRequest"}},"additionalProperties":{"type":"object"}}}},"required":true},"responses":{"204":{"description":"No Content"}}}},"/active-data-entities/datasets/drafts/{dataset_id}/folders/{folder_id}":{"get":{"tags":["draft-datasets"],"summary":"Get folder for a draft dataset","description":"Retrieve specific folder of a draft dataset","operationId":"1cbd515e_get_23","parameters":[{"name":"dataset_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"folder_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}},{"name":"$context","in":"query","description":"The URI of the request context (e.g. the URI of a workspace)","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"breadcrumbs","in":"query","description":"Includes breadcrumbs of parent folders to root for current folder","required":false,"style":"form","explode":true,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model"}}}}}},"delete":{"tags":["draft-datasets"],"summary":"Delete folder and children for a draft dataset","description":"Delete a folder and its children in a specific draft dataset","operationId":"1cbd515e_delete_8","parameters":[{"name":"dataset_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"folder_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}},{"name":"$context","in":"query","description":"The URI of the request context (e.g. the URI of a workspace)","required":false,"style":"form","explode":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"}}}},"/active-data-entities/datasets/drafts/{dataset_id}/folders":{"get":{"tags":["draft-datasets"],"summary":"Get folders for a draft dataset","description":"Retrieve folders for a specific draft dataset","operationId":"1cbd515e_get_24","parameters":[{"name":"$start","in":"query","description":"Start offset for items to be retrieved (0 - n)","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int64"}},{"name":"$limit","in":"query","description":"Limit of number of items to be retrieved (page size) [default = 100]","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int64"}},{"name":"$page","in":"query","description":"Page number for items to be retrieved (1 - n)","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int64"}},{"name":"Range","in":"header","description":"Range header (use tokens 'start', 'limit' or 'page')","required":false,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"$properties","in":"query","description":"Properties to be expanded","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"$sort","in":"query","description":"Property, or properties, to sort result by (comma separated). Prefix the property with '-' to sort in descending order","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"dataset_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"$context","in":"query","description":"The URI of the request context (e.g. the URI of a workspace)","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"$parent","in":"query","description":"List/query folders that are child of this folder","required":false,"style":"form","explode":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Model"}}}}},"206":{"description":"Partial Content","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Model"}}}}}}},"post":{"tags":["draft-datasets"],"summary":"Add folder to a draft dataset","description":"Add a folder to a specific draft dataset","operationId":"1cbd515e_post_8","parameters":[{"name":"dataset_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"$context","in":"query","description":"The URI of the request context (e.g. the URI of a workspace)","required":false,"style":"form","explode":true,"schema":{"type":"string"}}],"requestBody":{"description":"Add draft dataset folder request","content":{"application/json":{"schema":{"required":["name"],"type":"object","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"},"name":{"type":"string"},"parent_folder":{"$ref":"#/components/schemas/RefRequest"}},"additionalProperties":{"type":"object"}}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model"}}}}}}},"/active-data-entities/datasets/drafts/{dataset_id}/folders/{folder_id}/properties/{property_name}":{"get":{"tags":["draft-datasets"],"summary":"Get property for a draft dataset","description":"Retrieves a specific property for a specific draft dataset folder","operationId":"1cbd515e_get_25","parameters":[{"name":"dataset_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"folder_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}},{"name":"property_name","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"$context","in":"query","description":"The URI of the request context (e.g. the URI of a workspace)","required":false,"style":"form","explode":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DraftDatasetPropertyResourceResponse"}}}}}},"put":{"tags":["draft-datasets"],"summary":"Updates property for a draft dataset folder","description":"Updates a specific property of a specific draft dataset folder","operationId":"1cbd515e_put_2","parameters":[{"name":"dataset_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"folder_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}},{"name":"property_name","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"$context","in":"query","description":"The URI of the request context (e.g. the URI of a workspace)","required":false,"style":"form","explode":true,"schema":{"type":"string"}}],"requestBody":{"description":"Update draft dataset folder property request","content":{"application/json":{"schema":{"type":"object","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"}},"additionalProperties":{"type":"object"}}}},"required":true},"responses":{"204":{"description":"No Content"}}}},"/active-data-entities/datasets/drafts/{dataset_id}/folders/{folder_id}/tree":{"post":{"tags":["draft-datasets"],"summary":"Add folder tree to a draft dataset","description":"Add a folder tree to a specific draft dataset","operationId":"1cbd515e_post_9","parameters":[{"name":"dataset_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"folder_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"$context","in":"query","description":"The URI of the request context (e.g. the URI of a workspace)","required":false,"style":"form","explode":true,"schema":{"type":"string"}}],"requestBody":{"description":"Add draft dataset folder request","content":{"application/json":{"schema":{"required":["tree"],"type":"object","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"},"tree":{"type":"array","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"}},"items":{"type":"object"}}},"additionalProperties":{"type":"object"}}}},"required":true},"responses":{"201":{"description":"Created"}}}},"/active-data-entities/datasets/drafts/{dataset_id}/funders/{funder_id}":{"get":{"tags":["draft-datasets"],"summary":"Retrieves specific funder of a draft dataset","description":"Retrieves specific funder of a draft dataset","operationId":"1cbd515e_get_26","parameters":[{"name":"If-None-Match","in":"header","description":"If-None-Match conditional header (ETag)","required":false,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"dataset_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"funder_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}},{"name":"$context","in":"query","description":"The URI of the request context (e.g. the URI of a workspace)","required":false,"style":"form","explode":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model"}}}}}},"delete":{"tags":["draft-datasets"],"summary":"Deletes specific funder of a draft dataset","description":"Deletes specific funder of a draft dataset","operationId":"1cbd515e_delete_9","parameters":[{"name":"If-Match","in":"header","description":"If-Match conditional header (ETag)","required":false,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"dataset_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"funder_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}},{"name":"$context","in":"query","description":"The URI of the request context (e.g. the URI of a workspace)","required":false,"style":"form","explode":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"}}}},"/active-data-entities/datasets/drafts/{dataset_id}/funders":{"get":{"tags":["draft-datasets"],"summary":"Retrieves all funders of a draft dataset","description":"Retrieves all funders of a draft dataset","operationId":"1cbd515e_get_27","parameters":[{"name":"dataset_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"$context","in":"query","description":"The URI of the request context (e.g. the URI of a workspace)","required":false,"style":"form","explode":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model"}}}}}},"post":{"tags":["draft-datasets"],"summary":"Adds a funder to a draft dataset","description":"Adds a funder to a specific draft dataset","operationId":"1cbd515e_post_10","parameters":[{"name":"dataset_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"$context","in":"query","description":"The URI of the request context (e.g. the URI of a workspace)","required":false,"style":"form","explode":true,"schema":{"type":"string"}}],"requestBody":{"description":"Add draft dataset funder request","content":{"application/json":{"schema":{"required":["grant_id","identity","location","name"],"type":"object","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"},"grant_id":{"type":"string"},"identity":{"type":"string"},"name":{"type":"string"},"location":{"type":"string"}},"additionalProperties":{"type":"object"}}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model"}}}}}}},"/active-data-entities/datasets/drafts/{dataset_id}/funders/{funder_id}/properties/{property_name}":{"put":{"tags":["draft-datasets"],"summary":"Update specific property for a draft dataset funder","description":"Updates a specific property of a specific draft dataset funder","operationId":"1cbd515e_put_3","parameters":[{"name":"If-Match","in":"header","description":"If-Match conditional header (ETag)","required":false,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"dataset_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"funder_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}},{"name":"property_name","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"$context","in":"query","description":"The URI of the request context (e.g. the URI of a workspace)","required":false,"style":"form","explode":true,"schema":{"type":"string"}}],"requestBody":{"description":"Update draft dataset funder property request","content":{"application/json":{"schema":{"type":"object","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"}},"additionalProperties":{"type":"object"}}}},"required":true},"responses":{"204":{"description":"No Content"}}}},"/active-data-entities/datasets/drafts/{dataset_id}/institutions/{institution_id}":{"get":{"tags":["draft-datasets"],"summary":"Get institution for a draft dataset","description":"Retrieve a specific institution for a specific draft dataset","operationId":"1cbd515e_get_28","parameters":[{"name":"dataset_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"institution_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}},{"name":"$context","in":"query","description":"The URI of the request context (e.g. the URI of a workspace)","required":false,"style":"form","explode":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model"}}}}}},"delete":{"tags":["draft-datasets"],"summary":"Delete institution for a draft dataset","description":"Delete a specific institution for a specific draft dataset","operationId":"1cbd515e_delete_10","parameters":[{"name":"dataset_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"institution_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}},{"name":"$context","in":"query","description":"The URI of the request context (e.g. the URI of a workspace)","required":false,"style":"form","explode":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"}}}},"/active-data-entities/datasets/drafts/{dataset_id}/institutions":{"get":{"tags":["draft-datasets"],"summary":"Get institutions for a draft dataset","description":"Retrieve institutions for a specific draft dataset","operationId":"1cbd515e_get_29","parameters":[{"name":"dataset_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"$context","in":"query","description":"The URI of the request context (e.g. the URI of a workspace)","required":false,"style":"form","explode":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Model"}}}}}}},"post":{"tags":["draft-datasets"],"summary":"Add institution to a draft dataset","description":"Add institution to a specific draft dataset","operationId":"1cbd515e_post_11","parameters":[{"name":"dataset_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"$context","in":"query","description":"The URI of the request context (e.g. the URI of a workspace)","required":false,"style":"form","explode":true,"schema":{"type":"string"}}],"requestBody":{"description":"Add draft dataset institution request","content":{"application/json":{"schema":{"required":["$link"],"type":"object","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"},"$link":{"type":"string"}},"additionalProperties":{"type":"object"}}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model"}}}}}}},"/active-data-entities/datasets/drafts/{dataset_id}/metadata":{"get":{"tags":["draft-datasets"],"summary":"Get entire metadata collected for an entity","description":"Retrieve entire metadata collected for an entity","operationId":"1cbd515e_get_30","parameters":[{"name":"dataset_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"$context","in":"query","description":"The URI of the request context (e.g. the URI of a workspace)","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"include_definitions","in":"query","description":"Custom metadata template and field definitions are to be included","required":false,"style":"form","explode":true,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model"}}}}}},"put":{"tags":["draft-datasets"],"summary":"Update entire metadata for an entity","description":"Update entire metadata for an entity","operationId":"1cbd515e_put_4","parameters":[{"name":"dataset_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"$context","in":"query","description":"The URI of the request context (e.g. the URI of a workspace)","required":false,"style":"form","explode":true,"schema":{"type":"string"}}],"requestBody":{"description":"Update metadata request","content":{"application/json":{"schema":{"type":"object","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"}},"additionalProperties":{"type":"object"}}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model"}}}}}},"delete":{"tags":["draft-datasets"],"summary":"Clear all metadata collected against entity","description":"Clear all metadata collected against entity","operationId":"1cbd515e_delete_11","parameters":[{"name":"dataset_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"$context","in":"query","description":"The URI of the request context (e.g. the URI of a workspace)","required":false,"style":"form","explode":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"}}}},"/active-data-entities/datasets/drafts/{dataset_id}/metadata/{template_id}":{"get":{"tags":["draft-datasets"],"summary":"Get metadata collected for entity given metadata template","description":"Retrieve metadata collected for an entity for a specified metadata template","operationId":"1cbd515e_get_31","parameters":[{"name":"dataset_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"template_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}},{"name":"$context","in":"query","description":"The URI of the request context (e.g. the URI of a workspace)","required":false,"style":"form","explode":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model"}}}}}},"put":{"tags":["draft-datasets"],"summary":"Update metadata collected for entity given metadata template","description":"Update metadata collected for an entity for a specified metadata template","operationId":"1cbd515e_put_5","parameters":[{"name":"dataset_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"template_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}},{"name":"$context","in":"query","description":"The URI of the request context (e.g. the URI of a workspace)","required":false,"style":"form","explode":true,"schema":{"type":"string"}}],"requestBody":{"description":"Update template metadata request","content":{"application/json":{"schema":{"type":"object","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"}},"additionalProperties":{"type":"object"}}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model"}}}}}},"delete":{"tags":["draft-datasets"],"summary":"Delete all metadata collected against entity given metadata template","description":"Clear all metadata collected against an entity for a specified metadata template","operationId":"1cbd515e_delete_12","parameters":[{"name":"dataset_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"template_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}},{"name":"$context","in":"query","description":"The URI of the request context (e.g. the URI of a workspace)","required":false,"style":"form","explode":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"}}}},"/active-data-entities/datasets/drafts/{dataset_id}/metadata/{template_id}/{field_id}":{"get":{"tags":["draft-datasets"],"summary":"Get metadata collected for entity given metadata template and field","description":"Retrieve metadata collected for an entity for a specified metadata template and field","operationId":"1cbd515e_get_32","parameters":[{"name":"dataset_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"template_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}},{"name":"field_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}},{"name":"$context","in":"query","description":"The URI of the request context (e.g. the URI of a workspace)","required":false,"style":"form","explode":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model"}}}}}},"put":{"tags":["draft-datasets"],"summary":"Update metadata collected for entity given metadata template and field","description":"Update metadata collected for an entity for a specified metadata template and field","operationId":"1cbd515e_put_6","parameters":[{"name":"dataset_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"template_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}},{"name":"field_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}},{"name":"$context","in":"query","description":"The URI of the request context (e.g. the URI of a workspace)","required":false,"style":"form","explode":true,"schema":{"type":"string"}}],"requestBody":{"description":"Update template field metadata request","content":{"application/json":{"schema":{"type":"object","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"}},"additionalProperties":{"type":"object"}}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model"}}}}}},"post":{"tags":["draft-datasets"],"summary":"Add collected metadata value collected for metadata template and field","description":"Add collected metadata value collected for a specified metadata template and field","operationId":"1cbd515e_post_12","parameters":[{"name":"dataset_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"template_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}},{"name":"field_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}},{"name":"$context","in":"query","description":"The URI of the request context (e.g. the URI of a workspace)","required":false,"style":"form","explode":true,"schema":{"type":"string"}}],"requestBody":{"description":"Update template field metadata request","content":{"application/json":{"schema":{"type":"object","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"}},"additionalProperties":{"type":"object"}}}},"required":true},"responses":{"204":{"description":"No Content"}}},"delete":{"tags":["draft-datasets"],"summary":"Delete all metadata collected against entity given metadata template and field","description":"Clears all metadata collected against an entity for a specified metadata template and field","operationId":"1cbd515e_delete_13","parameters":[{"name":"dataset_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"template_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}},{"name":"field_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}},{"name":"$context","in":"query","description":"The URI of the request context (e.g. the URI of a workspace)","required":false,"style":"form","explode":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"}}}},"/active-data-entities/datasets/drafts/{dataset_id}/metadata/{template_id}/{field_id}/{value_id}":{"delete":{"tags":["draft-datasets"],"summary":"Delete collected value for entity given metadata template and field","description":"Remove specific collected value for an entity for a specified metadata template and field","operationId":"1cbd515e_delete_14","parameters":[{"name":"dataset_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"template_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}},{"name":"field_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}},{"name":"value_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}},{"name":"$context","in":"query","description":"The URI of the request context (e.g. the URI of a workspace)","required":false,"style":"form","explode":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"}}}},"/active-data-entities/datasets/drafts/{dataset_id}/organisational_units/{organisational_unit_id}":{"delete":{"summary":"Delete dataset org unit association","description":"Delete a specific org unit association with a draft dataset","operationId":"1cbd515e_delete_15","parameters":[{"name":"dataset_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"organisational_unit_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}},{"name":"$context","in":"query","description":"The URI of the request context (e.g. the URI of a workspace)","required":false,"style":"form","explode":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"}}}},"/active-data-entities/datasets/drafts/{dataset_id}/organisational_units":{"get":{"summary":"Get org units for a draft dataset","description":"Retrieve org units associated to a specific draft dataset","operationId":"1cbd515e_get_33","parameters":[{"name":"dataset_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"$context","in":"query","description":"The URI of the request context (e.g. the URI of a workspace)","required":false,"style":"form","explode":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Model"}}}}}}},"post":{"operationId":"1cbd515e_post_13","parameters":[{"name":"dataset_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"$context","in":"query","description":"The URI of the request context (e.g. the URI of a workspace)","required":false,"style":"form","explode":true,"schema":{"type":"string"}}],"requestBody":{"description":"Add draft dataset organisational unit request","content":{"application/json":{"schema":{"required":["$ref"],"type":"array","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"},"$ref":{"type":"string"}},"items":{"type":"object"}}}}},"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/active-data-entities/datasets/drafts/{dataset_id}/permissions":{"get":{"tags":["draft-datasets"],"summary":"Get permissions for a draft dataset","description":"Retrieve permissions for a specific draft dataset","operationId":"1cbd515e_get_34","parameters":[{"name":"dataset_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"$context","in":"query","description":"The URI of the request context (e.g. the URI of a workspace)","required":false,"style":"form","explode":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/active-data-entities/datasets/drafts/{dataset_id}/properties/{property_name}":{"get":{"tags":["draft-datasets"],"summary":"Get property for a draft dataset","description":"Retrieves a specific property for a specific draft dataset","operationId":"1cbd515e_get_35","parameters":[{"name":"dataset_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"property_name","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"$context","in":"query","description":"The URI of the request context (e.g. the URI of a workspace)","required":false,"style":"form","explode":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DraftDatasetPropertyResourceResponse"}}}}}},"put":{"tags":["draft-datasets"],"summary":"Updates property for a draft dataset","description":"Updates a specific property for a specific draft dataset","operationId":"1cbd515e_put_7","parameters":[{"name":"dataset_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"property_name","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"$context","in":"query","description":"The URI of the request context (e.g. the URI of a workspace)","required":false,"style":"form","explode":true,"schema":{"type":"string"}}],"requestBody":{"description":"Update draft dataset property request","content":{"application/json":{"schema":{"type":"object","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"}},"additionalProperties":{"type":"object"}}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DraftDatasetPropertyResourceResponse"}}}}}},"delete":{"tags":["draft-datasets"],"summary":"Delete draft dataset property","description":"Deletes a draft dataset property","operationId":"1cbd515e_delete_16","parameters":[{"name":"dataset_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"property_name","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"$context","in":"query","description":"The URI of the request context (e.g. the URI of a workspace)","required":false,"style":"form","explode":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"}}}},"/active-data-entities/datasets/published":{"post":{"tags":["draft-datasets"],"summary":"Publish a draft dataset","description":"Publishing a draft dataset given it is valid","operationId":"1cbd515e_publish","parameters":[{"name":"$context","in":"query","description":"The URI of the request context (e.g. the URI of a workspace)","required":false,"style":"form","explode":true,"schema":{"type":"string"}}],"requestBody":{"description":"Published a draft dataset","content":{"application/json":{"schema":{"type":"object","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"},"$ref":{"type":"string"},"details":{"type":"object","additionalProperties":{"type":"object"}}},"additionalProperties":{"type":"object"}}}},"required":true},"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/active-data-entities/datasets/drafts/{dataset_id}/related_links/{related_link_id}":{"get":{"tags":["draft-datasets"],"summary":"Get related link for a draft dataset","description":"Retrieve a related link for a specific draft dataset","operationId":"1cbd515e_get_36","parameters":[{"name":"dataset_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"related_link_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"integer","format":"int64"}},{"name":"$context","in":"query","description":"The URI of the request context (e.g. the URI of a workspace)","required":false,"style":"form","explode":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model"}}}}}},"delete":{"tags":["draft-datasets"],"summary":"Delete related link from a draft dataset","description":"Remove a related link from a specific draft dataset","operationId":"1cbd515e_delete_17","parameters":[{"name":"dataset_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"related_link_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"integer","format":"int64"}},{"name":"$context","in":"query","description":"The URI of the request context (e.g. the URI of a workspace)","required":false,"style":"form","explode":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"}}}},"/active-data-entities/datasets/drafts/{dataset_id}/related_links":{"get":{"tags":["draft-datasets"],"summary":"Get related links for a draft dataset","description":"Retrieve related links for a specific draft dataset","operationId":"1cbd515e_get_37","parameters":[{"name":"dataset_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"$context","in":"query","description":"The URI of the request context (e.g. the URI of a workspace)","required":false,"style":"form","explode":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Model"}}}}}}},"post":{"tags":["draft-datasets"],"summary":"Add related link to a dataset","description":"Adds a related link to a dataset","operationId":"1cbd515e_post_14","parameters":[{"name":"dataset_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"$context","in":"query","description":"The URI of the request context (e.g. the URI of a workspace)","required":false,"style":"form","explode":true,"schema":{"type":"string"}}],"requestBody":{"description":"Adds a new related link to a dataset","content":{"application/json":{"schema":{"required":["href","relation_type","source_type"],"type":"object","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"},"relation_type":{"type":"string"},"source_type":{"type":"string"},"href":{"type":"string"}},"additionalProperties":{"type":"object"}}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model"}}}}}}},"/active-data-entities/datasets/drafts/tokens/related_links":{"get":{"tags":["draft-datasets"],"summary":"Get tokens for draft dataset's related links","description":"Retrieves tokens relating to a draft dataset's related links","operationId":"1cbd515e_get_38","parameters":[{"name":"$properties","in":"query","description":"Properties to be expanded","required":false,"style":"form","explode":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"}}}},"/active-data-entities/datasets/drafts/tokens/dataset_status":{"get":{"tags":["draft-datasets"],"summary":"Get tokens relating to a draft datasets status","description":"Retrieves tokens relating to a draft datasets status","operationId":"1cbd515e_get_39","parameters":[{"name":"$properties","in":"query","description":"Properties to be expanded","required":false,"style":"form","explode":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"}}}},"/active-data-entities/datasets/drafts/{dataset_id}/versions":{"get":{"tags":["draft-datasets"],"summary":"Get all versions of a draft dataset","description":"Retrieves all versions of a draft dataset","operationId":"1cbd515e_get_40","parameters":[{"name":"$start","in":"query","description":"Start offset for items to be retrieved (0 - n)","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int64"}},{"name":"$limit","in":"query","description":"Limit of number of items to be retrieved (page size) [default = 100]","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int64"}},{"name":"$page","in":"query","description":"Page number for items to be retrieved (1 - n)","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int64"}},{"name":"Range","in":"header","description":"Range header (use tokens 'start', 'limit' or 'page')","required":false,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"$properties","in":"query","description":"Properties to be expanded","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"$sort","in":"query","description":"Property, or properties, to sort result by (comma separated). Prefix the property with '-' to sort in descending order","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"dataset_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"$context","in":"query","description":"The URI of the request context (e.g. the URI of a workspace)","required":false,"style":"form","explode":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Model"}}}}},"206":{"description":"Partial Content","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Model"}}}}}}}},"/active-data-entities/datasets/publics/{dataset_id}/metadata":{"get":{"description":"Retrieve entire metadata collected for a published dataset","operationId":"1cbd515e_get_41","parameters":[{"name":"dataset_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model"}}}}}}},"/active-data-entities/datasets/used_storage/me":{"get":{"operationId":"1cbd515e_get_42","responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/active-data-entities/licences/{licence_id}":{"get":{"tags":["licences"],"summary":"Get a licence","description":"Retrieve a specific licence","operationId":"1cbd515e_get_43","parameters":[{"name":"$properties","in":"query","description":"Properties to be expanded","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"licence_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model"}}}}}},"delete":{"tags":["licences"],"summary":"Delete a licence","description":"Delete a specific licence","operationId":"1cbd515e_delete_18","parameters":[{"name":"licence_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"No Content"}}},"patch":{"tags":["licences"],"summary":"Update a licence","description":"Update a specific licence","operationId":"1cbd515e_patch_3","parameters":[{"name":"licence_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Details for the patch.","content":{"application/json":{"schema":{"type":"object","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"}},"additionalProperties":{"type":"object"}}}},"required":true},"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/active-data-entities/licences":{"get":{"tags":["licences"],"summary":"Get licences","description":"List/query licences","operationId":"1cbd515e_get_44","parameters":[{"name":"$properties","in":"query","description":"Properties to be expanded","required":false,"style":"form","explode":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Model"}}}}}}},"post":{"tags":["licences"],"summary":"Create a licence","description":"Creates a new licence","operationId":"1cbd515e_post_15","requestBody":{"description":"Creates a new licence","content":{"application/json":{"schema":{"required":["category","customer_id","description","full_name","short_name","url"],"type":"object","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"},"short_name":{"type":"string"},"full_name":{"type":"string"},"description":{"type":"string"},"url":{"type":"string"},"category":{"type":"string"},"customer_id":{"type":"string"}},"additionalProperties":{"type":"object"}}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model"}}}}}}},"/featured-sections":{"get":{"description":"Root discovery endpoint","operationId":"40bda819_get","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/featured-sections/sections/{section_uuid}":{"delete":{"tags":["featured-sections"],"summary":"Delete featured section","description":"Delete a specific featured section","operationId":"40bda819_delete","parameters":[{"name":"If-Match","in":"header","description":"If-Match conditional header (ETag)","required":false,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"section_uuid","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"No Content"},"404":{"description":"Not Found"}}}},"/featured-sections/sections":{"get":{"tags":["featured-sections"],"summary":"Get featured sections","description":"Get featured sections","operationId":"40bda819_get_1","parameters":[{"name":"$limit","in":"query","description":"Limit of number of items to be retrieved (page size)","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int64"}},{"name":"$page","in":"query","description":"Page number for items to be retrieved (1 - n)","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int64"}},{"name":"Rangepage","in":"query","description":"Range header (use tokens 'limit', 'page')","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FeaturedSection"}}}}}}},"post":{"tags":["featured-sections"],"summary":"Create featured section","description":"Create featured section","operationId":"40bda819_post","requestBody":{"description":"Add Section Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddFeaturedSectionRequest"}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FeaturedSection"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}}}},"/featured-sections/sections/{section_uuid}/contents/{content_id}":{"delete":{"tags":["featured-sections"],"summary":"Delete featured section content","description":"Delete featured section content","operationId":"40bda819_delete_1","parameters":[{"name":"If-Match","in":"header","description":"If-Match conditional header (ETag)","required":false,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"section_uuid","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}},{"name":"content_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content","content":{"application/json":{"schema":{"type":"string"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}}}},"/featured-sections/sections/{section_uuid}/contents":{"get":{"tags":["featured-sections"],"summary":"Get featured section contents","description":"Get featured section contents","operationId":"40bda819_get_2","parameters":[{"name":"section_uuid","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}}],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FeaturedSectionContent"}}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}}},"post":{"tags":["featured-sections"],"summary":"Add featured section content","description":"Add featured section content","operationId":"40bda819_post_1","parameters":[{"name":"section_uuid","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Add Section Content Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddFeaturedSectionContentRequest"}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FeaturedSectionContent"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}}}},"/featured-sections/sections/{section_uuid}/properties/{property_name}":{"put":{"tags":["featured-sections"],"summary":"Update section properties","description":"Update section properties : {title:status:ordinal}","operationId":"40bda819_put","parameters":[{"name":"If-Match","in":"header","description":"If-Match conditional header (ETag)","required":false,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"section_uuid","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}},{"name":"property_name","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"description":"Update Property Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePropertyRequest"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"422":{"description":"Unprocessable Entity"}}}},"/featured-sections/public/sections":{"get":{"tags":["featured-sections"],"summary":"Get public featured sections","description":"Get public featured sections","operationId":"40bda819_get_3","parameters":[{"name":"$limit","in":"query","description":"Limit of number of items to be retrieved (page size)","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int64"}},{"name":"$page","in":"query","description":"Page number for items to be retrieved (1 - n)","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int64"}},{"name":"Rangepage","in":"query","description":"Range header (use tokens 'limit', 'page')","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int64"}},{"name":"customer_id","in":"query","description":"Filter by customer id","required":false,"style":"form","explode":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FeaturedSection"}}}}}}}},"/datasets/{id}/confidential/request-access":{"post":{"tags":["public-datasets"],"summary":"Request access for a confidential dataset","description":"Sends a request access to the owner of the confidential dataset","operationId":"4d63932f_createRequestAccess","parameters":[{"name":"id","in":"path","description":"The dataset id","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfidentialDatasetsAccessRequest"}}},"required":true},"responses":{"204":{"description":"Successfully sends the request access to the owner of the confidential dataset","content":{"*/*":{"schema":{"type":"string"}}}},"404":{"description":"Dataset not found.","content":{"*/*":{"schema":{"type":"string"}}}}}}},"/datasets":{"get":{"tags":["public-datasets"],"summary":"Get public datasets","description":"Retrieve the latest versions of all public datasets.","operationId":"4d63932f_getPublicDatasets","parameters":[{"name":"article_doi","in":"query","description":"Filter by datasets linked to an article doi","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Comma-separated list of fields to retrieve for each dataset. \nNote: 'results.*' to return everything. \nDefault is 'results.id'","required":false,"style":"form","explode":true,"schema":{"type":"string","default":"results.id"}},{"name":"institution","in":"query","description":"Filter by Mendeley Institution UID","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"issn","in":"query","description":"Filter by journal ISSN","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"The maximum number of items on the page. \nThe largest allowable value is 500. \nDefault is '20'","required":false,"style":"form","explode":true,"schema":{"type":"string","default":"20"}},{"name":"modified_since","in":"query","description":"Filter by date of last dataset change","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"modified_before","in":"query","description":"Filter by date of last dataset change","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"order","in":"query","description":"The sort order","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"profile_id","in":"query","description":"Filter by Mendeley profile id","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"sort","in":"query","description":"The field to sort on\nAllowed values: publish_date,name","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"type","in":"query","description":"Filter search results by file type. \nAllows multiple values. \nAllowed values: document,file_set,image,raw,slides,software,statistical_data,tabular_data,video","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"}}},{"name":"marker","in":"query","description":"marker","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"reverse","in":"query","description":"reverse","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"X-Forwarded-Host","in":"header","description":"X-Forwarded-Host","required":false,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"X-Forwarded-App","in":"header","description":"X-Forwarded-App","required":false,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"default":{"description":"Public dataset versions metadata found.","content":{"application/vnd.mendeley-public-dataset.1+json":{"schema":{"$ref":"#/components/schemas/PublicDatasetsWithSummaryDTO"}}}}}}},"/datasets/{id}":{"get":{"tags":["public-datasets"],"summary":"Get a public dataset","description":"Retrieve a public dataset using its id","operationId":"4d63932f_getPublicDatasetWithId","parameters":[{"name":"id","in":"path","description":"The id of the dataset to retrieve","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"version","in":"query","description":"The version of the dataset to retrieve (defaults to the latest published)","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int64"}},{"name":"fields","in":"query","description":"BETA: Comma-separated list of fields to retrieve for the dataset. \nDefault is '*'.\nNote: '*' to return everything.","required":false,"style":"form","explode":true,"schema":{"type":"string","default":"*"}},{"name":"Session-Id","in":"header","description":"Session-Id","required":false,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Public dataset with the supplied id was found.","content":{"application/vnd.mendeley-public-dataset.1+json":{"schema":{"$ref":"#/components/schemas/DatasetMetadataDTO"}}}},"404":{"description":"No public dataset with the supplied id was found.","content":{"application/vnd.mendeley-public-dataset.1+json":{"schema":{"type":"string"}}}}}}},"/datasets/{id}/versions":{"get":{"tags":["public-datasets"],"summary":"Get versions for a public dataset","description":"Retrieves a public dataset versions metadata using its dataset id","operationId":"4d63932f_getPublicDatasetVersions","parameters":[{"name":"id","in":"path","description":"The id of the dataset to retrieve","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Public dataset versions metadata found.","content":{"application/json":{"schema":{"type":"string"}}}},"404":{"description":"No public dataset was found with the supplied id.","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/datasets/{id}/snapshot":{"get":{"tags":["public-datasets"],"summary":"Get a snapshot of a public dataset","description":"Retrieves a public dataset metadata snapshot using its dataset id and (optional) version","operationId":"4d63932f_getPublicDatasetSnapshot","parameters":[{"name":"id","in":"path","description":"The id of the dataset to retrieve","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"version","in":"query","description":"The version of the dataset to retrieve (defaults to the latest published)","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Public dataset metadata snapshot found.","content":{"application/json":{"schema":{"type":"string"}}}},"404":{"description":"No public dataset was found with the supplied id.","content":{"application/json":{"schema":{"type":"string"}}}},"451":{"description":"Unavailable For Legal Reasons if dataset is blocked.","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/datasets/{id}/metadata":{"get":{"tags":["public-datasets"],"summary":"Get custom metadata for a public dataset","description":"Retrieve a public dataset custom metadata using its id","operationId":"4d63932f_getPublicDatasetCustomMetadata","parameters":[{"name":"id","in":"path","description":"The id of the dataset to retrieve","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"version","in":"query","description":"The version of the dataset to retrieve (defaults to the latest published)","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Public dataset custom metadata with the supplied id was found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetMetadataDTO"}}}},"404":{"description":"No public dataset custom metadata with the supplied id was found.","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/datasets/{id}/files":{"get":{"tags":["files","public-datasets"],"summary":"Get files of a public dataset","description":"Get files of a public dataset","operationId":"4d63932f_getFiles","parameters":[{"name":"id","in":"path","description":"The dataset id","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"version","in":"query","description":"The version of the dataset to retrieve (defaults to the latest published)","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int64"}},{"name":"folder_id","in":"query","description":"The folder id","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"$start","in":"query","description":"The batch result start index","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int32"}},{"name":"$limit","in":"query","description":"The batch size","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"The file(s).","content":{"application/json":{"schema":{"type":"string"}}}},"404":{"description":"Dataset or file not found.","content":{"application/json":{"schema":{"type":"string"}}}},"451":{"description":"Dataset is under embargo.","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/datasets/{id}/files/{file_uuid}":{"get":{"tags":["files","public-datasets"],"summary":"Get file of a public dataset","description":"Get file of a public dataset","operationId":"4d63932f_getFile","parameters":[{"name":"id","in":"path","description":"The dataset id","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"file_uuid","in":"path","description":"The file uuid to retrieve","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"version","in":"query","description":"The version of the dataset to retrieve (defaults to the latest published)","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"The file.","content":{"application/vnd.mendeley-public-file.1+json":{"schema":{"$ref":"#/components/schemas/FileMetadataDTO"}},"application/json":{"schema":{"$ref":"#/components/schemas/FileMetadataDTO"}}}},"404":{"description":"Dataset or file not found.","content":{"application/vnd.mendeley-public-file.1+json":{"schema":{"type":"string"}},"application/json":{"schema":{"type":"string"}}}},"451":{"description":"Dataset is under embargo.","content":{"application/vnd.mendeley-public-file.1+json":{"schema":{"type":"string"}},"application/json":{"schema":{"type":"string"}}}}}}},"/datasets/{id}/files/{file_uuid}/{event_type}":{"get":{"tags":["files","public-datasets"],"summary":"Get file download URL for a public dataset","description":"Get file's final URL for download or view by redirect","operationId":"4d63932f_redirectByFileByFileId","parameters":[{"name":"id","in":"path","description":"The dataset id","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"file_uuid","in":"path","description":"The dataset file id","required":true,"style":"simple","explode":false,"schema":{"$ref":"#/components/schemas/UUIDParam"}},{"name":"event_type","in":"path","description":"Event types can be file_downloaded, file_viewed","required":true,"style":"simple","explode":false,"schema":{"$ref":"#/components/schemas/FileTypeParam"}},{"name":"version","in":"query","description":"The version of the dataset","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"307":{"description":"Public file was found.","content":{"application/json":{"schema":{"type":"string"}}}},"404":{"description":"No public file found with the supplied dataset id and file id.","content":{"application/json":{"schema":{"type":"string"}}}},"500":{"description":"Public file was found.","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/datasets/redirect/{encoded_text}":{"get":{"tags":["redirect-controller"],"description":"Deserialize encoded_text with base64\nFind files and return final URL with temporarily redirect.","operationId":"4d63932f_redirectByEncodedText","parameters":[{"name":"encoded_text","in":"path","description":"Encoded text for file metadata","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"string"}}}}}}},"/datasets/publics/{id}/folders":{"get":{"tags":["folders","public-datasets"],"summary":"Get public dataset folders","operationId":"4d63932f_getPublicFolders","parameters":[{"name":"id","in":"path","description":"Dataset id","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"version","in":"query","description":"Dataset version","required":true,"style":"form","explode":true,"schema":{"type":"integer","format":"int64"}},{"name":"parent_id","in":"query","description":"Parent folder id","required":false,"style":"form","explode":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Here are the folders.","content":{"application/vnd.mendeley-dataset-folder+json":{"schema":{"type":"string"}},"application/json":{"schema":{"type":"string"}}}},"404":{"description":"Dataset not found.","content":{"application/vnd.mendeley-dataset-folder+json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FolderDTO"}}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FolderDTO"}}}}},"451":{"description":"Dataset under embargo.","content":{"application/vnd.mendeley-dataset-folder+json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FolderDTO"}}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FolderDTO"}}}}}}}},"/datasets/publics/{id}/folders/{folder_id}":{"get":{"tags":["folders","public-datasets"],"summary":"Get public dataset folder","operationId":"4d63932f_getPublicFolder","parameters":[{"name":"id","in":"path","description":"Dataset id","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"folder_id","in":"path","description":"Folder id","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"version","in":"query","description":"Dataset version","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Here are the folder.","content":{"application/vnd.mendeley-dataset-folder+json":{"schema":{"type":"string"}},"application/json":{"schema":{"type":"string"}}}},"404":{"description":"Dataset or folder not found.","content":{"application/vnd.mendeley-dataset-folder+json":{"schema":{"$ref":"#/components/schemas/FolderDTO"}},"application/json":{"schema":{"$ref":"#/components/schemas/FolderDTO"}}}},"451":{"description":"Dataset under embargo.","content":{"application/vnd.mendeley-dataset-folder+json":{"schema":{"$ref":"#/components/schemas/FolderDTO"}},"application/json":{"schema":{"$ref":"#/components/schemas/FolderDTO"}}}}}}},"/datasets/publics/{id}/files":{"get":{"tags":["files","public-datasets"],"summary":"Get files of a public dataset","description":"Get files of a public dataset","operationId":"4d63932f_getPublicFiles","parameters":[{"name":"id","in":"path","description":"The dataset id","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"version","in":"query","description":"The version of the dataset to retrieve (defaults to the latest published)","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int64"}},{"name":"folder_id","in":"query","description":"The folder id","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"$start","in":"query","description":"The batch result start index","required":false,"style":"form","explode":true,"schema":{"minimum":0,"type":"integer","format":"int64","default":0}},{"name":"$limit","in":"query","description":"The batch size","required":false,"style":"form","explode":true,"schema":{"minimum":1,"type":"integer","format":"int64","default":100}}],"responses":{"200":{"description":"The file(s).","content":{"application/json":{"schema":{"type":"string"}}}},"404":{"description":"Dataset or file not found.","content":{"application/json":{"schema":{"type":"string"}}}},"451":{"description":"Dataset is under embargo.","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/datasets/publics/{id}/files/{file_id}":{"get":{"tags":["files","public-datasets"],"summary":"Get file of a public dataset","description":"Get file of a public dataset","operationId":"4d63932f_getPublicFile","parameters":[{"name":"id","in":"path","description":"The dataset id","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"file_id","in":"path","description":"The file uuid to retrieve","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"version","in":"query","description":"The version of the dataset to retrieve (defaults to the latest published)","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"The file.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileMetadataDTO"}}}},"404":{"description":"Dataset or file not found.","content":{"application/json":{"schema":{"type":"string"}}}},"451":{"description":"Dataset is under embargo.","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/dataset_metrics/datasets/{dataset_id}":{"get":{"tags":["metrics"],"summary":"Retrieve the metrics of a dataset","description":"Retrieve the metrics of a dataset","operationId":"ecc1ed76_getDatasetMetrics","parameters":[{"name":"dataset_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetMetrics"}}}},"404":{"description":"Not Found"}}}},"/":{"get":{"tags":["moderation"],"summary":"Get root endpoint details","description":"Root discovery endpoint","operationId":"d8aaa932_get","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/datasets/{entity_id}":{"get":{"operationId":"d8aaa932_get_1","parameters":[{"name":"entity_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/datasets/approvals":{"post":{"tags":["moderation"],"summary":"Create a moderation approval","description":"Approves a dataset in moderation","operationId":"d8aaa932_post","requestBody":{"description":"Approves an entity","content":{"application/json":{"schema":{"required":["$ref"],"type":"object","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"},"$ref":{"type":"string"}},"additionalProperties":{"type":"object"}}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model"}}}}}}},"/datasets/{entity_id}/comments":{"get":{"tags":["moderation"],"summary":"Get a comment on dataset in moderation","description":"Get a comment on dataset in moderation","operationId":"d8aaa932_listComments","parameters":[{"name":"entity_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"$context","in":"query","description":"The URI of the request context (e.g. the URI of a workspace)","required":false,"style":"form","explode":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string"}}}}}},"post":{"tags":["moderation"],"summary":"Create a comment on dataset in moderation","description":"Create a comment on dataset in moderation, and returns to author for review","operationId":"d8aaa932_comment","parameters":[{"name":"entity_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"description":"Comment Request","content":{"application/json":{"schema":{"required":["comment"],"type":"object","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"},"comment":{"type":"string"},"importance":{"type":"string"}},"additionalProperties":{"type":"object"}}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/datasets/{entity_id}/comments/completed":{"get":{"tags":["moderation"],"summary":"Get a completed comment","description":"Get a completed comment","operationId":"d8aaa932_getCompletedComments","parameters":[{"name":"entity_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"$context","in":"query","description":"The URI of the request context (e.g. the URI of a workspace)","required":false,"style":"form","explode":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"type":"string"}}}}}},"post":{"tags":["moderation"],"summary":"Create a completed comment","description":"Create a completed comment","operationId":"d8aaa932_clearComments","parameters":[{"name":"entity_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"$context","in":"query","description":"The URI of the request context (e.g. the URI of a workspace)","required":false,"style":"form","explode":true,"schema":{"type":"string"}}],"requestBody":{"description":"Comments on a dataset, and returns to author for review","content":{"application/json":{"schema":{"required":["$ref"],"type":"object","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"},"$ref":{"type":"string"}},"additionalProperties":{"type":"object"}}}},"required":true},"responses":{"201":{"description":"Created"}}}},"/enumerators":{"get":{"tags":["moderation"],"summary":"Gets moderation states root details","description":"Exposes moderation states root details","operationId":"d8aaa932_get_3","responses":{"200":{"description":"OK"}}}},"/moderations/enumerators/moderation_state":{"get":{"tags":["moderation"],"summary":"Get moderation states","description":"Exposes moderation states for institution","operationId":"d8aaa932_get_4","responses":{"200":{"description":"OK"}}}},"/moderations/{entity_id}":{"get":{"tags":["moderation"],"summary":"Get a moderation","description":"Retrieves specific entity for customer institution","operationId":"d8aaa932_get_5","parameters":[{"name":"entity_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}},{"name":"documentation","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model"}}}}}}},"/moderations":{"get":{"tags":["moderation"],"summary":"Get datasets in moderation and previously moderated","description":"Retrieves all datasets in moderation or previously moderated for specific institution","operationId":"d8aaa932_get_6","parameters":[{"name":"$start","in":"query","description":"Start offset for items to be retrieved (0 - n)","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int64"}},{"name":"$limit","in":"query","description":"Limit of number of items to be retrieved (page size) [default = 100]","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int64"}},{"name":"$page","in":"query","description":"Page number for items to be retrieved (1 - n)","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int64"}},{"name":"$properties","in":"query","description":"Properties to be expanded","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"$sort","in":"query","description":"Property, or comma separated properties, to sort result by","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"contains","in":"query","description":"Filter by specific content URI, e.g. draft dataset URI","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"mendeley_moderation","in":"query","description":"Restrict to just customers without internal moderation","required":false,"style":"form","explode":true,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Model"}}}}},"204":{"description":"No Content"},"206":{"description":"Partial Content"}}},"post":{"tags":["moderation"],"summary":"Create a moderation for a dataset","description":"Adds a dataset to moderation system","operationId":"d8aaa932_post_1","requestBody":{"description":"Adds an entity for moderation","content":{"application/json":{"schema":{"required":["$ref"],"type":"object","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"},"$ref":{"type":"string"},"moderation_state":{"type":"string"}},"additionalProperties":{"type":"object"}}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model"}}}}}}},"/moderations/{entity_uri}/activities":{"get":{"tags":["moderation"],"summary":"Get moderation activities","description":"Retrieves all moderation activity for a particular entity e.g. draft dataset","operationId":"d8aaa932_get_7","parameters":[{"name":"$properties","in":"query","description":"Properties to be expanded","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"$sort","in":"query","description":"Property, or comma separated properties, to sort result by","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"entity_uri","in":"path","required":true,"style":"simple","explode":false,"schema":{"pattern":".*","type":"string"}},{"name":"current_draft","in":"query","description":"Only retrieve rejections for the active draft. Can only be used with contains param","required":false,"style":"form","explode":true,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Model"}}}}},"204":{"description":"No Content"},"206":{"description":"Partial Content"}}}},"/moderations/approvals":{"get":{"tags":["moderation"],"summary":"Get approved datasets","description":"Retrieves all approved datasets for a specific institution","operationId":"d8aaa932_get_8","parameters":[{"name":"$start","in":"query","description":"Start offset for items to be retrieved (0 - n)","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int64"}},{"name":"$limit","in":"query","description":"Limit of number of items to be retrieved (page size) [default = 100]","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int64"}},{"name":"$page","in":"query","description":"Page number for items to be retrieved (1 - n)","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int64"}},{"name":"$properties","in":"query","description":"Properties to be expanded","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"$sort","in":"query","description":"Property, or comma separated properties, to sort result by","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"contains","in":"query","description":"Filter by specific content URI, e.g. draft dataset URI","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"mendeley_moderation","in":"query","description":"Restrict to just customers without internal moderation","required":false,"style":"form","explode":true,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Model"}}}}},"204":{"description":"No Content"},"206":{"description":"Partial Content"}}},"post":{"tags":["moderation"],"summary":"Create moderation approval for a dataset","description":"Approves a dataset in moderation","operationId":"d8aaa932_post_2","requestBody":{"description":"Approves an entity","content":{"application/json":{"schema":{"required":["$ref"],"type":"object","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"},"$ref":{"type":"string"}},"additionalProperties":{"type":"object"}}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model"}}}}}}},"/moderations/rejections":{"get":{"tags":["moderation"],"summary":"Get rejected datasets","description":"Retrieves all rejected datasets for specific institution","operationId":"d8aaa932_get_9","parameters":[{"name":"$start","in":"query","description":"Start offset for items to be retrieved (0 - n)","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int64"}},{"name":"$limit","in":"query","description":"Limit of number of items to be retrieved (page size) [default = 100]","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int64"}},{"name":"$page","in":"query","description":"Page number for items to be retrieved (1 - n)","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int64"}},{"name":"$properties","in":"query","description":"Properties to be expanded","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"$sort","in":"query","description":"Property, or comma separated properties, to sort result by","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"contains","in":"query","description":"Filter by specific content URI, e.g. draft dataset URI","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"most_recent","in":"query","description":"Only retrieve latest rejected draft dataset","required":false,"style":"form","explode":true,"schema":{"type":"boolean"}},{"name":"mendeley_moderation","in":"query","description":"Restrict to just customers without internal moderation","required":false,"style":"form","explode":true,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Model"}}}}},"204":{"description":"No Content"},"206":{"description":"Partial Content"}}},"post":{"tags":["moderation"],"summary":"Create moderation rejection","description":"Rejects an entity in moderation","operationId":"d8aaa932_post_3","requestBody":{"description":"Rejects an entity","content":{"application/json":{"schema":{"required":["$ref","rejection_reason"],"type":"object","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"},"$ref":{"type":"string"},"rejection_reason":{"type":"string"}},"additionalProperties":{"type":"object"}}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model"}}}}}}},"/audits":{"get":{"tags":["audit-log"],"summary":"Get audit events for an institution","description":"Retrieves audit events for an institution","operationId":"844a805b_get_1","parameters":[{"name":"$sort","in":"query","description":"Property, or properties, to sort result by (comma separated). Prefix the property with '-' to sort in descending order","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"$start","in":"query","description":"Start offset for items to be retrieved (0 - n)","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int64"}},{"name":"$limit","in":"query","description":"Limit of number of items to be retrieved (page size) [default = 100]","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int64"}},{"name":"$page","in":"query","description":"Page number for items to be retrieved (1 - n)","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int64"}},{"name":"Range","in":"header","description":"Range header (use tokens 'start', 'limit' or 'page')","required":false,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Model"}}}}},"206":{"description":"Partial Content"}}}},"/datasets/drafts/csv":{"get":{"tags":["dataset-management"],"summary":"Get draft datasets for an institution as csv","description":"Retrieves daily generated draft dataset metadata for user's institution as csv","operationId":"844a805b_csv","responses":{"307":{"description":"Temporary Redirect"}}}},"/datasets/publics/csv":{"get":{"tags":["dataset-management"],"summary":"Get public datasets for an institution as csv","description":"Retrieves daily generated public dataset metadata for user's institution as csv","operationId":"844a805b_csv_1","responses":{"307":{"description":"Temporary Redirect"}}}},"/datasets/events":{"get":{"tags":["audit-log"],"summary":"Get dataset events","description":"Retrieves dataset events","operationId":"844a805b_getJson","parameters":[{"name":"$sort","in":"query","description":"Property, or properties, to sort result by (comma separated). Prefix the property with '-' to sort in descending order","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"$start","in":"query","description":"Start offset for items to be retrieved (0 - n)","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int64"}},{"name":"$limit","in":"query","description":"Limit of number of items to be retrieved (page size) [default = 100]","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int64"}},{"name":"$page","in":"query","description":"Page number for items to be retrieved (1 - n)","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int64"}},{"name":"Range","in":"header","description":"Range header (use tokens 'start', 'limit' or 'page')","required":false,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok"},"206":{"description":"Partial Content"}}}},"/datasets/publics/{dataset_id}":{"get":{"tags":["dataset-management"],"summary":"Get a public dataset for an institution","description":"Get a public dataset for an institution","operationId":"844a805b_get_2","parameters":[{"name":"$properties","in":"query","description":"Properties to be expanded","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"dataset_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model"}}}}}}},"/datasets/publics":{"get":{"tags":["dataset-management"],"summary":"Get public datasets for an institution","description":"Retrieves public datasets for an institution","operationId":"844a805b_get_3","parameters":[{"name":"$properties","in":"query","description":"Properties to be expanded","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"$sort","in":"query","description":"Property, or properties, to sort result by (comma separated). Prefix the property with '-' to sort in descending order","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"$start","in":"query","description":"Start offset for items to be retrieved (0 - n)","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int64"}},{"name":"$limit","in":"query","description":"Limit of number of items to be retrieved (page size) [default = 100]","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int64"}},{"name":"$page","in":"query","description":"Page number for items to be retrieved (1 - n)","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int64"}},{"name":"Range","in":"header","description":"Range header (use tokens 'start', 'limit' or 'page')","required":false,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"journal_issn","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"article_doi","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json; qs=1.0":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Model"}}}}},"206":{"description":"Partial Content"}}}},"/datasets/publics/{dataset_id}/articles/{doi}":{"get":{"tags":["dataset-management"],"summary":"Get an article linked to a public dataset","description":"Get an article linked to a public dataset","operationId":"844a805b_get_4","parameters":[{"name":"dataset_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"doi","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model"}}}}}},"delete":{"tags":["dataset-management"],"summary":"Delete an article link to a public dataset","description":"Delete an article link to a specific public dataset","operationId":"844a805b_delete","parameters":[{"name":"dataset_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"doi","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"}}}},"/datasets/publics/{dataset_id}/articles":{"get":{"tags":["dataset-management"],"summary":"List linked articles for a public dataset","description":"List linked articles for a specific public dataset","operationId":"844a805b_get_5","parameters":[{"name":"$properties","in":"query","description":"Properties to be expanded","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"$sort","in":"query","description":"Property, or properties, to sort result by (comma separated). Prefix the property with '-' to sort in descending order","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"$start","in":"query","description":"Start offset for items to be retrieved (0 - n)","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int64"}},{"name":"$limit","in":"query","description":"Limit of number of items to be retrieved (page size) [default = 100]","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int64"}},{"name":"$page","in":"query","description":"Page number for items to be retrieved (1 - n)","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int64"}},{"name":"Range","in":"header","description":"Range header (use tokens 'start', 'limit' or 'page')","required":false,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"dataset_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Model"}}}}},"206":{"description":"Partial Content"}}},"post":{"tags":["dataset-management"],"summary":"Link a public dataset to an article","description":"Link a public dataset to an article","operationId":"844a805b_post","parameters":[{"name":"dataset_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"description":"Add public dataset article link request","content":{"application/json":{"schema":{"required":["doi","title"],"type":"object","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"},"doi":{"type":"string"},"title":{"type":"string"},"pii":{"type":"string"},"journal":{"required":["issn","name"],"type":"object","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"},"issn":{"type":"string"},"name":{"type":"string"}},"additionalProperties":{"type":"object"}}},"additionalProperties":{"type":"object"}}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model"}}}}}}},"/articles/{doi}/xref":{"get":{"tags":["dataset-management"],"summary":"Get article from CrossRef","description":"Retrieves json response from CrossRef, and parses it into an 'dataset article' object","operationId":"844a805b_get_6","parameters":[{"name":"doi","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/datasets/publics/{dataset_id}/properties/{property_name}":{"get":{"tags":["dataset-management"],"summary":"Get a property for a public dataset","description":"Retrieves a specific property for a specific public dataset","operationId":"844a805b_get_7","parameters":[{"name":"dataset_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"property_name","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"customer_id","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicDatasetPropertyResourceResponse"}}}}}}},"/datasets/publics/removed":{"get":{"summary":"Get metadata of removed public datasets for an institution","description":"Retrieves removed public datasets for an institution","operationId":"844a805b_get_8","parameters":[{"name":"$properties","in":"query","description":"Properties to be expanded","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"$sort","in":"query","description":"Property, or properties, to sort result by (comma separated). Prefix the property with '-' to sort in descending order","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"$start","in":"query","description":"Start offset for items to be retrieved (0 - n)","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int64"}},{"name":"$limit","in":"query","description":"Limit of number of items to be retrieved (page size) [default = 100]","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int64"}},{"name":"$page","in":"query","description":"Page number for items to be retrieved (1 - n)","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int64"}},{"name":"Range","in":"header","description":"Range header (use tokens 'start', 'limit' or 'page')","required":false,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Model"}}}}},"206":{"description":"Partial Content"}}},"post":{"summary":"Begins asynchronous saga to remove public dataset. Use removal_status=REMOVE to fully remove dataset","operationId":"844a805b_post_1","requestBody":{"description":"Removes a public dataset","content":{"application/json":{"schema":{"required":["removal_action","removal_reason"],"type":"object","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"},"removal_reason":{"type":"string"},"removal_action":{"type":"string"},"$ref":{"type":"string"}},"additionalProperties":{"type":"object"}}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemoveDatasetRequest"}}}}}}},"/datasets/used_storage":{"get":{"tags":["dataset-management"],"summary":"Get the dataset storage in bytes","description":"Retrieves the dataset storage used by an institution in bytes","operationId":"844a805b_get_9","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model"}}}},"206":{"description":"Partial Content"}}}},"/roles":{"get":{"tags":["user-management"],"summary":"List roles","description":"List roles","operationId":"844a805b_get_10","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model"}}}}}}},"/roles/{role_name}/members/{profile_id}":{"delete":{"tags":["user-management"],"summary":"Delete a user from a role","description":"Remove a user from a specific role","operationId":"844a805b_delete_1","parameters":[{"name":"role_name","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"profile_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"No Content"}}}},"/roles/{role_name}/members":{"get":{"tags":["user-management"],"summary":"List members for a role","description":"List members for a role","operationId":"844a805b_get_11","parameters":[{"name":"role_name","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Model"}}}}}}},"post":{"tags":["user-management"],"summary":"Adds member to a role","description":"Adds member to a role","operationId":"844a805b_post_2","parameters":[{"name":"role_name","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"description":"Creates a new admin for your customer","content":{"application/json":{"schema":{"required":["email"],"type":"object","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"},"email":{"type":"string"}},"additionalProperties":{"type":"object"}}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model"}}}}}}},"/institution_trees/{id}":{"get":{"tags":["institutions"],"summary":"Get partial institution tree with given institution as root.","description":"An institution tree is a set of institutions that form a hierarchy, navigable by the parent_id attribute.","operationId":"c3e8c642_getInstitutionTree","parameters":[{"name":"id","in":"path","description":"Root institution ID","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstitutionTreeDtoBuilder"}}}},"404":{"description":"Institution not found"},"413":{"description":"Tree too large. i.e. Any parent with greater than 150 children"}}}},"/institution_trees":{"get":{"tags":["institutions"],"summary":"Get complete institution trees.","description":"An institution tree is a set of institutions that form a hierarchy, navigable by the parent_id attribute, eg. Cambridge University -> University of Cambridge Pembroke College etc. The id field within the response indicates the root institution_id","operationId":"c3e8c642_getInstitutionTrees","parameters":[{"name":"institution_id","in":"query","description":"Institution node within tree","required":true,"style":"form","explode":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstitutionTreeDto"}}}},"413":{"description":"Tree too large. i.e. Any parent with greater than 150 children"}}}},"/institutions/{id}":{"get":{"tags":["institutions"],"summary":"Get institution by id","description":"Retrieve institution matching with the given institution uuid","operationId":"c3e8c642_getInstitution","parameters":[{"name":"id","in":"path","description":"Institution ID","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Found institution","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstitutionDtoBuilder"}}}},"400":{"description":"Invalid request"},"404":{"description":"Institution not found"}}}},"/institutions":{"get":{"tags":["institutions"],"summary":"Get institutions","description":"Retrieve institutions matching with the given hint, email or name","operationId":"c3e8c642_getInstitutions","parameters":[{"name":"hint","in":"query","description":"Part of institution name","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"email","in":"query","description":"Email address","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Max results to return (up to 100)","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int32","default":10}},{"name":"name","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"city","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"state","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"country","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Found institutions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstitutionDtoBuilder"}}}},"400":{"description":"Hint missing"}}}}},"components":{"schemas":{"FileMetadata":{"type":"object","properties":{"id":{"type":"string"},"checksum":{"type":"string"},"filename":{"type":"string"},"content_type":{"type":"string"},"last_modified":{"type":"string","format":"date-time"},"content_length":{"type":"integer","format":"int64"},"access_control":{"type":"string"}}},"ContentDisposition":{"type":"object","properties":{"type":{"type":"string"},"parameters":{"type":"object","additionalProperties":{"type":"string"}},"fileName":{"type":"string"},"creationDate":{"type":"string","format":"date-time"},"modificationDate":{"type":"string","format":"date-time"},"readDate":{"type":"string","format":"date-time"},"size":{"type":"integer","format":"int64"}}},"TransferRequest":{"required":["filename","mimetype","size","url"],"type":"object","properties":{"filename":{"type":"string"},"url":{"type":"string"},"mimetype":{"type":"string"},"size":{"type":"integer","format":"int64"},"access_restriction_level":{"type":"string"}}},"RootResourceResponse":{"type":"object","properties":{"workspaces":{"$ref":"#/components/schemas/SwaggerRefDescriptionProperty"},"templates":{"$ref":"#/components/schemas/SwaggerRefDescriptionProperty"}}},"SwaggerRefDescriptionProperty":{"type":"object","properties":{"description":{"type":"string"},"$ref":{"type":"string"}}},"EnumeratorResourceResponse":{"type":"object","properties":{"token":{"type":"string"},"description":{"type":"string"}}},"EnumeratorsResourceResponse":{"type":"object","properties":{"permissions":{"$ref":"#/components/schemas/SwaggerRefDescriptionProperty"},"content_types":{"$ref":"#/components/schemas/SwaggerRefDescriptionProperty"},"workspace_types":{"$ref":"#/components/schemas/SwaggerRefDescriptionProperty"},"event_operation_types":{"$ref":"#/components/schemas/SwaggerRefDescriptionProperty"},"event_entity_types":{"$ref":"#/components/schemas/SwaggerRefDescriptionProperty"},"actor_types":{"$ref":"#/components/schemas/SwaggerRefDescriptionProperty"},"owner_types":{"$ref":"#/components/schemas/SwaggerRefDescriptionProperty"}}},"MyResourceResponse":{"type":"object","properties":{"entitlements":{"$ref":"#/components/schemas/SwaggerRefDescriptionProperty"}}},"MyEntitlementsResourceResponse":{"type":"object","properties":{"can_create_workspaces":{"type":"boolean"},"has_workspace_memberships":{"type":"boolean"}}},"TemplatesResourceResponse":{"type":"object","properties":{"workspaces":{"$ref":"#/components/schemas/SwaggerRefDescriptionProperty"},"containers":{"$ref":"#/components/schemas/SwaggerRefDescriptionProperty"}}},"SwaggerRefProperty":{"type":"object","properties":{"$ref":{"type":"string"}}},"TemplateContainerResourceResponse":{"type":"object","properties":{"$ref":{"type":"string"},"id":{"type":"string"},"owner_type":{"type":"string"},"owner_id":{"type":"string"},"name":{"type":"string"},"created_by":{"$ref":"#/components/schemas/SwaggerRefProperty"},"created_on":{"type":"string"},"modified_by":{"$ref":"#/components/schemas/SwaggerRefProperty"},"modified_on":{"type":"string"},"$etag":{"type":"string"}}},"AddTemplateContainerRequest":{"required":["name"],"type":"object","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"},"name":{"type":"string"},"state":{"type":"string"},"owner_id":{"type":"string"},"owner_type":{"type":"string"}},"additionalProperties":{"type":"object"}},"DynamicRequest":{"type":"object","properties":{"parent":{"$ref":"#/components/schemas/DynamicRequest"}}},"AllowedTypeResourceResponse":{"type":"object","properties":{"$ref":{"type":"string"},"content_type":{"type":"string"}}},"AddAllowedTypeRequest":{"required":["content_type"],"type":"object","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"},"content_type":{"type":"string"}},"additionalProperties":{"type":"object"}},"PropertyResponse":{"type":"object","properties":{"property_name":{"type":"object"}}},"DynamicRequestBean":{"type":"object","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"}},"additionalProperties":{"type":"object"}},"TemplateWorkspaceResourceResponse":{"type":"object","properties":{"id":{"type":"string"},"$ref":{"type":"string"},"owner_type":{"type":"string"},"owner_id":{"type":"string"},"title":{"type":"string"},"description":{"type":"string"},"created_by":{"$ref":"#/components/schemas/SwaggerRefProperty"},"created_on":{"type":"string"},"modified_by":{"$ref":"#/components/schemas/SwaggerRefProperty"},"modified_on":{"type":"string"},"$etag":{"type":"string"}}},"AddTemplateWorkspaceRequest":{"required":["title","type"],"type":"object","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"},"title":{"type":"string"},"owner_id":{"type":"string"},"owner_type":{"type":"string"},"type":{"type":"string"},"description":{"type":"string"}},"additionalProperties":{"type":"object"}},"TemplateWorkspaceContainerResourceResponse":{"type":"object","properties":{"id":{"type":"string"},"$ref":{"type":"string"},"$link":{"type":"string"}}},"AddTemplateWorkspaceContainerLinkRequest":{"required":["$link"],"type":"object","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"},"$link":{"type":"string"},"link_order":{"type":"integer","format":"int64"}},"additionalProperties":{"type":"object"}},"WorkspaceMetadatasTemplatesResourceResponse":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"content_type":{"type":"string"},"media_top_level_type":{"type":"string"},"media_sub_type":{"type":"string"},"$link":{"type":"string"},"$ref":{"type":"string"}}},"AddTemplateWorkspaceMetadataTemplateRequest":{"required":["$link","content_type","media_sub_type","media_top_level_type"],"type":"object","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"},"$link":{"type":"string"},"content_type":{"type":"string"},"media_top_level_type":{"type":"string"},"media_sub_type":{"type":"string"}},"additionalProperties":{"type":"object"}},"WorkspaceRoleResourceResponse":{"type":"object","properties":{"$ref":{"type":"string"},"id":{"type":"string"},"title":{"type":"string"},"members":{"$ref":"#/components/schemas/SwaggerRefProperty"},"permissions":{"$ref":"#/components/schemas/SwaggerRefProperty"},"created_by":{"$ref":"#/components/schemas/SwaggerRefProperty"},"created_on":{"type":"string"},"modified_by":{"$ref":"#/components/schemas/SwaggerRefProperty"},"modified_on":{"type":"string"}}},"AddWorkspaceRoleRequest":{"required":["title"],"type":"object","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"},"title":{"type":"string"}},"additionalProperties":{"type":"object"}},"TemplateWorkspaceRolePermissionResourceResponse":{"type":"object","properties":{"$ref":{"type":"string"},"id":{"type":"string"},"permission":{"type":"string"}}},"AddTemplateWorkspaceRolePermissionRequest":{"type":"object","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"},"permission":{"type":"string"}},"additionalProperties":{"type":"object"}},"WorkspaceResourceResponse":{"type":"object","properties":{"id":{"type":"string"},"$ref":{"type":"string"},"customer_id":{"type":"string"},"type":{"type":"string"},"title":{"type":"string"},"description":{"type":"string"},"containers":{"$ref":"#/components/schemas/SwaggerRefProperty"},"metadatas":{"$ref":"#/components/schemas/SwaggerRefProperty"},"members":{"$ref":"#/components/schemas/SwaggerRefProperty"},"members_count":{"type":"integer","format":"int32"},"events":{"$ref":"#/components/schemas/SwaggerRefProperty"},"last_activity_on":{"type":"string"},"created_by":{"$ref":"#/components/schemas/SwaggerRefProperty"},"created_on":{"type":"string"},"modified_by":{"$ref":"#/components/schemas/SwaggerRefProperty"},"modified_on":{"type":"string"},"from_template":{"$ref":"#/components/schemas/SwaggerRefProperty"},"$etag":{"type":"string"}}},"AddContentsRequest":{"type":"object","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"},"content":{"$ref":"#/components/schemas/RequestRefProperty"}},"additionalProperties":{"type":"object"}},"AddWorkspaceContainerRequest":{"required":["name"],"type":"object","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"},"name":{"type":"string"},"state":{"type":"string"},"order":{"type":"integer","format":"int64"},"from_template":{"$ref":"#/components/schemas/RequestRefProperty"},"contents":{"type":"array","items":{"$ref":"#/components/schemas/AddContentsRequest"}},"allowed_types":{"type":"array","items":{"$ref":"#/components/schemas/AddAllowedTypeRequest"}}},"additionalProperties":{"type":"object"}},"AddWorkspaceMetadataTemplateRequest":{"required":["$link","content_type","media_sub_type","media_top_level_type"],"type":"object","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"},"$link":{"type":"string"},"content_type":{"type":"string"},"media_top_level_type":{"type":"string"},"media_sub_type":{"type":"string"}},"additionalProperties":{"type":"object"}},"AddWorkspaceRequest":{"required":["title","type"],"type":"object","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"},"title":{"type":"string"},"description":{"type":"string"},"type":{"type":"string"},"from_template":{"$ref":"#/components/schemas/RequestRefProperty"},"pure_project_id":{"type":"string"},"containers":{"type":"array","items":{"$ref":"#/components/schemas/AddWorkspaceContainerRequest"}},"metadatas":{"type":"array","items":{"$ref":"#/components/schemas/AddWorkspaceMetadataTemplateRequest"}},"roles":{"type":"array","items":{"required":["title"],"type":"array","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"},"title":{"type":"string"},"permissions":{"type":"array","items":{"$ref":"#/components/schemas/AddWorkspaceRolePermissionRequest"}},"members":{"type":"array","items":{"$ref":"#/components/schemas/AddWorkspaceRoleMemberRequest"}}},"items":{"type":"object"}}},"contents":{"type":"array","items":{"$ref":"#/components/schemas/AddContentsRequest"}}},"additionalProperties":{"type":"object"}},"AddWorkspaceRoleMemberRequest":{"type":"object","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"},"actor":{"$ref":"#/components/schemas/RequestRefProperty"}},"additionalProperties":{"type":"object"}},"AddWorkspaceRolePermissionRequest":{"type":"object","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"},"permission":{"type":"string"},"container":{"$ref":"#/components/schemas/RequestRefProperty"},"collection":{"$ref":"#/components/schemas/RequestRefProperty"}},"additionalProperties":{"type":"object"}},"AddWorkspaceRoleWithMembersAndPermissions":{"required":["title"],"type":"array","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"},"title":{"type":"string"},"permissions":{"type":"array","items":{"$ref":"#/components/schemas/AddWorkspaceRolePermissionRequest"}},"members":{"type":"array","items":{"$ref":"#/components/schemas/AddWorkspaceRoleMemberRequest"}}},"items":{"type":"object"}},"RequestRefProperty":{"required":["$ref"],"type":"object","properties":{"$ref":{"type":"string"}}},"WorkspaceContainerResourceResponse":{"type":"object","properties":{"$ref":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"link_order":{"type":"string"},"allowed_types":{"$ref":"#/components/schemas/SwaggerRefProperty"},"has_allowed_types":{"type":"string"},"created_by":{"$ref":"#/components/schemas/SwaggerRefProperty"},"created_on":{"type":"string"},"modified_by":{"$ref":"#/components/schemas/SwaggerRefProperty"},"modified_on":{"type":"string"},"from_template":{"$ref":"#/components/schemas/SwaggerRefProperty"},"$etag":{"type":"string"}}},"WorkspaceContainerContentResourceResponse":{"type":"object","properties":{"$ref":{"type":"string"},"id":{"type":"string"},"content_type":{"type":"string"},"origin_type":{"type":"string"},"origin_id":{"type":"string"},"info":{"type":"string"},"added_by":{"$ref":"#/components/schemas/SwaggerRefProperty"},"added_on":{"type":"string"},"containers":{"$ref":"#/components/schemas/SwaggerRefProperty"}}},"WorkspaceEventResponse":{"type":"object","properties":{"$ref":{"type":"string"},"workspace":{"$ref":"#/components/schemas/SwaggerRefProperty"},"user_profile":{"$ref":"#/components/schemas/SwaggerRefProperty"},"customer_id":{"$ref":"#/components/schemas/SwaggerRefProperty"},"created_on":{"type":"string"},"action":{"type":"string"},"entity":{"type":"string"},"details":{"type":"object"},"order":{"type":"string"}}},"WorkspaceInviteeResponse":{"type":"object","properties":{"$ref":{"type":"string"},"email":{"type":"string"},"status":{"type":"string"},"workspace":{"$ref":"#/components/schemas/SwaggerRefProperty"}}},"AddWorkspaceInviteeRequest":{"required":["email"],"type":"array","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"},"email":{"type":"string"}},"items":{"type":"object"}},"UpdateWorkspaceInviteeStatusRequest":{"type":"object","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"},"status":{"type":"string"}},"additionalProperties":{"type":"object"}},"WorkspaceMemberResponse":{"type":"object","properties":{"id":{"type":"string"},"$ref":{"type":"string"},"actor":{"$ref":"#/components/schemas/SwaggerRefProperty"},"actor_type":{"type":"string"},"permissions":{"$ref":"#/components/schemas/SwaggerRefProperty"},"roles":{"$ref":"#/components/schemas/SwaggerRefProperty"}}},"WorkspaceMemberRolesResponse":{"type":"object","properties":{"actor":{"$ref":"#/components/schemas/SwaggerRefProperty"},"actor_type":{"type":"string"},"roles":{"type":"string"}}},"AddWorkspaceMemberRequest":{"type":"object","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"},"actor":{"$ref":"#/components/schemas/RequestRefProperty"},"roles":{"type":"array","items":{"$ref":"#/components/schemas/RequestRefProperty"}}},"additionalProperties":{"type":"object"}},"WorkspaceMemberRoleResponse":{"type":"object","properties":{"id":{"type":"string"},"role":{"type":"string"},"$ref":{"type":"string"}}},"WorkspaceRoleMemberResourceResponse":{"type":"object","properties":{"$ref":{"type":"string"},"id":{"type":"string"},"actor":{"$ref":"#/components/schemas/SwaggerRefProperty"},"actor_type":{"type":"string"}}},"WorkspaceRolePermissionResourceResponse":{"type":"object","properties":{"$ref":{"type":"string"},"id":{"type":"string"},"permission":{"type":"string"},"container":{"$ref":"#/components/schemas/SwaggerRefProperty"},"collection":{"$ref":"#/components/schemas/SwaggerRefProperty"}}},"Model":{"type":"object","properties":{"id":{"type":"string"}}},"CreateCollectionRequest":{"required":["categories","contributors","id","institutions","name"],"type":"object","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"},"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"categories":{"type":"array","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"}},"items":{"type":"object"}},"contributors":{"type":"array","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"}},"items":{"type":"object"}},"institutions":{"type":"array","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"}},"items":{"type":"object"}}},"additionalProperties":{"type":"object"}},"OneOrMoreRequestRefProperty":{"type":"array","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"}},"items":{"type":"object"}},"CreateCollectionContentRequest":{"required":["id"],"type":"object","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"},"id":{"type":"string"}},"additionalProperties":{"type":"object"}},"PublishCollectionRequest":{"required":["id"],"type":"object","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"},"id":{"type":"string"}},"additionalProperties":{"type":"object"}},"CreateDraftDatasetRequest":{"required":["name"],"type":"object","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"},"name":{"type":"string"},"description":{"type":"string"},"method":{"type":"string"},"is_confidential":{"type":"boolean"}},"additionalProperties":{"type":"object"}},"ArticleJournal":{"required":["issn","name"],"type":"object","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"},"issn":{"type":"string"},"name":{"type":"string"}},"additionalProperties":{"type":"object"}},"ArticleRequest":{"required":["doi","title"],"type":"object","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"},"doi":{"type":"string"},"title":{"type":"string"},"pii":{"type":"string"},"journal":{"required":["issn","name"],"type":"object","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"},"issn":{"type":"string"},"name":{"type":"string"}},"additionalProperties":{"type":"object"}}},"additionalProperties":{"type":"object"}},"CategoryRequest":{"required":["id","label"],"type":"object","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"},"id":{"type":"string"},"label":{"type":"string"}},"additionalProperties":{"type":"object"}},"SwaggerRefIdProperty":{"type":"object","properties":{"$ref":{"type":"string"},"id":{"type":"string"}}},"ContributorRequest":{"required":["contribution","first_name","institution","last_name","orcid_id","permission"],"type":"object","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"},"first_name":{"type":"string"},"last_name":{"type":"string"},"email":{"type":"string"},"contribution":{"type":"string"},"institution":{"type":"string"},"institution_id":{"type":"string"},"permission":{"type":"string"},"order":{"type":"integer","format":"int64"},"orcid_id":{"type":"string"},"profile":{"required":["$ref"],"type":"object","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"},"$ref":{"type":"string"}},"additionalProperties":{"type":"object"}}},"additionalProperties":{"type":"object"}},"Profile":{"required":["$ref"],"type":"object","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"},"$ref":{"type":"string"}},"additionalProperties":{"type":"object"}},"DraftDatasetEventsResource":{"type":"object"},"FileRequest":{"required":["description","filename","media_type","ticket_id"],"type":"object","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"},"size":{"type":"integer","format":"int64"},"ticket_id":{"type":"string"},"filename":{"type":"string"},"description":{"type":"string"},"parent_folder":{"$ref":"#/components/schemas/RefRequest"},"media_type":{"type":"string"}},"additionalProperties":{"type":"object"}},"RefRequest":{"type":"object","properties":{"$ref":{"type":"string"}}},"DraftDatasetPropertyResourceResponse":{"type":"object","properties":{"property_name":{"type":"string"}}},"UpdateFileRequest":{"required":["description","filename"],"type":"object","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"},"filename":{"type":"string"},"description":{"type":"string"},"parent_folder":{"$ref":"#/components/schemas/RefRequest"}},"additionalProperties":{"type":"object"}},"CreateDraftDatasetFolderRequest":{"required":["name"],"type":"object","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"},"name":{"type":"string"},"parent_folder":{"$ref":"#/components/schemas/RefRequest"}},"additionalProperties":{"type":"object"}},"FolderTreeRequest":{"required":["tree"],"type":"object","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"},"tree":{"type":"array","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"}},"items":{"type":"object"}}},"additionalProperties":{"type":"object"}},"FunderRequest":{"required":["grant_id","identity","location","name"],"type":"object","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"},"grant_id":{"type":"string"},"identity":{"type":"string"},"name":{"type":"string"},"location":{"type":"string"}},"additionalProperties":{"type":"object"}},"InstitutionRequest":{"required":["$link"],"type":"object","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"},"$link":{"type":"string"}},"additionalProperties":{"type":"object"}},"OrgUnitRequest":{"required":["$ref"],"type":"array","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"},"$ref":{"type":"string"}},"items":{"type":"object"}},"PublishDatasetRequest":{"type":"object","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"},"$ref":{"type":"string"},"details":{"type":"object","additionalProperties":{"type":"object"}}},"additionalProperties":{"type":"object"}},"RelatedLinkRequest":{"required":["href","relation_type","source_type"],"type":"object","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"},"relation_type":{"type":"string"},"source_type":{"type":"string"},"href":{"type":"string"}},"additionalProperties":{"type":"object"}},"CreateLicenceRequest":{"required":["category","customer_id","description","full_name","short_name","url"],"type":"object","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"},"short_name":{"type":"string"},"full_name":{"type":"string"},"description":{"type":"string"},"url":{"type":"string"},"category":{"type":"string"},"customer_id":{"type":"string"}},"additionalProperties":{"type":"object"}},"FeaturedSection":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"title":{"type":"string"},"status":{"type":"string","enum":["PRIVATE","PUBLIC"]},"layout":{"type":"string","enum":["CARD","TITLE"]},"created_by":{"type":"string"},"created_on":{"type":"string","format":"date-time"},"modified_by":{"type":"string"},"modified_on":{"type":"string","format":"date-time"},"etag":{"type":"string"},"contents":{"type":"array","items":{"$ref":"#/components/schemas/FeaturedSectionContent"}}}},"FeaturedSectionContent":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"modified_on":{"type":"string","format":"date-time"},"created_on":{"type":"string","format":"date-time"},"owner":{"$ref":"#/components/schemas/Owner"}}},"Owner":{"type":"object","properties":{"id":{"type":"string"},"display_name":{"type":"string"}}},"AddFeaturedSectionRequest":{"required":["title"],"type":"object","properties":{"title":{"maxLength":255,"minLength":0,"type":"string"}}},"AddFeaturedSectionContentRequest":{"required":["id"],"type":"object","properties":{"id":{"maxLength":36,"minLength":0,"type":"string"}}},"UpdatePropertyRequest":{"type":"object"},"ConfidentialDatasetsAccessRequest":{"required":["dataset_version","request_reason","requestor_email","requestor_name"],"type":"object","properties":{"requestor_email":{"type":"string"},"requestor_name":{"type":"string"},"request_reason":{"maxLength":500,"minLength":0,"type":"string"},"dataset_version":{"type":"integer","format":"int64"},"g_recaptcha_token":{"type":"string"}},"description":"The confidential dataset request access object"},"ArticleDTO":{"type":"object","properties":{"doi":{"type":"string"},"id":{"type":"string"},"title":{"type":"string"},"journal":{"$ref":"#/components/schemas/JournalDTO"}}},"CategoryDTO":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"}}},"ContentDetailsDTO":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"sha256_hash":{"type":"string"},"content_type":{"type":"string"},"size":{"type":"integer","format":"int64"},"created_date":{"type":"string","format":"date-time"},"download_url":{"type":"string","format":"uri"},"view_url":{"type":"string","format":"uri"},"download_expiry_time":{"type":"string","format":"date-time"}}},"ContributorDTO":{"type":"object","properties":{"institution":{"$ref":"#/components/schemas/InstitutionDTO"},"contribution":{"type":"string"},"profile_id":{"type":"string","format":"uuid"},"first_name":{"type":"string"},"last_name":{"type":"string"},"orcid_id":{"type":"string"}}},"DataLicenceDTO":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"description":{"type":"string"},"url":{"type":"string"},"category":{"type":"string"},"short_name":{"type":"string"},"full_name":{"type":"string"}}},"DatasetMetadataDTO":{"type":"object","properties":{"id":{"type":"string"},"doi":{"$ref":"#/components/schemas/DoiDTO"},"name":{"type":"string"},"description":{"type":"string"},"version":{"type":"integer","format":"int64"},"contributors":{"type":"array","items":{"$ref":"#/components/schemas/ContributorDTO"}},"files":{"type":"array","items":{"$ref":"#/components/schemas/FileMetadataDTO"}},"versions":{"type":"array","items":{"$ref":"#/components/schemas/VersionMetadataDTO"}},"articles":{"type":"array","items":{"$ref":"#/components/schemas/ArticleDTO"}},"categories":{"type":"array","items":{"$ref":"#/components/schemas/CategoryDTO"}},"institutions":{"type":"array","items":{"$ref":"#/components/schemas/InstitutionDTO"}},"metrics":{"$ref":"#/components/schemas/DatasetMetricsDTO"},"available":{"type":"boolean"},"method":{"type":"string"},"size":{"type":"integer","format":"int64"},"owner":{"$ref":"#/components/schemas/PersonDTO"},"channel":{"type":"string","description":"Channel the dataset originated from","enum":["WEB","EM","SSRN","EVISE","EES"]},"owner_id":{"type":"string","format":"uuid"},"publish_date":{"type":"string","format":"date-time"},"data_licence":{"$ref":"#/components/schemas/DataLicenceDTO"},"embargo_date":{"type":"string","format":"date-time"},"related_links":{"type":"array","items":{"$ref":"#/components/schemas/RelatedLinkDTO"}},"funders":{"type":"array","items":{"$ref":"#/components/schemas/FunderDTO"}},"customer_id":{"type":"string","format":"uuid"},"modified_on":{"type":"string","format":"date-time"},"confidential":{"type":"boolean"},"confidentiality_policy_id":{"type":"string"},"links":{"type":"object","additionalProperties":{"type":"string"}},"repository":{"$ref":"#/components/schemas/RepositoryDTO"}}},"DatasetMetricsDTO":{"type":"object","properties":{"views":{"type":"integer","format":"int64"},"file_downloads":{"type":"integer","format":"int64"},"file_previews":{"type":"integer","format":"int64"}}},"DoiDTO":{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["reserved","requested","allocated"]},"prefix":{"type":"string"}}},"FileMetadataDTO":{"type":"object","properties":{"filename":{"type":"string"},"id":{"type":"string","format":"uuid"},"description":{"type":"string"},"folder_id":{"type":"string","format":"uuid"},"content_details":{"$ref":"#/components/schemas/ContentDetailsDTO"},"metrics":{"$ref":"#/components/schemas/FileMetricsDTO"},"size":{"type":"integer","format":"int64"},"last_modified_date":{"type":"string","format":"date-time"},"status":{"type":"string"}}},"FileMetricsDTO":{"type":"object","properties":{"downloads":{"type":"integer","format":"int32"},"previews":{"type":"integer","format":"int32"},"fileId":{"type":"string"}}},"Filters":{"type":"object","properties":{"type":{"type":"object"}}},"FunderDTO":{"type":"object","properties":{"identity":{"type":"string"},"grant_id":{"type":"string"},"name":{"type":"string"},"location":{"type":"string"}}},"InstitutionDTO":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"ror_id":{"type":"string"}}},"JournalDTO":{"type":"object","properties":{"issn":{"type":"string"},"name":{"type":"string"},"url":{"type":"string"}}},"PersonDTO":{"type":"object","properties":{"institution":{"$ref":"#/components/schemas/InstitutionDTO"},"profile_id":{"type":"string","format":"uuid"},"first_name":{"type":"string"},"last_name":{"type":"string"},"orcid_id":{"type":"string"}}},"PublicDatasetsWithSummaryDTO":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/DatasetMetadataDTO"}},"filters":{"$ref":"#/components/schemas/Filters"}}},"RelatedLinkDTO":{"type":"object","properties":{"type":{"type":"string"},"rel":{"type":"string"},"href":{"type":"string"}}},"RepositoryDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}}},"VersionMetadataDTO":{"type":"object","properties":{"version":{"type":"integer","format":"int64"},"available":{"type":"boolean"},"publish_date":{"type":"string","format":"date-time"},"embargo_date":{"type":"string","format":"date-time"}}},"UUIDParam":{"type":"object"},"FileTypeParam":{"type":"object"},"FolderDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"parent_id":{"type":"string"},"created_date":{"type":"string","format":"date-time"}}},"DatasetFileMetrics":{"type":"object","properties":{"file_id":{"type":"string"},"file_views":{"type":"integer","format":"int64"},"file_downloads":{"type":"integer","format":"int64"}}},"DatasetMetrics":{"type":"object","properties":{"dataset_id":{"type":"string"},"dataset_views":{"type":"integer","format":"int64"},"dataset_file_views":{"type":"integer","format":"int64"},"dataset_file_downloads":{"type":"integer","format":"int64"},"file_metrics":{"type":"array","items":{"$ref":"#/components/schemas/DatasetFileMetrics"}}}},"EntityProperty":{"type":"object","properties":{"$ref":{"type":"string"},"type":{"type":"string"},"name":{"type":"string"}}},"ModerationActionsProperty":{"type":"object","properties":{"$ref":{"type":"string"},"method":{"type":"string"},"body":{"type":"string"}}},"EntityApprovalRequest":{"required":["$ref"],"type":"object","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"},"$ref":{"type":"string"}},"additionalProperties":{"type":"object"}},"CommentRequest":{"required":["comment"],"type":"object","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"},"comment":{"type":"string"},"importance":{"type":"string"}},"additionalProperties":{"type":"object"}},"AddEntityRequest":{"required":["$ref"],"type":"object","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"},"$ref":{"type":"string"},"moderation_state":{"type":"string"}},"additionalProperties":{"type":"object"}},"EntityRejectionRequest":{"required":["$ref","rejection_reason"],"type":"object","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"},"$ref":{"type":"string"},"rejection_reason":{"type":"string"}},"additionalProperties":{"type":"object"}},"AdminActionsProperty":{"type":"object","properties":{"$ref":{"type":"string"},"method":{"type":"string"},"body":{"type":"string"}}},"PublicDatasetPropertyResourceResponse":{"type":"object","properties":{"property_name":{"type":"string"}}},"RemoveDatasetRequest":{"required":["removal_action","removal_reason"],"type":"object","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"},"removal_reason":{"type":"string"},"removal_action":{"type":"string"},"$ref":{"type":"string"}},"additionalProperties":{"type":"object"}},"ProfileResourceResponse":{"type":"object","properties":{"id":{"type":"string"},"link":{"type":"string"},"display_name":{"type":"string"},"photo":{"type":"string"}}},"RoleMemberRequest":{"required":["email"],"type":"object","properties":{"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/DynamicRequest"}},"parent":{"$ref":"#/components/schemas/DynamicRequest"},"empty":{"type":"boolean"},"email":{"type":"string"}},"additionalProperties":{"type":"object"}},"InstitutionTreeDtoBuilder":{"type":"object"},"AlternativeNameDto":{"required":["name"],"type":"object","properties":{"name":{"type":"string"}}},"InstitutionDto":{"type":"object","properties":{"scival_id":{"type":"integer","format":"int64"},"ror_id":{"type":"string"},"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"country":{"type":"string"},"parent_id":{"type":"string","format":"uuid"},"urls":{"type":"array","items":{"type":"string"}},"profile_url":{"type":"string"},"alt_names":{"type":"array","items":{"$ref":"#/components/schemas/AlternativeNameDto"}}}},"InstitutionTreeDto":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"institution_nodes":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/InstitutionDto"}}}},"InstitutionDtoBuilder":{"type":"object"}},"securitySchemes":{"OAuth2":{"type":"oauth2","description":"OpenID Connect (OAuth2) used for authorization of requests to the API, see [Authentication](/#section/Authentication) for more details. \n\nThe [OpenId Connect Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html) endpoint can be found at https://auth.data.mendeley.com/.well-known/openid-configuration\n","flows":{"clientCredentials":{"tokenUrl":"https://auth.data.mendeley.com/oauth/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth.data.mendeley.com/oauth2/authorize","tokenUrl":"https://auth.data.mendeley.com/oauth2/token","refreshUrl":"https://auth.data.mendeley.com/oauth2/token","scopes":{"openid":"OpenID Connect scope","email":"OpenID Connect scope","profile":"OpenID Connect scope","dcd:profile":"Grants access to most operations providing additional user profile information"}}}}}},"x-tagGroups":[{"name":"Datasets","tags":["draft-datasets","public-datasets","files","licences","oai-pmh"]},{"name":"Collections","tags":["draft-collections","public-collections"]},{"name":"Projects","tags":["workspaces","templates"]},{"name":"Search","tags":["search"]},{"name":"Institutional Repository","tags":["audit-log","dataset-management","featured-sections","metrics","moderation","user-management"]},{"name":"Institutions","tags":["institutions"]}],"x-md-primary":true},"user":{"customer":null,"idToken":null}}</script><script src="app.js?d2057de55211601232da" data-ot-ignore></script></body></html>