Versions Compared

Old Version 2

changes.mady.by.user David Santamauro

Saved on

compared with

New Version 3

changes.mady.by.user David Santamauro

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Method(s)GET | POST

Path

/report/create

Parameter ValuesDescription
 @nameString: ex. test-report-01Report name
 @typeString: ex. csvReport type, one of 'csv' or 'xml' (default=xml)
 @sourceString: ex. searchReport source, one of 'search', 'list' or 'table' (default=list)
 @criteriaString: 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.

 @solrparamsunused, set internally 
 @solrurlunused, set internally 
 The following options pertain to @type = csv
 @csv.colsString: ex. c1,c2

Comma-separated list of columns to include. Columns will be output in order given.
Currently available columns:

Info
titleNote

Columns containing multiple values will be separated by the '|' character, e.g. US | EP | WO

ColumnDescription
document-numberucidDocument identifier (ucid)
document-countryCountry of publication
document-numberPatent/Publication number
document-kindKind Publication kind code
document-dateDate of publication (YYYYMMDD)
document-yearYear (YYYY) of publication
application-numberucidApplication filing identifier (ucid)
application-countryFiling country
application-numberFiling number
application-kindFiling kind code
application-dateData Date of filing (YYYYMMDD)
priority-numberPriority numbers (ucids)
priority-countryPriority countries
priority-datePriority filing dates (YYYYMMDD)
priority-yearPriority filing years (YYYY)titleEnglish title of document, or, if no English title exists, the title in the language of publication
us-class-primaryPrimary US classification
us-classAll US classifications
cpcCPC
ipcrIPCR
ipcIPC
eclaECLA
f-termsF-terms
patent-citationsPatent citations
non-patent-citationsNon-patent-citations
forward-citationsForward citations
related-applicationsRelated applications
assignee-applicantAssignee / Applicants
standardizedepo-assignee-applicantDOCDB standardized Assignees / Applicants
inventorInventors
agentAgents
correspondentCorrespondent
examinerExaminer
pct-application-numberPCT filing number (ucid)
designated-statesEP and PCT designated states
abstractEnglish Abstract or, if no English abstract exists, the abstract in the language of publication
first-claimFirst claim
english-claimsClaims
original-claimsClaims in language of publication
espacenet-linkURL to espacenet
simple-familyList of ucids sharing the same family id
inpadoc-familyExtended family
legal-statusLegal status
titleEnlish language title or, if not present, title in publication language
ifi-expirationIFI Patent Expiration
ifi-statusIFI Patent Status
ifi-adj-expirationIFI Adjusted Patent Expiration
ifi-assigneeIFI Assignee
ifi-assignee-originalOriginal, as published, assignee
ifi-assignee-currentCurrent IFI assignee
ifi-assignee-probableProbable IFI assignee
family-idSimple family integer identifier
load-idmodified-load-id
date-producedDate on which CLAIMS Direct XML was produced
 @csv.headerBool: ex. 1[ 0 | 1 ] Include column headers.
 @csv.nonlBool: ex. 1[ 0 | 1 ] Replace new lines (nl) with spaces
 @csv.maxcolsizeInteger: ex 32The maximum number of bytes allowed per column (overflow will be truncated). This value is assumed to be Kilobytes.

...