API docs by Redocly

Archivematica Storage Service (v1)

Download OpenAPI specification:Download

Async_read

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "resource_uri": "string",
  • "completed": true,
  • "was_error": true,
  • "created_time": "2019-08-24T14:15:22Z",
  • "updated_time": "2019-08-24T14:15:22Z",
  • "completed_time": "2019-08-24T14:15:22Z",
  • "result": null,
  • "error": "string"
}

Packages_read

Authorizations:
ApiKeyAuth
path Parameters
uuid
required
string <uuid> (uuid)
Example: e3bae040-7682-4457-aef8-20a419aed0bd

UUID identifier. Storage Service uses UUIDv4 values.

Responses

Response samples

Content type
application/json
{
  • "uuid": "e3bae040-7682-4457-aef8-20a419aed0bd",
  • "current_full_path": "string",
  • "current_location": "string",
  • "current_path": "string",
  • "encrypted": true,
  • "origin_pipeline": "string",
  • "package_type": "AIP",
  • "related_packages": [
    ],
  • "replicas": [
    ],
  • "replicated_package": "string",
  • "resource_uri": "string",
  • "size": 0,
  • "status": "string",
  • "stored_date": "2019-08-24T14:15:22Z"
}

Packages_checkFixity

Run a fixity check for the specified package.

Authorizations:
ApiKeyAuth
path Parameters
uuid
required
string <uuid> (uuid)
Example: e3bae040-7682-4457-aef8-20a419aed0bd

UUID identifier. Storage Service uses UUIDv4 values.

query Parameters
force_local
boolean

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "failures": {
    }
}

Packages_deleteAip

Create an AIP deletion request for this package. This does not perform the deletion itself.

Authorizations:
ApiKeyAuth
path Parameters
uuid
required
string <uuid> (uuid)
Example: e3bae040-7682-4457-aef8-20a419aed0bd

UUID identifier. Storage Service uses UUIDv4 values.

Request Body schema: application/json
required
event_reason
required
string

Explanation recorded with the deletion request.

pipeline
required
string <uuid>

UUID of the pipeline creating the deletion request.

user_id
required
integer <int32>

Identifier of the user creating the deletion request.

user_email
required
string

Email address of the user creating the deletion request.

Responses

Request samples

Content type
application/json
{
  • "event_reason": "string",
  • "pipeline": "e3bae040-7682-4457-aef8-20a419aed0bd",
  • "user_id": 0,
  • "user_email": "string"
}

Response samples

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

Packages_download

Download the package archive. Successful responses stream the file body.

Authorizations:
ApiKeyAuth
path Parameters
uuid
required
string <uuid> (uuid)
Example: e3bae040-7682-4457-aef8-20a419aed0bd

UUID identifier. Storage Service uses UUIDv4 values.

Responses

Response samples

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

Packages_downloadHead

Check package download availability. The current server implementation handles HEAD the same way as GET.

Authorizations:
ApiKeyAuth
path Parameters
uuid
required
string <uuid> (uuid)
Example: e3bae040-7682-4457-aef8-20a419aed0bd

UUID identifier. Storage Service uses UUIDv4 values.

Responses

Packages_downloadChunk

Download a LOCKSS package chunk. Successful responses stream the file body.

Authorizations:
ApiKeyAuth
path Parameters
uuid
required
string <uuid> (uuid)
Example: e3bae040-7682-4457-aef8-20a419aed0bd

UUID identifier. Storage Service uses UUIDv4 values.

chunkNumber
required
integer <int32>

Responses

Response samples

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

Packages_downloadChunkHead

Check LOCKSS package chunk download availability. The current server implementation handles HEAD the same way as GET.

Authorizations:
ApiKeyAuth
path Parameters
uuid
required
string <uuid> (uuid)
Example: e3bae040-7682-4457-aef8-20a419aed0bd

UUID identifier. Storage Service uses UUIDv4 values.

chunkNumber
required
integer <int32>

Responses

Packages_downloadFile

Download a single file from the package. Compressed packages may be extracted on demand.

Authorizations:
ApiKeyAuth
path Parameters
uuid
required
string <uuid> (uuid)
Example: e3bae040-7682-4457-aef8-20a419aed0bd

UUID identifier. Storage Service uses UUIDv4 values.

query Parameters
relative_path_to_file
required
string

Responses

Response samples

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

Packages_downloadFileHead

Check extracted-file download availability. The current server implementation handles HEAD the same way as GET.

Authorizations:
ApiKeyAuth
path Parameters
uuid
required
string <uuid> (uuid)
Example: e3bae040-7682-4457-aef8-20a419aed0bd

UUID identifier. Storage Service uses UUIDv4 values.

