Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Panel
titleInitialization REST Methods

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.

...

DuraBoss

Purpose: DuraReport generates DuraBoss provides administrative control over generating reports relating to the status of your DuraCloud instance, maintaining content audit logs, and producing content manifests. Additionally, it provides a simple interface for accessing those reportsmanaging the execution of these controls.

Resources: XML schema which defines the expected transfer data for storage and service reporting can be found on the Downloads page

Panel
titleInitialization REST Methods

Initialize Application

  • Purpose: Allows the initialization of durareportduraboss
  • Request: POST https://host:port/durareportduraboss/initImage Modified
  • Request Body: XML similar to:
    Code Block
    xml
    xml
    
    <durareportConfig>
    <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>
      </notificationConfig>
    </durareportConfig>durabossConfig>
    
  • Response Code: 200 (on success)
  • Response Body: "Initialization Successful" (on success)

Is Initialized

  • Purpose: Performs a check to determine if the DuraReport DuraBoss application has been initialized
  • Request: GET https://host:port/durareportduraboss/initImage Modified
  • 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.

...