/
Reporting

Reporting

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:

  1. /report/create: create a report – defining the data selection criteria

  2. /report/queue: queue the report – defining the processing and packaging requirements for the report delivery

  3. /report/status: check the status of the report progress – from queued to complete

  4. /report/list: get a list of current reports

  5. /report/detail: get a list of the details related to a particular report

  6. /report/delete: delete a report

  7. /report/columns: get a list of the columns supported by CSV reporting

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 while the XML output 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.

The details of the service calls are below.

/report/create

Method(s)

GET | POST

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 ucid.

For long ucid lists and complicated queries, the POST method should be used.

 

@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:

Note

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 of publication (YYYY)

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)

application-year

Year of filing (YYYY)

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

cpc-first-inventive

First inventive 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

Assignees/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 in English

original-claims

Claims in language of publication

espacenet-link

URL to espacenet

simple-family

List of ucids sharing the same family ID, as assigned by DOCDB

inpadoc-family

Extended family

legal-status

Legal status

title

English language title or, if not present, title in publication language

ifi-expiration

IFI anticipated patent expiration date

ifi-status

IFI patent status

ifi-publication-type

IFI publication type

ifi-adj-expiration

IFI adjusted patent expiration date

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

DOCDB-assigned 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.

 

@csv.datefmt

String. Available Options:

yyyy-mm-dd
dd/mm/yyyy
mm/dd/yyyy
yyyymmdd

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.