Versions Compared

Key

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

...

  • Purpose: Retrieves a list all deposited filegroup IDs
  • Request: GET /bridge/list
  • Response Body: JSON


    Code Block
    { "filegroup-1-id", "filegroup-2-id", ... }


  • Notes:

    • This list would not include deleted filegroups 

Get Deposited Details

  • Purpose: Retrieves details about a deposited filesgroup, including all versions and associated files
  • Request: GET /bridge/list/{filegroup-id}/{file-id}
    • filegroup-id : List all versions and files associated with a specific filegroup IDThe identifier of the filegroup for which information is requested
    • file-id : (Optional) The identifier of the file for which information is requested
  • 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
      ]
    }


  • Notes:

    • When a file-id is included, the file matching that ID is the only one returned in the response
    • This list would not include deleted versions or files. A tombstone capability is possible, but not currently part of this specification.

...