Page History

...

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

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.

Warning

Warning

Icon

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:

Info

title	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 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 DocDBDOCDB
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	DocDBDOCDB-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. 32The maximum number of bytes allowed per column (overflow will be truncated). This value is assumed to be Kilobytes.: 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.

Example:

Code Block

language	text

wget -O- -q \
  --header 'x-user:x' \
  --header 'x-password:y' \
'httphttps://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

language	text

{
   "status" : "success"
   "time" : "0.015465",
   "report" : {
      "id" : "63cfdeb1-0162-444f-9ffa-a1ddd18de7d1"
   },
}

...

Example:

Code Block

language	text

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

language	text

{
   "status" : "success",
   "time" : "0.064897"
   "queue" : {
      "id" : 257
   },
}

...

Example:

Code Block

language	text

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

language	text

{
   "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

language	text

wget -O- \
  --header 'x-user:x' \
  --header 'x-password:y' \
'httphttps://cdws21.ificlaims.com/report/list?limit=1'

...

Code Block

language	text

{
   "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

language	text

{
   "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",
      "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"
   },
}

...

Method	GET
Path	/report/columns

Response JSON

Code Block

language	text

{
   "time" : " 0.008741",
   "status" : "success",
   "columns" : [
      "document-ucid",
      "document-country",
      "document-number",
      "document-kind",
      "document-date",
      "document-year",
      "application-ucid",
      "application-country",
      "application-number",
      "application-kind",
      "application-date",
      "application-year",
      "priority-number",
      "priority-country",
      "priority-date",
      "priority-year",
      "us-class-primary",
      "us-class",
      "cpc",
      "cpc-first-inventive",
      "ipcr",
      "ipc",
      "ecla",
      "f-terms",
      "patent-citations",
      "forward-citations",
      "non-patent-citations",
      "related-applications",
      "assignee-applicant",
      "epo-assignee-applicant",
      "inventor",
      "agent",
      "correspondent",
      "examiner",
      "pct-application-number",
      "designated-states",
      "abstract",
      "first-claim",
      "english-claims",
      "original-claims",
      "espacenet-link",
      "simple-family",
      "inpadoc-family",
      "legal-status",
      "title",
      "ifi-expiration",
      "ifi-status",
      "ifi-publication-type",
      "ifi-adj-expiration",
      "ifi-assignee",
      "ifi-assignee-original",
      "ifi-assignee-current",
      "ifi-assignee-probable",
      "family-id",
      "load-id",
      "date-produced"
   ]
}

...

Page tree

Versions Compared

Old Version 23

New Version Current

Key