query Parameters
relative_path_to_file
required
string

Responses

Packages_move

Move the package to a different storage location.

Authorizations:
ApiKeyAuth
path Parameters
uuid
required
string <uuid> (uuid)
Example: e3bae040-7682-4457-aef8-20a419aed0bd

UUID identifier. Storage Service uses UUIDv4 values.

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

UUID identifier. Storage Service uses UUIDv4 values.

Responses

Response samples

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

Packages_downloadPointerFile

Download the package pointer file.

Authorizations:
ApiKeyAuth
path Parameters
uuid
required
string <uuid> (uuid)
Example: e3bae040-7682-4457-aef8-20a419aed0bd

UUID identifier. Storage Service uses UUIDv4 values.

Responses

Packages_reviewAipDeletion

Approve or reject an AIP deletion request associated with this package.

Authorizations:
ApiKeyAuth
path Parameters
uuid
required
string <uuid> (uuid)
Example: e3bae040-7682-4457-aef8-20a419aed0bd

UUID identifier. Storage Service uses UUIDv4 values.

Request Body schema: application/json
required
event_id
required
integer <int32>

ID of the deletion request event to review.

decision
required
string
Enum: "approve" "reject"

Decision to record. Accepted values are "approve" and "reject".

reason
required
string

Explanation that will be stored alongside the decision.

Responses

Request samples

Content type
application/json
{
  • "event_id": 0,
  • "decision": "approve",
  • "reason": "string"
}

Response samples

Content type
application/json
Example
{
  • "message": "string",
  • "detail": "string"
}

Locations_list

Authorizations:
ApiKeyAuth
query Parameters
description
string
purpose
string (LocationPurpose)
Enum: "AR" "AS" "CP" "DS" "SD" "SS" "BL" "TS" "RP"
quota
integer
relative_path
string
used
integer
uuid
string <uuid> (uuid)
Example: uuid=e3bae040-7682-4457-aef8-20a419aed0bd

UUID identifier. Storage Service uses UUIDv4 values.

pipeline__uuid
string <uuid> (uuid)
Example: pipeline__uuid=e3bae040-7682-4457-aef8-20a419aed0bd

UUID identifier. Storage Service uses UUIDv4 values.

order_by
string
limit
integer
offset
integer

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "objects": [
    ]
}

Locations_default

Authorizations:
ApiKeyAuth
path Parameters
purpose
required
string (LocationPurpose)
Enum: "AR" "AS" "CP" "DS" "SD" "SS" "BL" "TS" "RP"

Responses

Response samples

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

Locations_read

Authorizations:
ApiKeyAuth
path Parameters
uuid
required
string <uuid> (uuid)
Example: e3bae040-7682-4457-aef8-20a419aed0bd

UUID identifier. Storage Service uses UUIDv4 values.

Responses

Response samples

Content type
application/json
{
  • "description": "string",
  • "enabled": true,
  • "path": "string",
  • "pipeline": [
    ],
  • "purpose": "AR",
  • "quota": 0,
  • "relative_path": "string",
  • "resource_uri": "string",
  • "space": "string",
  • "used": 0,
  • "uuid": "e3bae040-7682-4457-aef8-20a419aed0bd"
}

Locations_move

Move files to the specified location.

Authorizations:
ApiKeyAuth
path Parameters
uuid
required
string <uuid> (uuid)
Example: e3bae040-7682-4457-aef8-20a419aed0bd

UUID identifier. Storage Service uses UUIDv4 values.

Request Body schema: application/json
required
origin_location
required
string

URI of the Location the files should be moved from.

pipeline
required
string

URI of the pipeline.

required
Array of objects (moveFile)

List of objects containing source and destination. The source and destination are paths relative to their Location of the files to be moved.

Responses

Request samples

Content type
application/json
{
  • "origin_location": "string",
  • "pipeline": "string",
  • "files": [
    ]
}

Response samples

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

Pipelines_list

Authorizations:
ApiKeyAuth
query Parameters
description
string
uuid
string <uuid> (uuid)
Example: uuid=e3bae040-7682-4457-aef8-20a419aed0bd

UUID identifier. Storage Service uses UUIDv4 values.

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "objects": [
    ]
}

Pipelines_read

Authorizations:
ApiKeyAuth
path Parameters
uuid
required
string <uuid> (uuid)
Example: e3bae040-7682-4457-aef8-20a419aed0bd

UUID identifier. Storage Service uses UUIDv4 values.

Responses

Response samples

Content type
application/json
{
  • "description": "string",
  • "remote_name": "string",
  • "resource_uri": "string",
  • "uuid": "e3bae040-7682-4457-aef8-20a419aed0bd"
}