API docs by Redocly

Archivematica (v1)

Download OpenAPI specification:

Administration_fetchLevelsOfDescription

Fetches all levels of description from an AtoM datatabase, replacing any previously existing.

Authorizations:
ApiKeyAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Filesystem_listLevelsOfDescription

List all levels of description configured.

Authorizations:
ApiKeyAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Filesystem_readMetadata

Read metadata for a path (currently only level of description).

Authorizations:
ApiKeyAuth
query Parameters
path
required
string

Responses

Response samples

Content type
application/json
{
  • "level_of_description": "string"
}

Filesystem_updateMetadata

Update metadata for a path (currently only level of descrption).

Authorizations:
ApiKeyAuth
Request Body schema: application/x-www-form-urlencoded
required
path
required
string
level_of_description
required
string

Responses

Response samples

Content type
application/json
{
  • "success": true
}

Ingest_listCompleted

List completed SIPs.

Authorizations:
ApiKeyAuth

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "message": "string"
}

Ingest_copyMetadataFiles

Add metadata files to a SIP.

Authorizations:
ApiKeyAuth
Request Body schema: application/x-www-form-urlencoded
required
sip_uuid
required
string <uuid> (uuid)
paths
required
Array of strings

Responses

Response samples

Content type
application/json
{
  • "error": false,
  • "message": "string"
}

Ingest_deleteAll

Mark all completed SIPs as hidden.

Authorizations:
ApiKeyAuth

Responses

Response samples

Content type
application/json
{
  • "removed": true
}

Ingest_reingest

Approve re-ingest of an AIP to the beginning of ingest.

Authorizations:
ApiKeyAuth
Request Body schema: application/x-www-form-urlencoded
required
name
required
string
uuid
required
string <uuid> (uuid)

Responses

Response samples

Content type
application/json
{
  • "error": false,
  • "message": "string",
  • "reingest_uuid": "1a648831-f444-4a4c-afa3-248cc6365fbd"
}

Ingest_approveReingest

Approve an AIP partial re-ingest.

Authorizations:
ApiKeyAuth
Request Body schema: application/x-www-form-urlencoded
required
uuid
required
string <uuid> (uuid)

Responses

Response samples

Content type
application/json
{
  • "error": false,
  • "message": "string"
}

Ingest_read

Read the status of a SIP.

Authorizations:
ApiKeyAuth
path Parameters
id
required
string <uuid> (uuid)

Responses

Response samples

Content type
application/json
{
  • "type": "SIP",
  • "directory": "string",
  • "name": "string",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "microservice": "string",
  • "status": "USER_INPUT",
  • "sip_uuid": "1fb3b31f-7043-480d-afc8-db43def7bd8a"
}

Ingest_listWaiting

List SIPs waiting for user input..

Authorizations:
ApiKeyAuth

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "message": "string"
}

Ingest_delete

Mark a SIP as hidden and hide in the dashboard.

Authorizations:
ApiKeyAuth
path Parameters
id
required
string <uuid> (uuid)

Responses

Response samples

Content type
application/json
{
  • "removed": true
}

ProcessingConfiguration_list

Lists known processing configurations.

Authorizations:
ApiKeyAuth

Responses

Response samples

Content type
application/json
[
  • "string"
]

ProcessingConfiguration_read

Returns the processing configuration with the given name.

Authorizations:
ApiKeyAuth
path Parameters
name
required
string
header Parameters
accept
required
string
Enum: "*/*" "application/xml" "text/xml"

Responses

Response samples

Content type
application/json
{
  • "success": false,
  • "error": "string"
}

ProcessingConfiguration_delete

Deletes the processing configuration with the given name.

Authorizations:
ApiKeyAuth
path Parameters
name
required
string

Responses

Response samples

Content type
application/json
{
  • "success": true
}

Transfer_approve

Approve a transfer.

Authorizations:
ApiKeyAuth
Request Body schema: application/x-www-form-urlencoded
required
directory
required
string

Directory the transfer is in currently.

type
required
string
Enum: "standard" "zipfile" "unzipped bag" "zipped bag" "dspace" "maildir" "TRIM" "dataverse"

Type of the transfer.

