Versions Compared

Key

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

...

  • Purpose: Allows the repository to ask for status of a given deposit
  • Request: GET /bridge/deposit/{filegroup-id}
  • Response Body: JSON

    Code Block
    {
      "filegroup-id" : {
        "deposit-state" : "",
      "status  "files" : {
          "file-1-id" : {
             "status",        # Value based on defined set of known status states deposit status, one of: pending, retrieved, existing
             "size" : "",     # file size in bytes 
             "checksum" : ""  # file checksum
           },
          "file-2-id" : {
             "status" : "",
             "size" : "",   
           # There could"checksum" be: more""
     information here, like an approximate percentage completion},
     of the current step,}
     if known}
    }


  • Response Codes:
    • 200 (on success)
    • 404 (if the provided Deposit ID does not exist in the system)
  • Notes:
    • It would be possible to retain enough information to be able to provide a tombstone-type response for filegroups which were at some point in the system but have been removed

...

  • Purpose: Retrieves details about a deposited filesgroup, including all versions and associated files
  • Request: GET /bridge/list/{filegroup-id}
    • filegroup-id : List all versions and files associated with a specific filegroup ID
  • Response Body: JSON

    Code Block
    languagejs
    {
      "checksum-type" : ""      # Indicates type of checksums listed below, can be one of: MD5, SHA-256, SHA-512
      "filegroup-1-id" : [      # filegroup is a generic grouping of files that can be used to capture structure such as in a digital object or work
        {
          "version" : "",       # filegroup version
          "files" : {
            "file-1-id" : {
               "size" : "",      # file size in bytes 
               "checksum", : ""  # file checksum
             },
            "file-2-id" : {
               "size" : "",      # file size in bytes 
               "checksum", : ""  # file checksum
             },                 # Additional files listed here
          }
        },                      # Additional filegroup versions listed here
      ]
    }


...