...

{"message": "STORAGE_UNIT_DOESNT_EXIST"}

Dump Storage Unit

Dumps all transactions and returns the content and transaction collections records of a storage unit in a zip file.. Dump is a two step process: create the dump file and download the dump file.

Create Dump

Request

The create dump storage unit GET /POST request requires the name of the storage unit to dump.

GET admin/dumpcreateDump/<storage-unit-name>

If the storage unit exists, a 200 response code and a zip file are returned fileId to call the download dump request.

If the storage unit doesn't exist, a 400 response code with a STORAGE_UNIT_DOESNT_EXIST message is returned.

 {"message": "STORAGE_UNIT_DOESNT_EXIST"}

Download Dump

Request

The download dump GET request requires the fileId returned by the create dump request.

GET admin/downloadDump/<file-id>

Response

If the file id exists, but the dump file is in process of being created, a 200 response code with an IN_PROGRESS message is returned.

 {"message": "IN_PROGRESS"}

 {"message": "INVALID_DUMP_FILE_ID"}

Anchor
Configure Storage Unit Configure Storage Unit

Configure Storage Unit

...

 {
    "modules" : {
        "connector": [ 
            {
                "module" : "AspireFieldMapping"
            },
            {
                "settings" : {
                    "elasticsearch-index" : "aspiredocs",
                    "elasticsearch-type" : "aspiredoc"
                },
                "module" : "ESPublisher"
            }
        ], 
        "index" : [ 
            {
                "module" : "FieldMapping"
            }, 
            {
                "settings" : {
                    "elasticsearch-index" : "researchdocs",
                    "elasticsearch-type" : "researchdoc"
                },
                "module" : "ESPublisher"
            }
        ],
        "research" : [ 
            {
                "module" : "NormalizeCategory"
            }
        ]
    },
    "settings" : {
        "elasticsearch-port" : 9200,
        "elasticsearch-server" : "localhost"
    }
}

The storage unit PUT/POST set content processing modules request requires the name of the storage unit in the URL and receives a JSON in the body with the content processing modules configuration. This will replace any previous stored configuration for the storage unit.

...

{
    "modules" : {
        "connector": [ 
            {
                "module" : "FieldMapping"
            },
            {
                "settings" : {
                    "elasticsearch-index" : "aspiredocs",
                    "elasticsearch-type" : "aspiredoc"
                },
                "module" : "ESPublisher"
            }
        ], 
        ...
    },
    "settings" : {
        "elasticsearch-port" : 9200,
        "elasticsearch-server" : "localhost"
    }
}

If the operation is successful, a 200 response code and an OK message are returned.

...

Enables or disables content processing for a storage unit.

Request

The storage unit GET/POST enable content processing request requires the name of the storage unit and a boolean value to indicate whether to enable (true) or disable (false) content processing. When a storage unit is created, content processing is enabled by default.

...

POST admin/enableContentProcessing/<storage-unit-name>/false

Response

If the operation is successful, a 200 response code and an OK message are returned.

...

Enables or disables content compression for a storage unit. When enabled, the JSON documents are compressed before encryption happens for storage.

Request

The storage unit GET/POST enable content compression request requires the name of the storage unit and a boolean value to indicate whether to enable (true) or disable (false) content processing. By default compression is disabled.

...

POST admin/enableContentCompression/<storage-unit-name>/false

Response

If the operation is successful, a 200 response code and an OK message are returned.

...

Enables or disables the background reprocessing queue of a storage unit. When enabled, automatic and manual reprocess requests will execute the Process document events configured for documents being reprocessed.

Request

The storage unit GET/POST enable reprocessing queue request requires the name of the storage unit and a boolean value to indicate whether to enable (true) or disable (false) content processing. By default the reprocessing queue is enabled.

...

POST admin/enableContentCompression/<storage-unit-name>/false

Response

If the operation is successful, a 200 response code and an OK message are returned.

...

Get the current storage unit configuration (content processing).

Request

The storage unit GET/POST get configuration request requires the name of the storage unit in the URL.

 POST admin/getConfiguration/<storage-unit-name>

Response

If the operation is successful, a 200 response code and the storage unit JSON configuration.

...