Versions Compared

Old Version 4

changes.mady.by.user Bill Branan

Saved on

compared with

New Version 5

changes.mady.by.user Bill Branan

Saved on

Key

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

...

  • Purpose: Retrieves a listing of all in-process deposits
  • Request: GET /bridge/deposit

  • Response Body: JSON 

    Code Block
    {
  "deposit-id-1" : {
    "files" : "",     # Number of files in deposit
    "status" : ""     # Current deposit status
  },                  # Additional deposits listed here
}


  • Response Code: 200 (on success)

...

  • Purpose: Removes one or more files from DDP storage
  • Request: POST /bridge/purge # Using POST rather than DELETE, allows for deleting multiple files (and is consistent with Restore action)

  • Request Body: JSON 

    Code Block
    {
  "checksum-type" : "",        # Checksum type applies to all file checksums (can be one of: MD5, SHA-256, SHA-512)
  "file-1-id" : {
    "url" : "",                # It's not clear what this URL would be
    "checksum" : ""            # Checksum may only be needed as verification or in the versioning scenario (i.e. could be optional)
  },                           # Additional files are added here
}


  • Response Code: 202 (on success)

  • Response Body: JSON 

    Code Block
    {
  "delete-id" : ""
}


...

  • Purpose: Allows the repository to ask for status of a content delete action
  • Request: GET /bridge/purge/{delete-id}

  • Response Body: JSON 

    Code Block
    { "status" : "" }   # This could include a top level status or a per-file status (or both)


  • Response Code: 200 (on success)

...

  • Purpose: Retrieves the audit history for a given file
  • Request: GET /bridge/audit/{file-id}

  • Response Body: JSON 

    Code Block
    {
  "audit-events" : {
    "audit-event-1" : "",   # May want to define a method to simplify processing of audit events, such as a predefined set of event types
  }
}


  • Response Code: 200 (on success)

...

  • Purpose: Requests that content be made available for restore
  • Request: POST /bridge/restore

  • Request Body: JSON 

    Code Block
    {
  "checksum-type" : "SHA-256", # Checksum type applies to all file checksums
  "file-1-id" : {
    "checksum" : ""            # Checksum may only be needed as verification or in the versioning scenario
  },                           # Additional files are added here
}


  • Response Code: 202 (on success)

  • Response Body: JSON 

    Code Block
    {
  "restore-id" : ""
}


...

  • Purpose: Allows the repository to ask for status of a content restore action
  • Request: GET /bridge/restore/{restore-id}

  • Response Body: JSON 

    Code Block
    { "status" : "" }   # This could include a top level status or a per-file status (or both)


  • Response Code: 200 (on success)


Calls available to the DDP

Add Account

  • Purpose: Allows the DDP to inform the Bridge of a new OTM account. After this call it will be possible for the OTM endpoint to contact the Bridge.

Deposit Complete

  • Purpose: Allows the DDP to inform the Bridge that a deposit has completed and no longer needs to be maintained in staging storage.

Calls made to the DDP (the DDP must support these actions)

Content Ready for Deposit

  • Purpose: A set of content is available for deposit