Page tree

Versions Compared

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. Special Unix/Linux characters may not be used in report names. Valid characters include alphas, numerics, dashes, and underscores.

@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-ucidDocument identifier (ucid)
document-countryCountry of publication
document-numberPatent/publication number
document-kindPublication kind code
document-dateDate of publication (YYYYMMDD)
document-yearYear of publication (YYYY) of publication
application-ucidApplication filing identifier (ucid)
application-countryFiling country
application-numberFiling number
application-kindFiling kind code
application-dateDate of filing (YYYYMMDD)
application-yearYear of filing (YYYY)
priority-numberPriority numbers (ucids)
priority-countryPriority countries
priority-datePriority filing dates (YYYYMMDD)
priority-yearPriority filing years (YYYY)
us-class-primaryPrimary US classification
us-classAll US classifications
cpcCPC
cpc-first-inventiveFirst inventive CPC
ipcrIPCR
ipcIPC
eclaECLA
f-termsF-terms
patent-citationsPatent citations
non-patent-citationsNon-patent citations
forward-citationsForward citations
related-applicationsRelated applications
assignee-applicantAssignees/applicants
epo-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 in English
original-claimsClaims in language of publication
espacenet-linkURL to espacenet
simple-familyList of ucids sharing the same family ID, as assigned by DocDB
inpadoc-familyExtended family
legal-statusLegal status
titleEnglish language title or, if not present, title in publication language
ifi-expirationIFI anticipated patent expiration date
ifi-statusIFI patent status
ifi-publication-typeIFI publication type
ifi-adj-expirationIFI adjusted patent expiration date
ifi-assigneeIFI assignee
ifi-assignee-originalOriginal, as published, assignee
ifi-assignee-currentCurrent IFI assignee
ifi-assignee-probableProbable IFI assignee
family-idDocDB-assigned simple 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.

...

Code Block
languagetext
{
   "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"
   ]
}