Reporting provides a set of services to create, process, and retrieve either CSV extracts or XML extracts from CLAIMS Direct.
In brief, to 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 the XML output does allow for batching of the output into multiple files in order to keep file sizes manageable, the CSV report assume 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 |
| | @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 ucid. |
| | @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.
Currently available columns: | Info |
|---|
| Columns containing multiple values will be separated by the '|' character, e.g. US | EP | WO |
| Column | Description |
|---|
| document-ucid | Document identifier (ucid) | | document-country | Country of publication | | document-number | Patent/Publication number | | document-kind | Publication kind code | | document-date | Date of publication (YYYYMMDD) | | document-year | Year (YYYY) of publication | | application-ucid | Application filing identifier (ucid) | | application-country | Filing country | | application-number | Filing number | | application-kind | Filing kind code | | application-date | Date of filing (YYYYMMDD) | | priority-number | Priority numbers (ucids) | | priority-country | Priority countries | | priority-date | Priority filing dates (YYYYMMDD) | | priority-year | Priority filing years (YYYY) | | us-class-primary | Primary US classification | | us-class | All US classifications | | cpc | CPC | | ipcr | IPCR | | ipc | IPC | | ecla | ECLA | | f-terms | F-terms | | patent-citations | Patent citations | | non-patent-citations | Non-patent-citations | | forward-citations | Forward citations | | related-applications | Related applications | | assignee-applicant | Assignee / Applicants | | epo-assignee-applicant | DOCDB standardized Assignees / Applicants | | inventor | Inventors | | agent | Agents | | correspondent | Correspondent | | examiner | Examiner | | pct-application-number | PCT filing number (ucid) | | designated-states | EP and PCT designated states | | abstract | English Abstract or, if no English abstract exists, the abstract in the language of publication | | first-claim | First claim | | english-claims | Claims | | original-claims | Claims in language of publication | | espacenet-link | URL to espacenet | | simple-family | List of ucids sharing the same family id | | inpadoc-family | Extended family | | legal-status | Legal status | | title | Enlish English language title or, if not present, title in publication language | | ifi-expiration | IFI Patent Expiration | | ifi-status | IFI Patent Status | | ifi-adj-expiration | IFI Adjusted Patent Expiration | | ifi-assignee | IFI Assignee | | ifi-assignee-original | Original, as published, assignee | | ifi-assignee-current | Current IFI assignee | | ifi-assignee-probable | Probable IFI assignee | | family-id | Simple family integer identifier | | load-id | modified-load-id | | date-produced | Date on which CLAIMS Direct XML was produced |
|
| | @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. |
...
| | |
|---|
| | @status | success | error |
| | @time | internal request time in seconds |
| | @report.id | the unique identifier of the report. |
| | @message | In case of error, this may optionally contain the reason for failure |
...