-
Notifications
You must be signed in to change notification settings - Fork 3
Expand file tree
/
Copy pathprune-endpoint.html
More file actions
48 lines (46 loc) · 2 KB
/
Copy pathprune-endpoint.html
File metadata and controls
48 lines (46 loc) · 2 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
<!DOCTYPE html>
<html>
<head>
<title>Dataset Project</title>
<link href='https://fonts.googleapis.com/css?family=Open+Sans' rel='stylesheet' type='text/css'>
<link rel="stylesheet" href="https://caltechlibrary.github.io/css/site.css">
</head>
<body>
<header>
<a href="http://library.caltech.edu" title="link to Caltech Library Homepage"><img src="https://caltechlibrary.github.io/assets/liblogo.gif" alt="Caltech Library logo"></a>
</header>
<nav>
<ul>
<li><a href="/">Home</a></li>
<li><a href="../">README</a></li>
<li><a href="../LICENSE">LICENSE</a></li>
<li><a href="../INSTALL.html">INSTALL</a></li>
<li><a href="../user_manual.html">User Manual</a></li>
<li><a href="../about.html">About</a></li>
<li><a href="../search.html">Search</a></li>
<li><a href="https://github.com/caltechlibrary/dataset">GitHub</a></li>
</ul>
</nav>
<section>
<h1 id="prune-end-point">Prune (end point)</h1>
<p>Removes an attached document from a JSON record using
<code><KEY></code> and <code><FILENAME></code>.</p>
<pre><code>`http://localhost:8485/<COLLECTION_ID>/attachment/<KEY>/<SEMVER>/<FILENAME>`</code></pre>
<p>Requires a DELETE method. Returns an HTTP 200 OK on success or an
HTTP error code if not.</p>
<h2 id="example">Example</h2>
<p>In this example <code><COLLECTION_ID></code> is “t1”,
<code><KEY></code> is “one”, and <code><FILENAME></code> is
“a1.png”. Once again our example uses curl.</p>
<pre class="shell"><code> curl -X DELETE http://localhost:8485/t1/attachment/one/a1.png</code></pre>
<p>This will cause the attached file to be removed from the record and
collection.</p>
</section>
<footer>
<span>© 2022 <a href="https://www.library.caltech.edu/copyright">Caltech Library</a></span>
<address>1200 E California Blvd, Mail Code 1-32, Pasadena, CA 91125-3200</address>
<span><a href="mailto:library@caltech.edu">Email Us</a></span>
<span>Phone: <a href="tel:+1-626-395-3405">(626)395-3405</a></span>
</footer>
</body>
</html>