Page History

...

Panel

title	General 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}",
  "duracloudEmailAddresses" : ["${bridge.duracloudEmailAddress}"],
  "dpnEmailAddresses<email address>",        # From email address for notifications
     "duracloudEmailAddresses" : ["${bridge.dpnEmailAddress}<email address>"],
  "duracloudUsername" : "${bridge.duracloudUsername}",
  "duracloudPassword" : "${bridge.duracloudPassword}",
  "awsAccessKey   # Email address(es) of DuraCloud administrator
     "targetStoreEmailAddresses" : "${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}"
  "snapshotFinalizerPeriodMs": "${bridge.snapshotFinalizerPeriodMs}" # optional, default is 3600000 (1 hour)
}

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"}

["<email address>"],   # Email address(es) of preservation store (Chronopolis) administrator 
     "duracloudUsername" : "<duracloud username>",        # DuraCloud user's username
     "duracloudPassword" : "<duracloud password",         # DuraCloud user's password
     "awsAccessKey" : "<aws key>",                        # Access key to AWS, with rights to use SES (for notifications)
     "awsSecretKey" : "<aws secret key>",                 # Secret key to AWS
     "databaseUser" : "<database user>",                  # Bridge database username
     "databasePassword" : "<database password>",          # Bridge database password
     "databaseURL" : "jdbc:mysql://<database instance>:<database port>/<database name>?sessionVariables=wait_timeout=200000",   # Bridge database connection URL
     "clean" : "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"}

Panel

title	Reporting Operations

Get Total Count of Snapshots

Purpose: Retrieves the total count of snapshots. Several optional filters (see query parameters) limit the snapshots used to compute the total.
Request: GET https://host:port/bridge/snapshot/total/count ? host=(host) & storeId=(storeID) & status=(status)
- host - (optional) DuraCloud host from which the snapshot(s) originated. This is generally in the form (account).duracloud.org
- storeId - (optional) Identifier for DuraCloud storage provider from which the snapshot(s) originated.
- status - (optional) Current status of the snapshot(s).
  - Possible status values:
    - INITIALIZED
    - TRANSFERRING_FROM_DURACLOUD
    - REPLICATING_TO_STORAGE
    - CLEANING_UP
    - SNAPSHOT_COMPLETE
    - FAILED_TO_TRANSFER_FROM_DURACLOUD
    - ERROR
    - CANCELLED
