Initialize

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

• Request Body: JSON in format:

  {
    "originatorEmailAddress" : "${bridge.originatorEmailAddress}",
    "duracloudEmailAddresses" : ["${bridge.duracloudEmailAddress}"],
    "dpnEmailAddresses" : ["${bridge.dpnEmailAddress}"],
    "duracloudUsername" : "${bridge.duracloudUsername}",
    "duracloudPassword" : "${bridge.duracloudPassword}",
    "awsAccessKey" : "${aws.accessKey}",
    "awsSecretKey" : "${aws.secretKey}",
    "databaseUser" : "${bridge.database.username}",
    "databasePassword" : "${bridge.database.password}",
    "databaseURL" : "${bridge.database.url}",
    "contentDirRoot" : "${bridge.contentDirRoot}",
    "workDir" : "${bridge.workDir}",
    "clean" : "${bridge.clean}"
  }

• Response Code: 200 (on success)

• Response Body: JSON:

  {"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:

  {"version" : "1.0.0"}

Create Snapshot

• Purpose: Performs a snapshot action
• Request: PUT https://host:port/bridge/snapshot/(snapshotId)

• Request Body: JSON:

  {
    "host" : "",
    "port" : "",
    "storeId" : "",
    "spaceId" : "",
    "description" : "",
    "userEmail" : ""
  } 

  • host - DNS host of DuraCloud instance from which snapshot can be taken
  • port - Port on which DuraCloud applications are available
  • storeID - Identifier of Chronopolis staging storage provider on DuraCloud instance
  • spaceID - Identifier of space in which snapshot content resides
  • description - User-supplied description of the snapshot
  • userEmail - User's email address, for notifications
    
    
• Response Code: 200 or 201 on success (201 if snapshot request did not already exist)

• Response Body: JSON:

  {
    "snapshotId" : "",
    "status": ""
  }

List All Snapshots

• Purpose: Retrieves a list of all snapshots

• Request: GET https://host:port/bridge/snapshot ? host=(host)

• Response Body: JSON:

  {
    "snapshots" : [
      {
        "snapshotId" : "",  
        "description" : "",
        "status" : ""
      }, 
      ...,
      ...  
    ]
  }

List Snapshot Contents

• Purpose: Retrieves a list of content items which were included in a snapshot

• Request: GET https://host:port/bridge/snapshot/(snapshotId)/content ? page=(pageNumber) & pageSize=(pageSize) & prefix=(prefix)

• Response Body: JSON:

  { 
    "contentItems" : [
      { "contentId" : "",
        "contentProperties" : {"" : ""}
      }
    ]
  }

Get Snapshot Details

• Purpose: Provides the status of a snapshot action
• Request: GET https://host:port/bridge/snapshot/(snapshotId)
  • snapshotId - Identifier of the snapshot
• Response Code: 200 (on success)

• Response Body: JSON:

  {
    "snapshotId" : "",
    "snapshotDate" : "",
    "status" : "",
    "sourceHost" : "",
    "sourceSpaceId" : "",
    "sourceStoreId" : "",
    "description" : "",
    "contentItemCount" : "",
    "totalSizeInBytes" : ""
  }

  Possible values for status:

  • INITIALIZED

  • TRANSFERRING_FROM_DURACLOUD

  • WAITING_FOR_DPN

  • CLEANING_UP

  • SNAPSHOT_COMPLETE

  • FAILED_TO_TRANSFER_FROM_DURACLOUD

Snapshot Complete

• Purpose: Enables DPN provider to notify bridge app that a snapshot has been restored to bridge storage.
• Request: POST https://host:port/bridge/snapshot/(snapshotId)/complete
• snapshotId - Identifier of the snapshot
• Response Code: 200 (on success)

• Response Body: JSON:

  {
    "status" : "SNAPSHOT_COMPLETE",
    "details" : ""
  }

Restore Snapshot

• Purpose: Enables user to initiate the restoration of a snapshot

• Request: PUT https://host:port/bridge/restore

  {
    "host" : "",
    "port" : "",
    "storeId" : "",
    "spaceId" : "",
    "snapshotId" : "",
    "userEmail" : ""
  } 

• Response Code: 200 (on success)

• Response Body: JSON:

  {
    "restoreId" : ""
    "status" : ""
  }

   Possible value for status (see Get Restore Details)

Restore Complete

• Purpose: Enables DPN provider to notify bridge app that a snapshot has been restored to bridge storage.
• Request: POST https://host:port/bridge/restore/(restoreId)/complete
• restoreId - Identifier of the snapshot
• Response Code: 200 (on success)

• Response Body: JSON:

  {
    "status" : ""
    "details" : ""
  }

Get Restore Details

• Purpose: Provides the status of a restoration action
• Request: GET https://host:port/bridge/restore/(restoreId)
• Response Code: 200 (on success)

• Response Body: JSON:

  {
    "restoreId" : "",
    "snapshotId" : "",
    "status" : "",
    "startDate" : "",
    "endDate" : "",
    "statusText" : "",
    "destinationHost" : "",
    "destinationPort" : "",
    "destinationStoreId" : "",
    "destinationSpaceId" : ""
  }

  Possible values for status:

  • INITIALIZED

  • WAITING_FOR_DPN

  • DPN_TRANSFER_COMPLETE

  • TRANSFERRING_TO_DURACLOUD

  • TRANSFER_TO_DURACLOUD_COMPLETE

  • VERIFYING_TRANSFERRED_CONTENT

  • CLEANING_UP

  • ERROR

  • RESTORATION_COMPLETE