Versions Compared

Key

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

...

Panel
titleGeneral Operations

Initialize

  • Purpose: Provides all information needed to initialization the Bridge Ingest App
  • Request: POST https://host:port/bridge/init
  • Request Body: JSON in format:

    Code Block
     {
         "originatorEmailAddress" : "${bridge.originatorEmailAddress}",
      <email address>",        # From email address for notifications
         "duracloudEmailAddresses" : ["${bridge.duracloudEmailAddress}<email address>"],     # Email address(es) of DuraCloud administrator
         "dpnEmailAddresses" : ["${bridge.dpnEmailAddress}<email address>"],           # Email address(es) of DPN administrator
         "duracloudUsername" : "${bridge.duracloudUsername}",<duracloud username>",        # DuraCloud user's username
         "duracloudPassword" : "${bridge.duracloudPassword}",<duracloud password",         # DuraCloud user's password
         "awsAccessKey" : "${aws.accessKey}",
    <aws key>",                        # Access key to AWS, with rights to use SES (for notifications)
         "awsSecretKey" : "${aws.secretKey}",
      <aws secret key>",                 # Secret key to AWS
         "databaseUser" : "${bridge.database.username}",
      <database user>",                  # Bridge database username
         "databasePassword" : "<database "${bridge.database.password}",
      password>",          # Bridge database password
         "databaseURL" : "${bridge.database.url}",
    jdbc:mysql://<database instance>:<database port>/<database name>",   # Bridge database connection URL
         "clean" : "${bridge.clean}"
      "snapshotFinalizerPeriodMs": "${bridge.snapshotFinalizerPeriodMs}" # "false",                                   # True to reset database to a clean state, false to maintain data
         "finalizerPeriodMs" : 60000,                         # Frequency of polling, optional, default is 3600000 (1 hour)
         "daysToExpireRestore" : 30                           # Time to wait before clearing restored content
    }
     
  • Response Code: 200 (on success)
  • Response Body: JSON:

    Code Block
    {"message" : "success!"}

Version

  • Purpose: Provides the current version of the Bridge App
  • Request: GET https://host:port/bridge/version
  • Response Code: 200 (on success)
  • Response Body: JSON:

    Code Block
    {"version" : "1.0.0"}

...