...
Example:
| Code Block |
|---|
wget -O- -q \ --header 'x-user:x' \ --header 'x-password:y' \ 'http://cdws21.ificlaims.com/report/create?name=a-csv-report&type=csv\ &source=list&criteria=US-20140255094-A1,ES-2478140-A8,ES-2486245-T3' |
Response JSON
| Code Block |
|---|
{
"status" : "success"
"time" : "0.015465",
"report" : {
"id" : "63cfdeb1-0162-444f-9ffa-a1ddd18de7d1"
},
}
|
response objectResponse Object | memberMember | valueValue |
|---|---|---|
| @status | success | error | |
| @time | Internal request time in seconds | |
| @report.id | Unique identifier of the report | |
| @message | In case of error, this may optionally contain the reason for failure |
...
| Method | GET | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Path | /report/queue | ||||||||||||||||||
| ParamParameter | 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. | |||||||||||||||||
Example:
| Code Block |
|---|
wget -O- -q \ --header 'x-user:x' \ --header 'x-password:y' \ 'http://cdws21.ificlaims.com/report/queue?id=99a479b9-4a73-4f27-b8b1-44b052844e23' |
Response JSON
| Code Block |
|---|
{
"status" : "success",
"time" : "0.064897"
"queue" : {
"id" : 257
},
}
|
response objectResponse Object | memberMember | valueValue |
|---|---|---|
| @status | success | error | |
| @queue.id | Report queue identifier (currently unused in other requests) | |
| @message | In case of error, this may optionally contain the reason for failure |
...
Example:
| Code Block |
|---|
wget -O- \ --header 'x-user:x' \ --header 'x-password:y' \ 'http://cdws21.ificlaims.com/report/status?id=99a479b9-4a73-4f27-b8b1-44b052844e23' |
Response JSON
| Code Block |
|---|
{
"time" : " 0.041137",
"status" : "success",
"report" : {
"percent_complete" : "0.000",
"completed_status" : null,
"completed_stamp" : null,
"ndocs" : 0,
"completed_error" : null,
"ndocs_processed" : 0,
"running_status" : "queued",
"entered_stamp" : "2014-09-28 14:52:57",
"completed_url" : null
},
}
|
response objectResponse Object | memberMember | valueValue |
|---|---|---|
| @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 |
...