Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Status
colourYellow
titledraft

The preservation Gateway functions as an aggregating cache for preservation requests originating with a repository and destined for a DDP via the OTM Bridge. This allows repositories to synchronously send contentpreservation in an asynchronous deep archive.

Repository Gateway API

PUT Object (deposit)

...

Description

Create a gateway object for preservation of a Bag Object from the repository

Requests/Responses

  • Request: PUT /ObjectId HTTP/1.1

  • Request Body: Compressed Bag
  • Request Headers:
    • Content-Type
  • Response Code: 202 Accepted 201 Created (on success)

HEAD Object (audit)

...

Description

Retrieve audit metadata for the object.

Requests/Responses

  • Request: GET /ObjectId HTTP/1.1

  • Request Body: n/a
  • Response Code: 200 OK
  • Response Body:

    Code Block
    languagejs
    titleJSON response body
    {
    }


DELETE Object (destroy)

...

Description

Request removal of a Bag Object and all its contents

Requests/Responses

  • Request: DELETE /ObjectId HTTP/1.1

  • Request Body: n/a
  • Response Code: 204

POST Object Restore

...

Description

Request restore of a Bag Object and all its contents for later retrieval

Requests/Responses

  • Request: Post /ObjectId?restore HTTP/1.1

  • Request Body: n/a
  • Response Code:
    • 202 Accepted (if the object is not already restored)
    • 200 OK (if the object is already restored and available for retrieval)
Info
titleQuestion

Can HTTP Range requests be used to retrieve individual files (e.g. metadata)

GET Object (retrieve)

Description

...

Retrieve a restored object.

Requests/Responses

  • Request: GET /ObjectId HTTP/1.1

  • Request Body: n/a
  • Response Code:
    • 200 OK (if the object is restored available)
    • 403 Forbidden (if the object has not been restored)

  • Response Body: Compressed bag
  • Response Headers:
    • Content-Type
Info
titleQuestion

Can HTTP Range requests be used to retrieve individual files (e.g. metadata)

Authentication

Repository Client Authorization

...