Response Body: JSON:
Code Block
{ "totalCount: 1 }

Get Total Size (bytes) of Snapshots

Purpose: Retrieves the total size (bytes) of snapshots. Several optional filters (see query parameters) limit the snapshots used to compute the total.
Request: GET https://host:port/bridge/snapshot/total/size ? host=(host) & storeId=(storeID) & status=(status)
- host - (optional) DuraCloud host from which the snapshot(s) originated. This is generally in the form (account).duracloud.org
- storeId - (optional) Identifier for DuraCloud storage provider from which the snapshot(s) originated.
- status - (optional) Current status of the snapshot(s).
  - Possible status values:
    - INITIALIZED
    - TRANSFERRING_FROM_DURACLOUD
    - REPLICATING_TO_STORAGE
    - CLEANING_UP
    - SNAPSHOT_COMPLETE
    - FAILED_TO_TRANSFER_FROM_DURACLOUD
    - ERROR
    - CANCELLED
Response Body: JSON:
Code Block
{ "totalSize: 1000 }

Get Total Files of Snapshots

Purpose: Retrieves the total files of snapshots. Several optional filters (see query parameters) limit the snapshots used to compute the total.
Request: GET https://host:port/bridge/snapshot/total/files ? host=(host) & storeId=(storeID) & status=(status)
- host - (optional) DuraCloud host from which the snapshot(s) originated. This is generally in the form (account).duracloud.org
- storeId - (optional) Identifier for DuraCloud storage provider from which the snapshot(s) originated.
- status - (optional) Current status of the snapshot(s).
  - Possible status values:
    - INITIALIZED
    - TRANSFERRING_FROM_DURACLOUD
    - REPLICATING_TO_STORAGE
    - CLEANING_UP
    - SNAPSHOT_COMPLETE
    - FAILED_TO_TRANSFER_FROM_DURACLOUD
    - ERROR
    - CANCELLED
Response Body: JSON:
Code Block
{ "totalFiles": 100 }

Get All Totals (count, size, files) of Snapshots

Purpose: Retrieves total count, size and files of snapshots. Several optional filters (see query parameters) limit the snapshots used to compute the totals.
Request: GET https://host:port/bridge/snapshot/total ? host=(host) & storeId=(storeID) & status=(status)
- host - (optional) DuraCloud host from which the snapshot(s) originated. This is generally in the form (account).duracloud.org
- storeId - (optional) Identifier for DuraCloud storage provider from which the snapshot(s) originated.
- status - (optional) Current status of the snapshot(s).
  - Possible status values:
    - INITIALIZED
    - TRANSFERRING_FROM_DURACLOUD
    - REPLICATING_TO_STORAGE
    - CLEANING_UP
    - SNAPSHOT_COMPLETE
    - FAILED_TO_TRANSFER_FROM_DURACLOUD
    - ERROR
    - CANCELLED

Response Body: JSON:

Code Block
{ "totalCount": 1, "totalSize": 1000, "totalFiles": 100 }

Panel

title	Ingest Operations

Create Snapshot

Purpose: Performs a snapshot action
Request: PUT https://host:port/bridge/snapshot/(snapshotId)
- snapshotId - Identifier of the snapshot
Request Body: JSON:
Code Block
{ "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:
Code Block
{ "snapshotId" : "", "status": "" }

List Snapshots

Purpose: Retrieves a list of snapshots. Several optional filters (see query parameters) limit the returned list of snapshots.
Request: GET https://host:port/bridge/snapshot ? host=(host) & storeId=(storeID) & status=(status)
- host - (optional) DuraCloud host from which the snapshot originated. This is generally in the form (account).duracloud.org
- storeId - (optional) Identifier for DuraCloud storage provider from which the snapshot originated.
- status - (optional) Current status of the snapshot.
  - Possible status values:
    - INITIALIZED
    - TRANSFERRING_FROM_DURACLOUD
    - REPLICATING_TO_STORAGE
    - CLEANING_UP
    - SNAPSHOT_COMPLETE
    - FAILED_TO_TRANSFER_FROM_DURACLOUD
    - ERROR
    - CANCELLED

Response Body: JSON:

Code Block
{ "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)
- snapshotId - Identifier of the snapshot
- pageNumber - Page number of content listing
- pageSize - Number of content items to return in a single response
- prefix - Limit content list to items which begin with this value
Response Body: JSON:

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

List Snapshot History

Purpose: Retrieves a list of content items which were included in a snapshot
Request: GET https://host:port/bridge/snapshot/(snapshotId)/history ? page=(pageNumber) & pageSize=(pageSize)
- snapshotId - Identifier of the snapshot
- pageNumber - Page number of history set
- pageSize - Number of history items to return in a single response
Response Body: JSON:

Code Block
{ "totalCount" : (Long) # of historyItems "historyItems" : [ { "historyDate" : (Long) epoch time, "history" : "${history item string}" }, ] }

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:

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

Possible values for status:

INITIALIZED
TRANSFERRING_FROM_DURACLOUD
REPLICATING_TO_STORAGE
CLEANING_UP
SNAPSHOT_COMPLETE
FAILED_TO_TRANSFER_FROM_DURACLOUD
ERROR
CANCELLED

Snapshot Complete

Purpose: Enables storage provider (Chronopolis) to notify bridge app that snapshot content has been successfully transferred to preservation storage and can now be removed from the bridge storage area (and DuraCloud)
Request:

Panel

title	Ingest Operations

Create Snapshot

Purpose: Performs a snapshot action
Request: PUT https://host:port/bridge/snapshot/(snapshotId)
- snapshotId - Identifier of the snapshot
Request Body: JSON:
Code Block
{ "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:
Code Block
{ "snapshotId" : "", "status": "" }

List All Snapshots

Purpose: Retrieves a list of all snapshots

Request: GETPOST https://host:port/bridge/snapshot ? host=/(hostsnapshotId)/complete

host - Account host for which snapshot listing should be provided

snapshotId - Identifier of the snapshot

Request Response Body: JSON:

Code Block
{ "snapshotsalternateIds" : [ { "snapshotId" : "", "description" : "", "status" : "" }, ..., ... ] }

List Snapshot Contents

"alternate-id-1", "alternate-id-2"] }
- A Snapshot can be mapped to zero or more alternate identifiers (e.g. IDs for bags which contain the content in this snapshot).
Response Code: 200 (on success)

Response Body: JSON:

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

Snapshot Error

Purpose: Enables storage provider (Chronopolis) to notify bridge app that processing of the snapshot has resulted in an error
Request: POST
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)error
- snapshotId - Identifier of the snapshot
- pageNumber - Page number of content listing
- pageSize - Number of content items to return in a single response
- prefix - Limit content list to items which begin with this value
Response Request Body: JSON:
Code Block
{

"

contentItems

error":

: [

"" }
Response Code: 200 (on success)
Response Body: JSON:
Code Block
{

{

"

contentId

status" : "SNAPSHOT_ERROR",

"

contentProperties

details" :

{

""

: ""} } ]

}

List

Restart Snapshot

History

Purpose: Retrieves a list of content items which were included in a snapshotEnables restart of snapshots that failed to transfer successfully from DuraCloud.
Request: GETPOST https://host:port/bridge/snapshot/(snapshotId)/history ? page=(pageNumber) & pageSize=(pageSize)
- snapshotId - Identifier of the snapshot
- pageNumber - Page number of history set
- pageSize - Number of history items to return in a single response
restart
- snapshotId - Identifier of the snapshot
Request
Response
Body: JSON:
Code Block
{

"totalCount" : (Long) # of historyItems "historyItems" : [ { "historyDate" : (Long) epoch time, "history

}
Response Code: 202 (on success)

Response Body: JSON:

Code Block
{ "status" : "INITIALIZED", "description" : "

${history item string}

"

}

, ] }

Cancel Snapshot

Purpose: Enables cancellation of a snapshot that is underway. Calls to this method will fail if the snapshot is in the CLEANING_UP or COMPLETE states.

Get Snapshot Details

Purpose: Provides the status of a snapshot action
Request: GETPOST https://host:port/bridge/snapshot/(snapshotId)/cancel
- snapshotId - Identifier of the snapshot
Response Code: 200 (on success)
Response Request Body: JSON:
Code Block
{}
Response Code: 200 (on success)

Response Body: JSON:

Code Block

{
  "snapshotId" : "",
  "snapshotDate" : "",
  "status" : "CANCELLED",
  "sourceHostdescription" : "",
  "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 snapshot content has been successfully transferred to DPN storage and can now be removed from the bridge storage area (and DuraCloud)
Request: POST https://host:port/bridge/snapshot/(snapshotId)/complete
- snapshotId - Identifier of the snapshot
Request Body: JSON:
Code Block
{ "alternateIds": ["alternate-id-1", "alternate-id-2"] }
- A Snapshot can be mapped to zero or more alternate identifiers. Likely this will be a set of DPN bag IDs, which contain the content in this snapshot.
Response Code: 200 (on success)

Response Body: JSON:

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

Restart Snapshot

Purpose: Enables restart of snapshots that failed to transfer successfully from DuraCloud.
Request: POST https://host:port/bridge/snapshot/(snapshotId)/restart
- snapshotId - Identifier of the snapshot
Request Body: JSON:
Code Block
{}
- A Snapshot can be mapped to zero or more alternate identifiers. Likely this will be a set of DPN bag IDs, which contain the content in this snapshot.
Response Code: 200 (on success)

Response Body: JSON:

Code Block
{ "status" : "INITIALIZED", "description" : "" }

Snapshot History Update

}

Snapshot History Update

Purpose: Enables storage provider (Chronopolis) to notify bridge app that a snapshot has an "update" to its history. Whether a snapshot was replicated, successfully stored, checksumed, etc... this is the REST call to handle any and all updates to the history of a particular Snapshot.
Request: POST https://host:port/bridge/snapshot/(identifier)/history
- identifier - Either the snapshot ID or an alternate ID (such as a bag ID) which was associated with the snapshot in the Snapshot Complete call
Request Body: JSON:
- Parameters
  - 'history' - single escaped JSON string that can contain a JSON array of objects or strings - the history event we're trying to record
  - 'alternate' - whether the snapshot ID in the URL is the alternate ID or the original snapshot ID.
- Preferred format (using name/value pairs)
  Code Block
  {"history": "[ {'key1' : 'value1'},{'key2' : 'value2'} ]", "alternate": "false"}
- Alternative formats (also supported, but UI display may not be ideal)
  Code Block
  {"history": "[ 'value1', 'value2' ]", "alternate": "false"} OR {"history": "[ {'key1': 'value1'}, 'value2' ]", "alternate": "false"} OR {"history": "value1", "alternate": "false"}
Response Code: 200 (on success)

Response Body: JSON:

Code Block
{ "snapshot" : {SnapshotSummary}, "history" : "${the history string that was just inserted}" }

{"history": "[ 'value1', 'value2' ]", "alternate": "false"} OR {"history": "[ {'key1': 'value1'}, 'value2' ]", "alternate": "false"} OR {"history": "value1", "alternate": "false"}

Response Code: 200 (on success)

Response Body: JSON:

Panel

title	Restore Operations

Request Snapshot Restore

Purpose: Enables user to request a restoration of a snapshot
Request: PUT https://host:port/bridge/restore/request
Code Block
{ "host" : "", "port" : "", "storeId" : "", "spaceId" : "", "snapshotId" : "", "userEmail" : "" }
The email address is the address of the requester. This address will be forwarded along with the details of the restore request to the duracloud admins.

Response Code: 200 (on success)
Response Body: JSON:
Code Block
{ "description" : "" }

Restore Snapshot

Purpose: Enables user to initiate the restoration of a snapshot

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

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

Response Code: 200 (on success)
Response Body: JSON:
Code Block
{ "restoreId" : "" "status" : "" }
Possible value for status (see Get Restore Details)

Restore Complete

Purpose: Enables storage provider (Chronopolis) 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 restoration
Purpose: Enables DPN provider to notify bridge app that a DPN Bag Id (through the alternateIds in snapshotComplete) has an "update" to its history. Whether a bag was replicated, succesfully stored, checksumed, etc... this is the REST call to handle any and all updates to the history of a particular Snapshot/DPN Bag
Request: POST https://host:port/bridge/snapshot/(identifier)/history
- identifier - Either the snapshot ID or an alternate ID (such as a DPN bag ID) which was associated with the snapshot in the Snapshot Complete call
Request Body: JSON:
- Parameters
  - 'history' - single escaped JSON string that can contain a JSON array of objects or strings - the history event we're trying to record
  - 'alternate' - whether the snapshot ID in the URL is the alternate ID or the original snapshot ID.
- Preferred format (using name/value pairs)
  Code Block
  {"history": "[ {'key1' : 'value1'},{'key2' : 'value2'} ]", "alternate": "false"}
- Alternative formats (also supported, but UI display may not be ideal)

Code Block

Code Block
{ "snapshotstatus" : {SnapshotSummary},"" "historydetails" : "${the history string that was just inserted}" }

Panel

title	Restore Operations

Restore Snapshot

Get Restore Details

Purpose: Enables user to initiate the restoration Provides the status of a snapshotrestoration action
Request: PUTGET https://host:port/bridge/restore/(restoreId)
- restoreId - Identifier of the restoration
Response Code: 200 (on success)

Response Body: JSON:

Code Block
{ "restoreId" : "", "snapshotId" : "",
Code Block
{ "hoststatus" : "", "portstartDate" : "", "storeIdendDate" : "", "spaceIdstatusText" : "", "snapshotIddestinationHost" : "", "userEmaildestinationPort" : "", }

Response Code: 200 (on success)

Response Body: JSON:

Code Block
{ "restoreIddestinationStoreId" : "", "statusdestinationSpaceId" : "" }

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 restoration
Response Code: 200 (on success)
Response Body: JSON:
Code Block
{ "status" : "" "details" : "" }

Get Restore Details

Possible values for status:
- INITIALIZED
- RETRIEVING_FROM_STORAGE
- STORAGE_RETRIEVAL_COMPLETE
- VERIFYING_RETRIEVED_CONTENT
- VERIFYING_SNAPSHOT_REPO_AGAINST_MANIFEST
- TRANSFERRING_TO_DURACLOUD
- TRANSFER_TO_DURACLOUD_COMPLETE
- ```
VERIFYING_TRANSFERRED_CONTENT
```
- CLEANING_UP
- ERROR
- RESTORATION_COMPLETE
- ```
RESTORATION_EXPIRED
```
- ```
CANCELLED
```

Restart Restore

Purpose: Enables restart of restores that failed to transfer successfully to DuraCloud.
Request: POST
Purpose: Provides the status of a restoration action
Request: GET https://host:port/bridge/restore/(restoreId)/restart
- restoreId - Identifier of the restorationrestore
Request Body: JSON:
Code Block
{}
Response Code: 200 202 (on success)

Response Body: JSON:

Code Block
{ "restoreIdstatus" : "STORAGE_RETRIEVAL_COMPLETE", "description" : "" }

Cancel Restore

Purpose: Enables cancellation of a restore that is underway. Calls to this method will fail if the restore is in the CLEANING_UP or COMPLETE states.
Request: POST https://host:port/bridge/restore/(restoreId)/cancel
- restoreId - Identifier of the restoreId
Request Body: JSON:
Code Block
{}
Response Code: 200 (on success)

Response Body: JSON:

Code Block

{
  "status" : "CANCELLED"snapshotId" : "",
  "status" : "",
  "startDate" : "",
  "endDate" : "",
  "statusText" : "",
  "destinationHost" : "",
  "destinationPort" : "",
  "destinationStoreId" : "",
  "destinationSpaceIddescription" : ""
}

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

...

Page tree

Versions Compared

Old Version 45

New Version Current

Key

Initialize

Version

Version

Get Total Count of Snapshots

Get Total Size (bytes) of Snapshots

Get Total Files of Snapshots

Get All Totals (count, size, files) of Snapshots

Create Snapshot

List Snapshots

List Snapshot Contents

List Snapshot History

Get Snapshot Details

Snapshot Complete

Create Snapshot

List All Snapshots

List Snapshot Contents

Snapshot Error

Restart Snapshot

Cancel Snapshot

Get Snapshot Details

Snapshot Complete

Restart Snapshot

Snapshot History Update

Snapshot History Update

Request Snapshot Restore

Restore Snapshot

Restore Complete

Get Restore Details

Restore Complete

Get Restore Details

Restart Restore

Cancel Restore