GET /bridge
Response Body: JSON
{ "bridge-version" : "", "supported-checksum-types" : "" # Possible values: MD5, SHA-256, SHA-512 } |
POST /bridge/register
Request Body: JSON
{ "gateway-url" : "", # Endpoint URL where the Bridge can call back to this OTM API "gateway-username" : "", # Credentials to allow the Bridge to make calls back into the OTM API "gateway-password" : "" # Credentials to allow the Bridge to make calls back into the OTM API } |
POST /bridge/deposit ? {checksum-type}
checksum-type
: (Optional) Applies to all file checksums (can be one of: MD5, SHA-256, SHA-512). Default is MD5.Request Body: JSON
{ "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-1-checksum", "file-2-id" : "file-2-checksum" }, "filegroup-2-id" : { "file-3-id" : "file-1-checksum", "file-4-id" : "file-2-checksum" } } |
Notes:
There is no guarantee that all filegroups in a single deposit request will be deposited into the DDP at the same time. This allows the Bridge to manage transfers based on available resources (so as to not over-run local disk, for example).
GET /bridge/deposit ? {status}
status:
(Optional) Limit list to deposits in a specific statusResponse Body: JSON
{ "filegroup-1-id" : { "files" : "", # Number of files in deposit "status" : "" # Current deposit status }, # Additional filegroups listed here } |
GET /bridge/deposit/{filegroup-id}
Response Body: JSON
{ "filegroup-id" : "", "status" : "", # Value based on defined set of known status states # There could be more information here, like an approximate percentage completion of the current step, if known } |
POST /bridge/delete ? {checksum-type}
# Using POST rather than DELETE, allows for deleting multiple files (and is consistent with Restore action)checksum-type
: (Optional) if provided, applies to all file checksums (can be one of: MD5, SHA-256, SHA-512). Default is MD5.Request Body: JSON
{ "filegroup-1-id" : { "file-1-id" : "file-1-checksum", # Checksum is optional, can be included to verify correct file is being deleted "file-2-id" : "file-2-checksum" }, # Additional filegroups listed here } |
Response Body: JSON
{ "delete-id" : "" } |
GET /bridge/delete ? {status}
status:
(Optional) Limit list to deletes actions with a specific statusResponse Body: JSON
{ "delete-id-1" : { "files" : "", # Number of files in delete action "status" : "" # Current delete status }, # Additional delete actions listed here } |
GET /bridge/delete/{delete-id}
Response Body: JSON
{ "status" : "" } # This could include a top level status or a per-file status (or both) |
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 listedResponse Body: JSON
{ "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
{ "filegroup-1-id", "filegroup-2-id", ... } |
or
{ "file-1-id", "file-2-id", ... } |
POST /bridge/restore ? {checksum-type}
checksum-type
: (Optional) if provided, applies to all file checksums (can be one of: MD5, SHA-256, SHA-512). Default is MD5.Request Body: JSON
{ "filegroup-1-id" : { "file-1-id" : "file-1-checksum", # Checksum is optional, can be included to verify correct file is being restored "file-2-id" : "file-2-checksum" }, # Additional filegroups listed here } |
Response Code: 202 (on success)
Response Body: JSON
{ "restore-id" : "" } |
GET /bridge/restore ? {status}
status:
(Optional) Limit list to restores actions with a specific statusResponse Body: JSON
{ "restore-id-1" : { "files" : "", # List of files in restore action "status" : "" # Current restore status }, # Additional restore actions listed here } |
GET /bridge/restore/{restore-id}
Response Body: JSON
{ "files" : "", # List of files in restore action "status" : "" # This could include a top level status or a per-file status (or both) } |
GET /bridge/restore/{restore-id}/{filegroup-id}/{file-id} ? {checksum-type}
filegroup-id:
The identifier of the filegroup for the restored filefile-id:
The identifier of the restored file to retrievechecksum-type
: (Optional) Defines the type of checksum to be included in the response ETag header. Can be one of: MD5, SHA-256, SHA-512. Default is MD5.Response: Restored file content stream
GET /bridge/audit/{filegroup-id}/{file-id}
filegroup-id:
The identifier of the filegroup for which an audit report is requestedfile-id:
(Optional) The identifier of the file for which an audit report is requested. If this is not provided the audit report is requested based on the filegroup-id.Response Body: JSON
{ "file-1-id" : { "audit-event-1", "audit-event-2", }, } |
POST /bridge/account/{account-name}
account-name:
The name associated with an accountResponse Body: JSON
{ "account-name" : "", # Name of the account "account-username" : "", # Credentials to allow calls to the Bridge for this account "account-password" : "" # Credentials to allow calls to the Bridge for this account } |
GET /bridge/account
Response Body: JSON
{ "account-1-name", "account-2-name" } |
POST /bridge/deposit/{filegroup-id}
POST /bridge/delete/{delete-id}
POST /bridge/restore/{restore-id}
POST /bridge/audit/{id}
id:
The identifier for the file or filegroup to which this audit event is to be appliedRequest Body: JSON
{ "audit-event" } |