v1

latestOpenAPI 3.0.02026-08-066425196.1 KB
Other Extracted Text

Get search results for active contribution data by sending a request to the catalog with other extracted text as a search parameter.

Get search results for active contribution data by sending a request to the catalog with other extracted text as a search parameter. It returns a JSON result.

get/other-extracted-text/search

Query parameters

qstring

A search query string which accepts exact phrases or similar matches ("").

idstring

An individual contribution's unique identifier which maps to the record.contributionId field

userIdstring

Contributor's unique identifier which maps to the record.contributor.userId field

userNamestring

Contributor's screen name which maps to the record.contributor.userName field

naIdstring

An array of NARA-specific identifiers, each of which is unique to a single record.

statusstring

Contribution's status which maps to the status field in the MySQL database

createdAtstring

Contribution's date of creation by which to filter

updatedAtstring

Contribution's date of modification by which to filter

sortBy'contribution.asc' | 'contribution.desc' | 'createdAt.asc' | 'createdAt.desc' | 'updatedAt.asc' | 'updatedAt.desc'

Sort order:

  • contribution.asc - Sort by contribution, ascending from A to Z
  • contribution.desc - Sort by contribution, descending from Z to A
  • createdAt.asc - Sort by created date, ascending
  • createdAt.desc - Sort by created date, descending
  • updatedAt.asc - Sort by updated date, ascending
  • updatedAt.desc - Sort by updated date, descending
  • count.asc - Sort by aggregated tag counts, ascending, ONLY works when contributionType = tag is present
  • count.desc - Sort by aggregated tag counts, descending, ONLY works when contributionType = tag is present
includeTotalCountboolean

Returns the total count of results in each result.

Response

A body of response data containing other extracted objects if any were found.