Some query elements have optional properties that control how a query is executed by the XML API. The Crossref query engine operates by evaluating several logic rules in series. Each rule focuses on certain fields in the query, with the first rule processing the entire query. If any rule returns a single metadata record as its output, this DOI is taken as the result for the query, and rule processing terminates.
Controls include:
- Match: use to specify level of fuzzy or exact matching. This attribute may be applied to several elements (ISSN, author, issue, article_title)
- Enable-multiple-hits: allows or prevents matches returning more than one DOI
- Secondary-query: instructs the system to perform a specific query if the default query mode does not produce a result. Current options include author/title, multiple hits, and author/title multiple hits.
A full table of controls is below
Query controls
| Element | Property | Value | Purpose |
|---|---|---|---|
| query | key | string | to track a query to its results |
| enable-multiple-hits | false (default) | have the system reduce the query to one DOI and return nothing if it can not do so | |
| true | have the system return one DOI for each query rule it executes | ||
| multi_hit_per_rule | have the system return many DOIs for each query rule it executes - will produce up to 50 candidate DOIs which partially match the query | ||
| exact | |||
| forward-match | false (default) | No query is stored | |
| true | Stored this query and re-run it automatically and notify via email any matches that are found | ||
| list-components | false (default) | Components not included in results | |
| true | list the DOIs of any components that have deposited which are linked to this DOI | ||
| expanded-results | false(default) | ||
| true | include article title in the results (only applicable when results format=XML_XSD) | ||
| secondary-query | author-title | perform author-title search if metadata search fails | |
| multiple-hits | returns multiple hits (if present) | ||
| author-title-multiple-hits | performs author/title and multiple hits search if initial search fails | ||
| issn | match | optional | value may be missing from deposited metadata |
| exact | match exactly as it appears in the query | ||
| journal_title | optional | not required | |
| fuzzy(default) | use fuzzy string matching | ||
| exact | match exactly as it appears in the query | ||
| author | match | optional | instructs the query engine that this field may be ignored. |
| fuzzy (default) | use fuzzy string matching | ||
| null | match if author is missing in the metadata | ||
| exact | match exactly as it appears in the query | ||
| issue | match | fuzzy(default)/exact | -- see above -- |
| first_page | fuzzy(default)/exact | -- see above -- | |
| year | optional(default)/exact | -- see above -- | |
| article_title | match | fuzzy(default)/exact | -- see above -- |
Comments
0 comments
Please sign in to leave a comment.