Versions Compared

Key

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

...

Panel
titleInitialization REST Methods

Initialize Stores

  • Purpose: Allows the initialization of storage provider accounts
  • Request: POST https://host:port/durastore/init
  • Request Body: XML similar to:

    Code Block
    xml
    xml
    <storageProviderAccounts>
      <storageAcct ownerId='0' isPrimary='true'>
        <id>1</id>
        <storageProviderType>AMAZON_S3</storageProviderType>
        <storageProviderCredential>
          <username>username</username>
          <password>password</password>
        </storageProviderCredential>
      </storageAcct>
      <storageAudit>
        <auditUsername>audit-username</auditUsername>
        <auditPassword>audit-password</auditPassword>
        <auditQueue>audit-queue-name</auditQueue>
      </storageAudit>
      <!-- optional -->
      <millDbConfig>
        <name>db-name</name>
        <host>db-host</name>
        <port>db-port</name>
        <username>db-username</username>
        <password>db-password</password>
      </millDbConfig>
    </storageProviderAccounts>
    
  • Response Code: 200 (on success)
  • Response Body: "Initialization Successful" (on success)

Is Initialized

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

...

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>
      <!--optional-->
      <millDbEnabled>[true or false]</millDbEnabled>
    </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.

...