Storage Service API - Revision history

Dcerna: /* Update space endpoint */

2024-03-05T22:33:08Z

Update space endpoint

2021-05-25T09:33:03Z

2020-07-30T17:57:02Z

Download single file

2020-07-30T17:56:05Z

Download single file

2020-07-30T17:55:30Z

Download single file

2019-07-15T22:17:54Z

AIP storage callback request

2019-06-17T22:06:31Z

Move Package

2019-06-17T22:05:52Z

2019-06-17T22:05:30Z

2019-02-05T13:27:28Z

Create new pipeline: formatting correction

@@ Line 298: / Line 298: @@
 === Create space ===
-See [https://github.com/archivematica/Issues/issues/36 Issue 36].
+* '''URL''': <code>/api/v2/space</code>
 * '''Verb''': POST
 * '''Parameters''': JSON body
-** Should contain fields for a new space: See the [https://www.archivematica.org/en/docs/storage-service-0.11/administrators/#id2 Storage Service Documentation] or [https://wiki.archivematica.org/Storage_Service#Space Space] for fields relevant to each type of space. Basic fields for a local file system space are listed below.
+** Should contain fields for a new space: See the [https://www.archivematica.org/en/docs/storage-service-0.21/administrators/#id4 Storage Service Documentation] for fields relevant to each type of space. Basic fields for a local file system space are listed below.
 ** <code>access_protocol</code>: this defines the type of space
 ** <code>path</code>: Absolute path to the Space on the local filesystem

← Older revision		Revision as of 09:33, 25 May 2021
Line 1:		Line 1:
	[[Main Page]] > [[Development]] > Storage Service API		[[Main Page]] > [[Development]] > Storage Service 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/en/docs/archivematica-1.13/dev-manual/ Archivematica documentation] for up-to-date information.</div>

	The [[Storage Service]] API provides programmatic access to moving files around in storage areas that the Storage Service has access to.		The [[Storage Service]] API provides programmatic access to moving files around in storage areas that the Storage Service has access to.

@@ Line 509: / Line 509: @@
 * '''Verb''': GET, HEAD
 * '''Parameters''': Query string parameters
-** <code>relative_path_to_file</code>: Path to the file to download, relative to the location where is stored down to the lowest level.<br />E.g.: <code>test01-36d4efb7-83ba-46bf-a171-8c7b965d9dcb/data/objects/MARBLES.TGA</code>, where <code>test01-36d4efb7-83ba-46bf-a171-8c7b965d9dcb</code> contains both the transfer name and the identifier of the package. [[#Get package details | Get package details]] can provide these (see <code>current_path</code> attribute).
+** <code>relative_path_to_file</code>: Path to the file to download, relative to the location where is stored down to the lowest level.<br />E.g.: <code>test01-36d4efb7-83ba-46bf-a171-8c7b965d9dcb/data/objects/MARBLES.TGA</code>, where <code>test01-36d4efb7-83ba-46bf-a171-8c7b965d9dcb</code> contains both the UUID of the package and the name of the transfer which you can find using [[#Get package details | Get package details]] (see <code>current_path</code> attribute).
 * '''Response''': Stream of the requested file

@@ Line 509: / Line 509: @@
 * '''Verb''': GET, HEAD
 * '''Parameters''': Query string parameters
-** <code>relative_path_to_file</code>: Path to the file to download, relative to the location where is stored down to the lowest level.<br />E.g.: a valid example is <code>test01-36d4efb7-83ba-46bf-a171-8c7b965d9dcb/data/objects/MARBLES.TGA</code>, where <code>test01-36d4efb7-83ba-46bf-a171-8c7b965d9dcb</code> contains both the transfer name and the identifier of the package. [[#Get package details | Get package details]] can provide these (see <code>current_path</code> attribute).
+** <code>relative_path_to_file</code>: Path to the file to download, relative to the location where is stored down to the lowest level.<br />E.g.: <code>test01-36d4efb7-83ba-46bf-a171-8c7b965d9dcb/data/objects/MARBLES.TGA</code>, where <code>test01-36d4efb7-83ba-46bf-a171-8c7b965d9dcb</code> contains both the transfer name and the identifier of the package. [[#Get package details | Get package details]] can provide these (see <code>current_path</code> attribute).
 * '''Response''': Stream of the requested file

@@ Line 509: / Line 509: @@
 * '''Verb''': GET, HEAD
 * '''Parameters''': Query string parameters
-** <code>relative_path_to_file</code>: Path to the file to download, relative to the package path.
+** <code>relative_path_to_file</code>: Path to the file to download, relative to the location where is stored down to the lowest level.<br />E.g.: a valid example is <code>test01-36d4efb7-83ba-46bf-a171-8c7b965d9dcb/data/objects/MARBLES.TGA</code>, where <code>test01-36d4efb7-83ba-46bf-a171-8c7b965d9dcb</code> contains both the transfer name and the identifier of the package. [[#Get package details | Get package details]] can provide these (see <code>current_path</code> attribute).
 * '''Response''': Stream of the requested file

← Older revision		Revision as of 22:17, 15 July 2019
Line 567:		Line 567:

	Request to call any Callbacks configured to run post-storage for this AIP.		Request to call any Callbacks configured to run post-storage for this AIP.
		+
		+	In SS0.15 and above, this endpoint has been extended to support callbacks for AIP, AIC and DIP stored events.
		+
		+
		+	* '''Event''': Post-store AIP, AIC, or DIP
		+	* '''URI''': <code>https://scope.com/api/v1/dip/<package_uuid>/stored</code>
		+	* '''Method''': POST
		+	* '''Headers''':
		+	* - Authorization -> <code>Token <token></code>
		+	* - Origin -> <code>https://ss.com</code>
		+	* '''Expected Status''': 202
		+
		+

	{\| class="wikitable" style="background-color:#ffeecc;" cellpadding="10";		{\| class="wikitable" style="background-color:#ffeecc;" cellpadding="10";

@@ Line 648: / Line 648: @@
 Example:
   $ curl -d 'location_uuid=7c5c48d4-50db-4018-b4b1-7ed29d1ef9d3	' -H"Authorization: ApiKey test:4525fd5272275caeac04a28447698c51" 'http://mysite.archivematica.org:8000/api/v2/file/8b8aa1a2-79c9-490e-b630-28f90bb7e654/move/'
 === SWORD endpoints ===

← Older revision		Revision as of 22:05, 17 June 2019
Line 647:		Line 647:

	Example:		Example:
−	$ curl -d 'location_uuid=7c5c48d4-50db-4018-b4b1-7ed29d1ef9d3 ' -H"Authorization: ApiKey test:4525fd5272275caeac04a28447698c51" 'http://~~am19xenial.qa~~.archivematica.org:8000/api/v2/file/8b8aa1a2-79c9-490e-b630-28f90bb7e654/move/'	+	$ curl -d 'location_uuid=7c5c48d4-50db-4018-b4b1-7ed29d1ef9d3 ' -H"Authorization: ApiKey test:4525fd5272275caeac04a28447698c51" 'http://mysite.archivematica.org:8000/api/v2/file/8b8aa1a2-79c9-490e-b630-28f90bb7e654/move/'

@@ Line 222: / Line 222: @@
 Example:
 $ curl -X POST \
      -H"Authorization: ApiKey test:95141fc645ed97a95893f1f865d24687f89a27ad" \
      -H"Content-Type: application/json" \