Page History

Initialize Application

• Purpose: Allows the initialization of duradmin
• Request: POST https://host:port/duradmin/init

• Request Body: XML similar to:

  Code Block
  xml xml
  <duradminConfig> <durastoreHost>[host]</durastoreHost> <durastorePort>[port]</durastorePort> <durastoreContext>durastore</durastoreContext> <duraserviceHost>[host]</duraserviceHost> <duraservicePort>[port]</duraservicePort> <duraserviceContext>duraservice</duraserviceContext> </duradminConfig>

• Response Code: 200 (on success)
• Response Body: "Initialization Successful" (on success)

Is Initialized

• Purpose: Performs a check to determine if the DurAdmin application has been initialized
• Request: GET https://host:port/duradmin/init
• Response Code: 200 (if the application has been initialized), 503 (if the application has NOT been initialized)
• Response Body: Text indicating whether initialization has occurred.

Initialize Application

• Purpose: Allows the initialization of duraboss
• Request: POST https://host:port/duraboss/init

• Request Body: XML similar to:

  Code Block
  xml xml
  <durabossConfig> <reporterEnabled>[true|false]</reporterEnabled> <executorEnabled>[true|false]</executorEnabled> <auditorEnabled>[true|false]</auditorEnabled> <durastoreHost>[host]</durastoreHost> <durastorePort>[port]</durastorePort> <durastoreContext>durastore</durastoreContext> <duraserviceHost>[host]</duraserviceHost> <duraservicePort>[port]</duraservicePort> <duraserviceContext>duraservice</duraserviceContext> <notificationConfig> <type>EMAIL</type> <username>[username for notification system]</username> <password>[password for notification system]</password> <originator>[from email address]</originator> <admin>[administrator email address]</admin> </notificationConfig> </durabossConfig>

• Response Code: 200 (on success)
• Response Body: "Initialization Successful" (on success)

Is Initialized

• Purpose: Performs a check to determine if the DuraBoss application has been initialized
• Request: GET https://host:port/duraboss/init
• Response Code: 200 (if the application has been initialized), 503 (if the application has NOT been initialized)
• Response Body: Text indicating whether initialization has occurred.

Get Latest Storage Report

• Purpose: Provides the most current storage report in XML format
• Request: GET https://host:port/duraboss/report/storage
• Response Code: 200 (on success)
• Response Body: XML, defined by the storage report XSD

Get Storage Report List

• Purpose: Provides a list of all storage report IDs
• Request: GET https://host:port/duraboss/report/storage/list
• Response Code: 200 (on success)
• Response Body: XML, defined by the storage report XSD

Get Storage Report

• Purpose: Provides a specific storage report based on the provided report ID
• Request: GET https://host:port/duraboss/report/storage/reportID
• Response Code: 200 (on success)
• Response Body: XML, defined by the storage report XSD

Get Storage Report Info

• Purpose: Provides a information about the current status of the storage reporting system
• Request: GET https://host:port/duraboss/report/storage/info
• Response Code: 200 (on success)
• Response Body: XML, defined by the storage report XSD

Start Storage Report

• Purpose: Starts a storage report if one is not already running
• Request: POST https://host:port/duraboss/report/storage
• Response Code: 200 (on success)
• Response Body: "Report Started" (on success), or ""Report Already In Progress" (if a report is already in progress)

Cancel Storage Report

• Purpose: Cancels a running storage report
• Request: DELETE https://host:port/duraboss/report/storage
• Response Code: 200 (on success)
• Response Body: "Storage report cancelled"

Schedule Storage Report

• Purpose: Schedules a time for a storage report to be run
• Request: POST https://host:port/duraboss/report/storage/schedule ? (startTime) (frequency)
  
  • startTime: time (in milliseconds since the epoch) to begin the next storage report
  • frequency: time (in milliseconds) to wait between running reports (minimum value is 600000)
• Response Code: 200 (on success)
• Response Body: "Storage reports scheduled" (on success)

Cancel Storage Report Schedule

• Purpose: Cancels all entries on the storage report schedule
• Request: DELETE https://host:port/duraboss/report/storage/schedule
• Response Code: 200 (on success)
• Response Body: "Storage Reports schedule cancelled"

Get Deployed Services Report

• Purpose: Provides a listing of the services which are currently deployed
• Request: GET https://host:port/duraboss/report/service/deployed
• Response Code: 200 (on success)
• Response Body: XML, defined by the service report XSDs

Get Completed Services Report

• Purpose: Provides a listing of the most recent completed services
• Request: GET https://host:port/duraboss/report/service ? (limit)
  
  • Parameter value for limit (optional) should indicate the maximum number of services to return in the report (default is 20, max is 1000)
• Response Code: 200 (on success)
• Response Body: XML, defined by the service report XSDs

Get Completed Services Report List

• Purpose: Provides a listing of all service report IDs
• Request: GET https://host:port/duraboss/report/service/list
• Response Code: 200 (on success)
• Response Body: XML, defined by the service report XSDs

Get Services Report

• Purpose: Provides a specific services report based on the provided report ID
• Request: GET https://host:port/duraboss/report/service/reportID
• Response Code: 200 (on success)
• Response Body: XML, defined by the service report XSDs

Get Executor Status

• Purpose: Provides a status of the Executor, which is the collected status of all Action Handlers
• Request: GET https://host:port/duraboss/exec
• Response Code: 200 (on success)
• Response Body: XML serialization of status map

Get Supported Executor Actions

• Purpose: Provides a listing of the actions which the Executor can perform
• Request: GET https://host:port/duraboss/exec/action
• Response Code: 200 (on success)
• Response Body: XML serialization of the action set

Executor Actions

Perform an Executor Action

• Purpose: Performs a specific Executor action based on the provided actionName
• Request: POST https://host:port/duraboss/exec/actionName
• Response Code: 200 (on success)

Shutdown Executor

• Purpose: Requests that the Executor perform a graceful shutdown
• Request: DELETE https://host:port/duraboss/exec
• Response Code: 200 (on success)

Create Initial Audit Log

• Purpose: Requests the creation of initial audit logs, and removal of any existing audit logs
• Request: POST https://host:port/duraboss/audit
• Response Code: 202 (on acceptance)

Get Audit Logs

• Purpose: Provides a listing of the audit logs for the provided spaceId
• Request: GET https://host:port/duraboss/audit/spaceId
• Response Code: 200 (on success)
• Response Body: Plain text listing of audit log contentIds

Shutdown Auditor

• Purpose: Requests that the Auditor perform a graceful shutdown
• Request: DELETE https://host:port/duraboss/audit
• Response Code: 200 (on success)
• Response Body: Plain text of "auditor shutting down"

Get Content Manifest

• Purpose: Requests the content manifest for the provided spaceId, in the requested format, as of the provided date, and for the provided storeID
• Request: GET https://host:port/duraboss/manifest/spaceId ? (format) (date) (storeID)
  
  • Parameter options for format (optional)
    
    1. tsv (default) - Produces content manifest in tab-separated-value format
    2. bagit - Produces content manifest in BagIt format
  • Parameter options for date (optional, current datetime is default)
    
    1. Any formatted date of the form: 'yyyy-MM-dd'T'HH:mm:ss.sss' or 'yyyy-MM' or any form in between these two
  • Parameter options for storeID (optional, default is primary store)
• Response Code: 200 (on success)
• Response Body: Plain text content manifest in the requested format