Responses

Response samples

Content type
application/json
{
  • "error": false,
  • "message": "string",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}

Transfer_listCompleted

List completed transfers.

Authorizations:
ApiKeyAuth

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "message": "string"
}

Transfer_deleteAll

Mark all completed transfers as hidden.

Authorizations:
ApiKeyAuth

Responses

Response samples

Content type
application/json
{
  • "removed": true
}

Transfer_reingest

Approve re-ingest of an AIP to the beginning of transfer.

Authorizations:
ApiKeyAuth
Request Body schema: application/x-www-form-urlencoded
required
name
required
string
uuid
required
string <uuid> (uuid)

Responses

Response samples

Content type
application/json
{
  • "error": false,
  • "message": "string",
  • "reingest_uuid": "1a648831-f444-4a4c-afa3-248cc6365fbd"
}

Transfer_start

Start a new transfer.

Authorizations:
ApiKeyAuth
Request Body schema: application/x-www-form-urlencoded
required
name
required
string

Name of the transfer.

type
required
string
Enum: "standard" "zipfile" "unzipped bag" "zipped bag" "dspace" "maildir" "TRIM" "dataverse"

Type of the transfer.

accession
required
string

Accession number.

access_id
required
string

Access system ID.

paths
required
Array of strings

List of base64-encoded : to be copied into the new transfer. Location UUIDs should be associated with this pipeline, and relative path should be relative to the location.

row_ids
required
Array of strings

ID of the associated TransferMetadataSet for disk image ingest.

Responses

Response samples

Content type
application/json
{
  • "error": false,
  • "message": "string",
  • "path": "string"
}

Transfer_read

Read the status of a transfer.

Authorizations:
ApiKeyAuth
path Parameters
id
required
string <uuid> (uuid)

Responses

Response samples

Content type
application/json
{
  • "type": "transfer",
  • "directory": "string",
  • "name": "string",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "microservice": "string",
  • "status": "USER_INPUT",
  • "sip_uuid": "1fb3b31f-7043-480d-afc8-db43def7bd8a"
}

Transfer_listUnapproved

List unapproved transfers.

Authorizations:
ApiKeyAuth

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "message": "string"
}

Transfer_delete

Mark a transfer as hidden and hide in the dashboard.

Authorizations:
ApiKeyAuth
path Parameters
id
required
string <uuid> (uuid)

Responses

Response samples

Content type
application/json
{
  • "removed": true
}

Jobs_list

Return a list of jobs for the given package.

Authorizations:
ApiKeyAuth
path Parameters
id
required
string <uuid> (uuid)

Package ID

query Parameters
microservice
string

Name of the microservice the jobs belong to.

link_uuid
required
string <uuid> (uuid)

UUID of the job chain link.

name
string

Name of the job.

detailed
boolean

Include the task properties provided by the task endpoint.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Packages_create

Starts a new transfer.

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required
name
required
string
path
required
string
access_system_id
string
accession
string
auto_approve
boolean
processing_config
string
type
string (TransferType)
Enum: "standard" "zipfile" "unzipped bag" "zipped bag" "dspace" "maildir" "TRIM" "dataverse"

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "path": "string",
  • "access_system_id": "string",
  • "accession": "string",
  • "auto_approve": true,
  • "processing_config": "string",
  • "type": "standard"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

Tasks_read

Return information about a task.

Authorizations:
ApiKeyAuth
path Parameters
id
required
string <uuid> (uuid)

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "file_name": "string",
  • "file_uuid": "f8e009a6-6911-41da-98d0-fee9e838b64d",
  • "exit_code": 0,
  • "time_created": "string",
  • "time_started": "string",
  • "time_ended": "string",
  • "duration": ""
}

Validate_create

Validate CSVs against embedded sets of rules.

The status value may be one of:

  • ok: the submitted document is valid.
  • bad request: the submitted document is invalid.
Authorizations:
ApiKeyAuth
path Parameters
validator
required
string (V2Beta.Validate.Validator)
Enum: "avalon" "rights"
Request Body schema: text/csv; charset=utf-8
required
string <binary>

Responses

Response samples

Content type
application/json
{
  • "valid": true
}