API docs by Redocly

Archivematica Storage Service (v1)

Download OpenAPI specification:Download

Packages_read

Authorizations:
ApiKeyAuth
path Parameters
uuid
required
string <UUIDv4, e.g.: "e3bae040-7682-4457-aef8-20a419aed0bd".> (uuid)

Responses

Response samples

Content type
application/json
{
  • "uuid": "string",
  • "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": "string"
}

Packages_checkFixity

Run a fixity check for the specified package.

Authorizations:
ApiKeyAuth
path Parameters
uuid
required
string <UUIDv4, e.g.: "e3bae040-7682-4457-aef8-20a419aed0bd".> (uuid)
query Parameters
force_local
boolean

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string",
  • "timestamp": "string",
  • "failures": {
    }
}

Packages_move

Move the package to a different storage location.

Authorizations:
ApiKeyAuth
path Parameters
uuid
required
string <UUIDv4, e.g.: "e3bae040-7682-4457-aef8-20a419aed0bd".> (uuid)
Request Body schema: application/json
required
location_uuid
required
string <UUIDv4, e.g.: "e3bae040-7682-4457-aef8-20a419aed0bd".> (uuid)

Responses

Request samples

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

Response samples

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

Packages_reviewAipDeletion

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

Authorizations:
ApiKeyAuth
path Parameters
uuid
required
string <UUIDv4, e.g.: "e3bae040-7682-4457-aef8-20a419aed0bd".> (uuid)
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
{
  • "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 <UUIDv4, e.g.: "e3bae040-7682-4457-aef8-20a419aed0bd".> (uuid)
pipeline__uuid
string <UUIDv4, e.g.: "e3bae040-7682-4457-aef8-20a419aed0bd".> (uuid)
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 <UUIDv4, e.g.: "e3bae040-7682-4457-aef8-20a419aed0bd".> (uuid)

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": "string"
}

Locations_move

Move files to the specified location.

Authorizations:
ApiKeyAuth
path Parameters
uuid
required
string <UUIDv4, e.g.: "e3bae040-7682-4457-aef8-20a419aed0bd".> (uuid)
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 <UUIDv4, e.g.: "e3bae040-7682-4457-aef8-20a419aed0bd".> (uuid)

Responses

Response samples

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

Pipelines_read

Authorizations:
ApiKeyAuth
path Parameters
uuid
required
string

Responses

Response samples

Content type
application/json
{
  • "description": "string",
  • "remote_name": "string",
  • "resource_uri": "string",
  • "uuid": "string"
}