Archivematica API - Revision history

Dcerna: Fix task property name

2023-12-11T16:45:16Z

Fix task property name

2021-05-25T09:32:58Z

2021-03-02T14:41:28Z

Add api prefix to jobs and tasks call

2020-06-19T19:02:19Z

Update to DemoTransferCSV

2019-12-20T03:16:48Z

Fix boolean values of auto_approve

2019-07-12T16:41:54Z

Added note regarding limitation of string queries.

2019-07-12T00:47:48Z

Removed extra character

2019-07-12T00:45:46Z

Added microservices and task API endpoints per @replaceafill. #722

2019-07-12T00:37:30Z

2019-07-09T16:48:26Z

Status

@@ Line 213: / Line 213: @@
 ** <code>file_uuid</code>: UUID of the file used for the task
 ** <code>file_name</code>: File used for the task,
-** <code<time_created</code>: String (YYYY-MM-DD HH:MM:SS) representing when the task was created
+** <code>time_created</code>: String (YYYY-MM-DD HH:MM:SS) representing when the task was created
 ** <code>time_started</code>: String (YYYY-MM-DD HH:MM:SS) representing when the task started
 ** <code>time_ended</code>: String (YYYY-MM-DD HH:MM:SS) representing when the task finished

← Older revision		Revision as of 09:32, 25 May 2021
Line 1:		Line 1:
	[[Main Page]] > [[Development]] > Archivematica API		[[Main Page]] > [[Development]] > Archivematica 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>

	Endpoints require authentication with a username and API key. This can be submitted as GET parameters (eg <code>?username=demo&api_key=e6282adabed84e39ffe451f8bf6ff1a67c1fc9f2</code>) or as a header (eg <code>Authorization: ApiKey demo:e6282adabed84e39ffe451f8bf6ff1a67c1fc9f2</code>).		Endpoints require authentication with a username and API key. This can be submitted as GET parameters (eg <code>?username=demo&api_key=e6282adabed84e39ffe451f8bf6ff1a67c1fc9f2</code>) or as a header (eg <code>Authorization: ApiKey demo:e6282adabed84e39ffe451f8bf6ff1a67c1fc9f2</code>).

@@ Line 183: / Line 183: @@
 === List jobs ===
-* '''URL''': <code>/v2beta/jobs/<unit UUID>/</code>
+* '''URL''': <code>/api/v2beta/jobs/<unit UUID>/</code>
 * '''Verb''': GET
 * Return a list of jobs for the passed unit (transfer or ingest).
@@ Line 203: / Line 203: @@
 === Task ===
-* '''URL''': <code>/v2beta/task/<task UUID>/</code>
+* '''URL''': <code>/api/v2beta/task/<task UUID>/</code>
 * '''Verb''': GET
 * Return information about a task.

@@ Line 271: / Line 271: @@
       -H "Content-Type: application/json" \
       -d "{\
-          \"path\": \"$(echo -n '/home/archivematica/archivematica-sampledata/SampleTransfers/DemoTransfer' | base64 -w 0)\", \
+          \"path\": \"$(echo -n '/home/archivematica/archivematica-sampledata/SampleTransfers/DemoTransferCSV' | base64 -w 0)\", \
           \"name\": \"demo_transfer_absolute\", \
           \"processing_config\": \"automated\", \
@@ Line 285: / Line 285: @@
       -H "Content-Type: application/json" \
       -d "{\
-          \"path\": \"$(echo -n 'd1184f7f-d755-4c8d-831a-a3793b88f760:/archivematica/archivematica-sampledata/SampleTransfers/DemoTransfer' | base64 -w 0)\", \
+          \"path\": \"$(echo -n 'd1184f7f-d755-4c8d-831a-a3793b88f760:/archivematica/archivematica-sampledata/SampleTransfers/DemoTransferCSV' | base64 -w 0)\", \
           \"name\": \"demo_transfer_relative\", \
           \"processing_config\": \"automated\", \

@@ Line 257: / Line 257: @@
 *** <code>access_system_id</code>: Access system ID (see [https://www.archivematica.org/en/docs/latest/user-manual/access/access docs])
 *** <code>metadata_set_id</code>: Used to link to metadata sets added via the user interface. It's safe to ignore this for now since metadata can't be associated to transfer via the API at the moment.
-*** <code>auto_approve</code>: Boolean <code>True</code> or <code>False</code> to set the transfer to auto-approve, default: <code>True</code>
+*** <code>auto_approve</code>: Boolean <code>true</code> or <code>false</code> to set the transfer to auto-approve, default: <code>true</code>
 * '''Response''': JSON
 ** <code>id</code>: Transfer UUID ('''Note:''' as the package endpoint allows the caller to interact with Archivematica asynchronously it doesn't guarantee a transfer has started. The caller must use the UUID in the response to verify it has begun or any errors that were encountered initiating one.)
@@ Line 292: / Line 292: @@
      "http://<archivematica-uri>/api/v2beta/package"
 </pre>
 === Validate ===

← Older revision		Revision as of 16:41, 12 July 2019
Line 179:		Line 179:

	== Unit ==		== Unit ==
		+
		+	''Note: Currently, you can only query strings in English.''

	=== List jobs ===		=== List jobs ===

@@ Line 185: / Line 185: @@
 * Return a list of jobs for the passed unit (transfer or ingest).
 * '''Parameters''':
-* *'''Optional filters''':
+* '''Optional filters''':
 *** <code>microservice</code>: Name of the microservice the jobs belong to
 *** <code>link_uuid</code>: UUID of the job chain link

@@ Line 169: / Line 169: @@
 * '''URL''': <code>/api/administration/dips/atom/levels/</code>
 * '''Verb''': GET?
-* Returns a JSON-encoded set of the configured levels of description.
+* Return a JSON-encoded set of the configured levels of description.
 * ''Response'': JSON. List of AtoM Levels of description with key 'UUID' and value 'name of level of description'.
@@ Line 177: / Line 177: @@
 * Fetch all levels of description from an AtoM database, replacing any previously existing.
 * '''Response''': JSON. Updated list of AtoM Levels of description with key 'UUID' and value 'name of level of description'.
 == Other ==

@@ Line 52: / Line 52: @@
 === Status ===
-* '''URL''': <code>/transfer/status/<transfer UUID>/</code>
+* '''URL''': <code>/api/transfer/status/<transfer UUID>/</code>
 * '''Verb''': GET
 * Returns the status of the transfer.