Bridge Application
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:
{ "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"}
Ingest Operations
Create Snapshot
- Purpose: Performs a snapshot action
- Request:
POST https://host:port/bridge/snapshots
Request Body:
{ "host" : "", "port" : "", "storeId" : "", "spaceId" : "", "snapshotId": "" }
- 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
- snapshotID - Identifier of the snapshot
- Response Code: 200 (on success)
Response Body: JSON:
{ "snapshotId" : "", "status": "" }
List All Snapshots
- Purpose: Performs a snapshot action
- Request:
GET https://host:port/bridge/snapshots
Request Body:
Response Body: JSON:
[ "snapshot1", "snapshot2", "snapshot3" ]
Snapshot Status
- Purpose: Provides the status of a snapshot action
- Request:
GET https://host:port/bridge/snapshots/(snapshotId)
- snapshotID - Identifier of the snapshot
- Response Code: 200 (on success)
Response Body: JSON:
{"status" : ""}
Possible values for status:
- ?
Restore Operations
Restore Snapshot
- Purpose: Enables user to initiate the restoration of a snapshot
- Request:
POST https://host:port/bridge/snapshots/(snapshotID)/restore
- snapshotID - Identifier of the snapshot
- Response Code: 200 (on success)
Response Body: JSON:
{"status" : ""}
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/snapshots/(snapshotID)/restore/complete
- snapshotID - Identifier of the snapshot
- Response Code: 200 (on success)
- Response Body: JSON:
{"status" : ""}