Versions Compared

Key

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

...

  • Purpose: Retrieves a list of all deposited filesgroups and files. There are 4 3 list options, (1) List all filegroups and associated files (2) List all filegroups, no files (3) List all files , no filegroups (4) List only files for the specified filegroup
  • Request: GET /bridge/list ? {list-type} & {filegroup}
    • list-type: (Optional) Valid values are "all", "filegroups", and "files". Default is "all"
    • filegroup: (Optional) Indicates that only files for this specific filegroup should be listed
  • Response Body: JSON

    Code Block
    languagejs
    {
      "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
        "file-1-id",
        "file-2-id",
      },                                     # Additional filegroups listed here
    }


    or

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

    or


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


  • Notes
    • There are varying options here. May need to consider the actual use cases and needs to see if all of these options are required

...