...
Method(s) | GET | POST | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Path | /report/create | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Parameter | Values | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
@name | String: ex. test-report-01 | Report name | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
@type | String: ex. csv | Report type, one of 'csv' or 'xml' (default=xml) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
@source | String: ex. search | Report source, one of 'search', 'list' or 'table' (default=list) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
@criteria | String: ex. pnctry:us AND solar | Report criteria. Depending on @source, this will be either a valid SOLR search query, a space, comma or new-line-separated list of ucids or an existing schema-qualified DWH table name containing the required column | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
@solrparams | unused, set internally | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
@solrurl | unused, set internally | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
The following options pertain to @type = csv | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
@csv.cols | String: ex. c1,c2 | Comma-separated list of columns to include. Columns will be output in order given.
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
@csv.header | Bool: ex. 1 | [ 0 | 1 ] Include column headers | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
@csv.nonl | Bool: ex. 1 | [ 0 | 1 ] Replace new lines (nl) with spaces | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
@csv.maxcolsize | Integer: ex. 32 | The maximum number of bytes allowed per column (overflow will be truncated). This value is assumed to be Kilobytes. |
...
Method | GET | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Path | /report/queue | ||||||||||||||||||
Parameter | Values | Description | |||||||||||||||||
@id | String: ex. e16eebc9-6965... | Report identifier | |||||||||||||||||
@nthreads | Integer: ex. 4 | Maximum number of backend processes used to generate report (2, 4 or 8, default=4) | |||||||||||||||||
@batchsize | Integer: ex. 100 | Number of documents to process per thread (default=200) | |||||||||||||||||
@batchprefix | String: ex. my-prefix | Output file name(s) prefix. For example, running an xml report with @package_type=batched, output tar file will contain: <report-name>.tar: Default=batch | |||||||||||||||||
@package_type | String: ex. archived | Report package type. Valid types include:
| |||||||||||||||||
@package_suffix | Unused: generated internally based on package_type and package_compression | The following table shows the generated suffix:
| |||||||||||||||||
@package_compression | String: ex. gzip | Valid values are one of: __none__ (default), gzip or zip | |||||||||||||||||
@priority | Integer: ex. 1 | Setting a priority > 0 will prioritize processing of report higher. Default behavior is to process each report in order of en-queue. |
...
Response Object | Member | Value |
---|---|---|
@status | success | error | |
@message | In case of error, this may optionally contain the reason for failure | |
@report.entered_stamp | Time stamp when report was queued for processing | |
@report.running_status | Stage of processing:
| |
@report.completed_url | When complete, the url of package | |
@report.completed_status | success | error | |
@report.completed_error | If @completed_status == 'error', this may contain an optional error message pertaining to processing | |
@report.completed_stamp | Time stamp report processing completed | |
@report.ndocs | Total number of documents in report. Note: This value will be 0 until @running_status completes the preparation (preparing) stage. | |
@report.ndocs_processed | Total number of documents already processed | |
@report.percent_complete | Convenience value of @ndocs_processed / @ndocs as a floating point, e.g., 0.000 |
...