Attachment Collection

The attachment collection is a separate index in CLAIMS Direct which is accessed through the standard /search/query API endpoint using the parameter qt=attachments. However, the Solr documents returned are in a different format from the normal index. In the normal index, the Solr document represents a patent publication. In the attachment index, the Solr document represents a specific attachment file. The ramifications of this are that

q=ucid:EP-0700000-B1

returns 6 results instead of 1 result with 6 attachment fields.

You can also combine path and fname to create the value that will retrieve an attachment from /attachment/fetch. For example, given the values:

fnam : "US20170077426A1-20170316-C00118.MOL"

path : "375962165/US/20170316/A1/020170/07/74/26"

the following request returns the attachment:

/attachment/fetch?path=375962165/US/20170316/A1/020170/07/74/26/US20170077426A1-20170316-C00118.MOL

Because it is a separate index, the attachment collection is not accessible through CDWI.

Search Service (API)

Attachment Service (API)

Bulk Attachments Service (API)

Field	Description	Field Type	Examples	Multivalued	Indexed	Stored	Required

Field	Description	Field Type	Examples	Multivalued	Indexed	Stored	Required
fnam	attachment file name	alexandria_token	US20170077426A1-20170316-C00118.MOL		x	x	x
size	size of the attachment in bytes	tint	Find all attachments larger than 1MB size:[ 1048576 TO * ]		x	x	x (default=1)
path	path to the attachment	alexandria_token	375962165/US/20170316/A1/020170/07/74/26		x	x	x
sffx	file suffix Note: See Attachment Server Description and Coverage for values.	string**	pdf		x		x
ucid	unique patent document identifier based on country, doc-number, and kind	string**	AP-584-A AP-584*		x	x	x
pn	publication identifier based on country, publication number, and kind	alexandria_token	AP-584-A AP584A AP584 AP B2		x		x
xxpnctry	publication country	string**	US		x		x
xxpnkind	publication kind code	string**	B1 A*		x		x
pd	publication date Note: If no ./date is present and a `document-id` element exists, a default value of 00010101 is inserted.	tint	20010101		x		x
xxpd_d	publication date represented internally as a date type Note: This field allows efficient range faceting and Solr date math. Quotes or query escaping may be required for proper searching. See Working with Dates for more information.	tdate	Format: "YYYY-MM-DDThh:mm:ssZ" "2007-01-01T00:01:01Z" 2007-01-01T00\:01\:01Z [2017-07-05T00:00:00.000Z TO *] [NOW-14DAYS TO NOW] (Find documents with publication dates in the last 14 days)		x		x
xxpdyear	publication year	tint	2001		x		x
text	combination of ucid, pkey, fnam, sffx, and path	alexandria_token	text: us AND pdf	x	x
aid	unique attachment identifier	string**	N/A – used internally for index updates		x	x	x
pkey	primary key of the attachment made up of "ucid-publication date", e.g., US-20170077426-A1-20170316	alexandria_token	N/A – used internally for index updates		x		x
slvl	subscription level identifier of request (0=Basic, 1=Premium, 2=Premium+)	tint	N/A – used internally for index filtering		x	x	x

**Note: String fields are not tokenized. Therefore, queries in these fields will only return exact matches unless wild cards are used.

Example

Request

wget -O- -q  \
  --header 'x-user:x' \
  --header 'x-password:y' \
'https://cdws21.ificlaims.com/search/query?qt=attachments&rows=4&q=pnctry:US AND pd:20190312 AND sffx:mol'

Response

{
   "time": "0.021077",
   "status" : "success",
   "content": {
     "responseHeader" : {
       "params" : {
         "timeAllowed" : "300000",
         "wt" : "json",
         "q" : "pnctry:US AND pd:20190312 AND sffx:mol",
         "fq" : "",
         "rows" : "0",
         "indent" : "true",
         "start" : "0"
       },
       "status" : 0,
       "QTime" : 1
     },
     "response" : {
       "numFound" : 24179,
       "docs" : [],
       "start" : 0
      }
    }
  }