Sword API - Revision history

Sallain at 22:27, 11 February 2020

2020-02-11T22:27:27Z

Hbecker: Move to feature requirements category

2017-03-23T19:41:47Z

Move to feature requirements category

Hbecker: /* Single step deposit */ Fix space vs location

2016-07-15T23:21:27Z

Single step deposit: Fix space vs location

Hbecker: /* Example session */ Fix space vs location and location vs file

2016-07-15T23:21:03Z

Example session: Fix space vs location and location vs file

Evelyn: /* Overview */

2014-10-14T18:14:53Z

Overview

Mcantelon: /* Create a new transfer */

2014-03-20T22:34:30Z

Create a new transfer

Mcantelon: /* Synchronous Deposit Examples */

2014-01-27T23:04:06Z

Synchronous Deposit Examples

Mcantelon: /* EM-IRI */

2014-01-27T23:02:53Z

EM-IRI

Mcantelon: /* Example session */

2014-01-27T23:00:12Z

Example session

Courtney at 18:38, 27 January 2014

2014-01-27T18:38:38Z

← Older revision		Revision as of 22:27, 11 February 2020
Line 1:		Line 1:
	[[Main Page]] > [[Documentation]] > [[Requirements]] > Sword API		[[Main Page]] > [[Documentation]] > [[Requirements]] > Sword API
		+
		+	<div style="padding: 10px 10px; border: 1px solid black; background-color: #F79086;">This page is no longer being maintained and may contain inaccurate information. Please see the [https://www.archivematica.org/docs/latest/ Archivematica documentation] for up-to-date information.</div><p>

	[[Category:Feature requirements]]		[[Category:Feature requirements]]

← Older revision		Revision as of 19:41, 23 March 2017
Line 1:		Line 1:
	[[Main Page]] > [[Documentation]] > [[Requirements]] > Sword API		[[Main Page]] > [[Documentation]] > [[Requirements]] > Sword API
		+
		+	[[Category:Feature requirements]]

	== Overview ==		== Overview ==

@@ Line 74: / Line 74: @@
 If you wanted to deposit a transfer then immediately finalize it, after background downloading is complete, you could use something like the following curl command.
-<pre>curl -v -H "In-Progress: false" --data-binary @mets.xml --request POST http://localhost:8000/api/v1/space/c0bee7c8-3e9b-41e3-8600-ee9b2c475da2/sword/collection/</pre>
+<pre>curl -v -H "In-Progress: false" --data-binary @mets.xml --request POST http://localhost:8000/api/v1/location/c0bee7c8-3e9b-41e3-8600-ee9b2c475da2/sword/collection/</pre>
 == Endpoints ==

@@ Line 42: / Line 42: @@
 <pre># create new deposit, providing a METS file specifying digital object URLs to download in the background
-curl -v -H "In-Progress: true" --data-binary @mets.xml --request POST http://localhost:8000/api/v1/space/c0bee7c8-3e9b-41e3-8600-ee9b2c475da2/sword/collection/
+curl -v -H "In-Progress: true" --data-binary @mets.xml --request POST http://localhost:8000/api/v1/location/c0bee7c8-3e9b-41e3-8600-ee9b2c475da2/sword/collection/
 # response XML includes endpoints for adding additional files, etc.
@@ Line 48: / Line 48: @@
 curl -v -H "Content-Disposition: attachment; filename=cat.jpg" --request POST \
      --data-binary "@cat.jpg" \
-     http://127.0.0.1:8000/api/v1/location/9c8b4ac0-0407-4360-a10d-af6c62a48b69/sword/media/
+     http://127.0.0.1:8000/api/v1/file/9c8b4ac0-0407-4360-a10d-af6c62a48b69/sword/media/
 # start another background download of resources specified in a METS
-curl -v -H "In-Progress: true" -H "Packaging: METS" --data-binary @mets.xml --request POST http://127.0.0.1:8000/api/v1/location/9c8b4ac0-0407-4360-a10d-af6c62a48b69/sword/media/
+curl -v -H "In-Progress: true" -H "Packaging: METS" --data-binary @mets.xml --request POST http://127.0.0.1:8000/api/v1/file/9c8b4ac0-0407-4360-a10d-af6c62a48b69/sword/media/
 # finalize transfer and approve processing
-curl -v -H "In-Progress: false" --request POST http://127.0.0.1:8000/api/v1/location/149cc29d-6472-4bcf-bee8-f8223bf60580/sword/
+curl -v -H "In-Progress: false" --request POST http://127.0.0.1:8000/api/v1/file/149cc29d-6472-4bcf-bee8-f8223bf60580/sword/
 </pre>
 You might, at some point, want to list the transfers that have been started. The following curl command will do so.
-<pre>curl -v http://localhost:8000/api/v1/space/c0bee7c8-3e9b-41e3-8600-ee9b2c475da2/sword/collection/</pre>
+<pre>curl -v http://localhost:8000/api/v1/location/c0bee7c8-3e9b-41e3-8600-ee9b2c475da2/sword/collection/</pre>
 If you're working on a transfer and want to list what files are included in it, the following curl command will list them.
 <pre># list files in transfer
-curl -v http://127.0.0.1:8000/api/v1/location/9c8b4ac0-0407-4360-a10d-af6c62a48b69/sword/media/</pre>
+curl -v http://127.0.0.1:8000/api/v1/file/9c8b4ac0-0407-4360-a10d-af6c62a48b69/sword/media/</pre>
 If you've started a deposit, but want to discard it, you can delete the deposit. The following curl command shows an example.
-<pre>curl -v -XDELETE http://127.0.0.1:8000/api/v1/location/149cc29d-6472-4bcf-bee8-f8223bf60580/sword/</pre>
+<pre>curl -v -XDELETE http://127.0.0.1:8000/api/v1/file/149cc29d-6472-4bcf-bee8-f8223bf60580/sword/</pre>
 == Single step deposit ==

@@ Line 3: / Line 3: @@
 == Overview ==
-One of the 1.1 release features is a sponsored project to integrate Archivematica with Islandora.  This integration will be accomplished by creating a [http://swordapp.org Sword] 2.0 API for the Archivematica [https://www.archivematica.org/wiki/Administrator_manual_1.0#Storage_service storage service].  Islandora development work will add functionality to Islandora to use this API to deposit digital objects into Archviematica.
+One of the 1.1 release features is a sponsored project to integrate Archivematica with Islandora.  This integration will be accomplished by creating a [http://swordapp.org SWORD] 2.0 API for the Archivematica [https://www.archivematica.org/wiki/Administrator_manual_1.0#Storage_service storage service].  Islandora development work will add functionality to Islandora to use this API to deposit digital objects into Archviematica.
 As described [[Overview|elsewhere]] on this wiki, ''"the primary function of Archivematica is to process digital transfers (accessioned digital objects), turn them into SIPs, apply format policies and create high-quality, repository-independent Archival Information Packages (AIP)"''.

@@ Line 188: / Line 188: @@
                  <METS:file ID="OBJ.0">
                      <METS:FLocat xlink:title="Cinderella_(1865).pdf" LOCTYPE="URL"
                        xlink:href="http://localhost:8080/fedora/get/islandora:72/OBJ/2013-08-12T14:46:43.454Z" />
                  </METS:file>

@@ Line 288: / Line 288: @@
 * example: /api/v1/location/[deposit location UUID]/sword/media/
-An HTTP POST to the em-iri for a transfer should include a file as the body
+An HTTP POST to the em-iri for a transfer should include a single file as the body. If the HTTP "Packaging" header is set to "METS" then METS XML can be sent as the body, specifying a list of digital object URLs to download in the background.
 An HTTP GET should return a list of files in the transfer

← Older revision		Revision as of 18:38, 27 January 2014
Line 1:		Line 1:
		+	[[Main Page]] > [[Documentation]] > [[Requirements]] > Sword API

	== Overview ==		== Overview ==