...
Reporting provides a set of services to create, process, and retrieve either CSV extracts or XML extracts from CLAIMS Direct. Reports are available for six months after they are created. Please download any reports older than six months that you wish to keep. Reports can be downloaded through the API using https://cdws21.ificlaims.com/reports/<report-id>/<report-name>.
In brief, you can use the interface to do the following:
...
Note that whereas CSV reporting does allow you to select the columns or fields that you want included in the report, the XML output assumes you want the complete XML record. Also note that whereas while the XML output does allow allows for batching of the output into multiple files in order to keep file sizes manageable, the CSV report assumes you want everything in one file.
...
Method(s) | GET | POST | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Path | /report/create | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Parameter | Values | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
@name | String: ex. test-report-01 | Report name. Special Unix/Linux characters may not be used in report names. Valid characters include alphas, numerics, dashes, and underscores. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
@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. |
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' |
@csv.datefmt | String. Available Options: yyyy-mm-dd Ex. csv.datefmt=mm/dd/yyyy | (v3.9.1) The format of date output for the CSV columns: Publication Date, Application Date, Priority Date, Date Produced, IFI Expiration and IFI Adjusted Expiration dates. |
Example:
Code Block | ||
---|---|---|
| ||
{wget -O- -q \ "status" : "success"--header 'x-user:x' \ "time" : "0.015465", "report" : { "id" : "63cfdeb1-0162-444f-9ffa-a1ddd18de7d1" }, } |
...
...
...
...
--header 'x-password:y' \
'https://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 Object | Member | Value |
---|---|---|
@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 |
...
Example:
Code Block | ||
---|---|---|
| ||
wget -O- -q q \ --header 'x-user:x' \ --header 'x-password:y' \ 'httphttps://cdws21.ificlaims.com/report/queue?id=99a479b9-4a73-4f27-b8b1-44b052844e23' |
Response JSON
Code Block | ||
---|---|---|
| ||
{ "status" : "success", "time" : "0.064897" "queue" : { "id" : 257 }, } |
...
Example:
Code Block | ||
---|---|---|
| ||
wget -O- \ --header 'x-user:x' \ --header 'x-password:y' \ 'httphttps://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 }, } |
...
Code Block | ||
---|---|---|
| ||
wget -O- \ --header 'x-user:x' \ --header 'x-password:y' \ 'httphttps://cdws21.ificlaims.com/report/list?limit=1' |
...
Code Block | ||
---|---|---|
| ||
{ "time" : "0.010817", "status" : "success", "reports" : [ { "batchprefix" : "batch", "source" : "list", "name" : "a-csv-report", "solrurl" : "httphttps://10.234.1.44:6000/alexandria-v2.1/alexandria", "batchsize" : 200, "completed_status" : null, "package_compression" : "zip", "package_sfx" : "csv", "completed_stamp" : null, "completed_error" : null, "running_status" : "queued", "solrparams" : null, "type" : "csv", "entered_stamp" : "2014-09-28 14:52:57.15773", "completed_url" : null, "id" : "63cfdeb1-0162-444f-9ffa-a1ddd18de7d1", "criteria" : "US-20140255094-A1,ES-2478140-A8,ES-2486245-T3", "package_type" : "single", "report_id" : 276, "csvopts" : "csv.nonl=1&csv.cols=__all__&csv.maxcolsize=32768&csv.header=1", "nthreads" : 4, "user_id" : 4, "process_id" : 257, "ndocs" : 0, "ndocs_processed" : 0 } ] } |
...
Code Block | ||
---|---|---|
| ||
{ "time" : " 0.012368", "status" : "success", "report" : { "name" : "a-csv-report", "batchprefix" : "batch", "source" : "list", "completed_status" : null, "completed_stamp" : null, "package_sfx" : "csv", "package_compression" : "zip", "completed_error" : null, "solrurl" : "httphttps://10.234.1.44:6000/alexandria-v2.1/alexandria", "batchsize" : 200, "completed_url" : null, "criteria" : "US-20140255094-A1,ES-2478140-A8,ES-2486245-T3", "tracker_id" : "63cfdeb1-0162-444f-9ffa-a1ddd18de7d1", "tracker_id" : "63cfdeb1-0162-444f-9ffa-a1ddd18de7d1 "report_id" : 276, "package_type" : "single", "solrparams" : null, "running_status" : "queued", "type" : "csv", "entered_stamp" : "2014-09-28 14:52:57.15773", "nthreads" : 4, "user_id" : 4, "process_id" : 257, "ndocs" : 0, "ndocs_processed" : 0, "csvopts" : "csv.nonl=1&csv.cols=__all__&csv.maxcolsize=32768&csv.header=1" }, } |
/report/delete
Method | GET | ||
---|---|---|---|
Path | /report/delete | ||
Parameter | Values | Description | |
@id | String: ex. e16eebc9-6965-41a4-9337-8f76d8953a89 | Report identifier |
Response JSON
Code Block | ||
---|---|---|
| ||
{ "status" : "success", "time" : " 0.010436"report_id, } |
/report/columns
Method | GET | ||
---|---|---|---|
Path | /report/columns |
Response JSON
Code Block | ||
---|---|---|
| ||
{ "time" : 276 " 0.008741", "package_typestatus" : "singlesuccess", "solrparamscolumns" : null,[ "running_status" : "queued"document-ucid", "type" : "csv"document-country", "entered_stamp" : "2014-09-28 14:52:57.15773document-number", "nthreads" : 4document-kind", "user_id" : 4document-date", "process_id" : 257document-year", "ndocs" : 0application-ucid", "ndocs_processed" : 0application-country", "csvopts" : "csv.nonl=1&csv.cols=__all__&csv.maxcolsize=32768&csv.header=1" }, } |
/report/delete
...
Path
...
/report/delete
...
Response JSON
Code Block | ||
---|---|---|
| ||
{ "status" : "success"application-number", "application-kind", "application-date", "application-year", "time" : " 0.010436priority-number", } |
/report/columns
Method | GET | ||
---|---|---|---|
Path | /report/columns |
Response JSON
Code Block | ||
---|---|---|
| ||
{ "time" : " 0.006634priority-country", "status" : "successpriority-date", "columns" : [priority-year", "documentus-class-numberprimary", "documentus-countryclass", "document-kindcpc", "documentcpc-first-dateinventive", "document-yearipcr", "application-numberipc", "application-dateecla", "priorityf-numberterms", "prioritypatent-countrycitations", "priorityforward-datecitations", "prioritynon-patent-yearcitations", "titlerelated-applications", "usassignee-class-primaryapplicant", "usepo-assignee-classapplicant", "cpcinventor", "ipcragent", "ipccorrespondent", "eclaexaminer", "fpct-application-termsnumber", "patentdesignated-citationsstates", "forward-citationsabstract", "nonfirst-patent-citationsclaim", "relatedenglish-applicationsclaims", "assigneeoriginal-applicantclaims", "standardizedespacenet-assignee-applicantlink", "simple-family"inventor", "agentinpadoc-family", "correspondentlegal-status", "examinertitle", "pctifi-application-numberexpiration", "designatedifi-statesstatus", "abstractifi-publication-type", "englishifi-adj-claimsexpiration", "originalifi-claimsassignee", "espacenetifi-assignee-linkoriginal", "simpleifi-assignee-familycurrent", "inpadocifi-assignee-familyprobable", "legalfamily-statusid", "ifiload-statusid", "ifidate-expirationproduced" ] } |