Page History

...

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.

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

...

Code Block

language	text

{
   "time" : " 0.006634008741",
   "status" : "success",
   "columns" : [
      "document-numberucid",
      "document-country",
      "document-number",
      "document-kind",
      "document-date",
      "document-year",
      "application-numberucid",
      "application-datecountry",
      "priorityapplication-number",
      "priorityapplication-countrykind",
      "priorityapplication-date",
      "priorityapplication-year",
      "titlepriority-number",
      "uspriority-class-primarycountry",
      "us-classpriority-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",
      "standardizedepo-assignee-applicant",
      "inventor",
      "agent",
      "correspondent",
      "examiner",
      "pct-application-number",
      "designated-states",
      "abstract",
      "englishfirst-claimsclaim",
      "originalenglish-claims",
      "espacenetoriginal-linkclaims",
      "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 22

New Version 23

Key