Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Reverted from v. 28

...

In brief, you can use the interface to do the following: tst

  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

...


Example:

Code Block
languagetext
wget -O- \
  --header 'x-user:x' \
  --header 'x-password:y' \
'https://cdws21.ificlaims.com/report/status?id=99a479b9-4a73-4f27-b8b1-44b052844e23'


Response JSON

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

...

MethodGET

Path

/report/columns


Response JSON

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