Search in DataCite Commons

The DataCite Commons and DOI Fabrica user interfaces are based on Elasticsearch. Both use the Elasticsearch query string queries

To set up queries with the REST API, refer to the REST API documentation for queries and filtering.

How to Search

It is possible to search any element from the DataCite metadata schema using the JSON API response format for the query, for example

Search the title:

titles.title:Mars

Run this search in DataCite Commons.

📘

The syntax you use for the query must match the elements in the JSON API (different to the XML). All the properties are listed in API the response below. More examples are listed in the examples section.

https://api.test.datacite.org/dois/10.70126/t70h-qt35?affiliation=true


{
  "id": "https://doi.org/10.70126/t70h-qt35",
  "doi": "10.70126/T70H-QT35",
  "url": "https://dataverse.scholarsportal.info/dataverse.xhtml",
  "types": {
    "ris": "COMP",
    "bibtex": "misc",
    "citeproc": "article",
    "schemaOrg": "SoftwareSourceCode",
    "resourceType": "XML",
    "resourceTypeGeneral": "Software"
  },
  "creators": [
    {
      "name": "Miller, Elizabeth",
      "nameType": "Personal",
      "givenName": "Elizabeth",
      "familyName": "Miller",
      "affiliation": [
        {
          "name": "DataCite",
          "affiliationIdentifier": "https://ror.org/04wxnsj81",
          "affiliationIdentifierScheme": "ROR"
        }
      ],
      "nameIdentifiers": [
        {
          "schemeUri": "https://orcid.org",
          "nameIdentifier": "https://orcid.org/0000-0001-5000-0007",
          "nameIdentifierScheme": "ORCID"
        }
      ]
    },
    {
      "name": "Ontario Ministry Of Natural Resources And Forestry",
      "nameType": "Organizational",
      "affiliation": [],
      "nameIdentifiers": []
    },
    {
      "name": "Université Du Québec à Montréal",
      "nameType": "Organizational",
      "affiliation": [],
      "nameIdentifiers": []
    }
  ],
  "titles": [
    {
      "lang": "en-US",
      "title": "Full DataCite XML Example"
    },
    {
      "lang": "en-US",
      "title": "Demonstration of DataCite Properties.",
      "titleType": "Subtitle"
    }
  ],
  "publisher": "National Research Council of Canada",
  "container": {},
  "subjects": [
    {
      "lang": "en-US",
      "subject": "000 computer science",
      "schemeUri": "http://dewey.info/",
      "subjectScheme": "dewey"
    }
  ],
  "contributors": [
    {
      "name": "Starr, Joan",
      "givenName": "Joan",
      "familyName": "Starr",
      "affiliation": [
        {
          "name": "California Digital Library",
          "affiliationIdentifier": "https://ror.org/03yrm5c26",
          "affiliationIdentifierScheme": "ROR"
        }
      ],
      "contributorType": "ProjectLeader",
      "nameIdentifiers": [
        {
          "schemeUri": "https://orcid.org",
          "nameIdentifier": "https://orcid.org/0000-0002-7285-027X",
          "nameIdentifierScheme": "ORCID"
        }
      ]
    },
    {
      "name": "International Joint Commission",
      "affiliation": [],
      "contributorType": "Sponsor",
      "nameIdentifiers": []
    },
    {
      "name": "United States Geological Survey",
      "affiliation": [],
      "contributorType": "Producer",
      "nameIdentifiers": []
    }
  ],
  "dates": [
    {
      "date": "2017-09-13",
      "dateType": "Updated",
      "dateInformation": "Updated with 4.3 properties"
    },
    {
      "date": "2014",
      "dateType": "Issued"
    }
  ],
  "publicationYear": 2014,
  "language": "en-US",
  "identifiers": [],
  "sizes": [
    "4 kB"
  ],
  "formats": [
    "application/xml"
  ],
  "version": "4.3",
  "rightsList": [
    {
      "lang": "en-US",
      "rightsUri": "http://creativecommons.org/publicdomain/zero/1.0"
    }
  ],
  "descriptions": [
    {
      "lang": "en-US",
      "description": "XML example of all DataCite Metadata Schema v4.3 properties.",
      "descriptionType": "Abstract"
    }
  ],
  "geoLocations": [
    {
      "geoLocationBox": {
        "eastBoundLongitude": "-68.211",
        "northBoundLatitude": "42.893",
        "southBoundLatitude": "41.090",
        "westBoundLongitude": "-71.032"
      },
      "geoLocationPlace": "Atlantic Ocean",
      "geoLocationPoint": {
        "pointLatitude": "31.233",
        "pointLongitude": "-67.302"
      },
      "geoLocationPolygon": [
        {
          "polygonPoint": {
            "pointLatitude": "41.991",
            "pointLongitude": "-71.032"
          }
        },
        {
          "polygonPoint": {
            "pointLatitude": "42.893",
            "pointLongitude": "-69.622"
          }
        },
        {
          "polygonPoint": {
            "pointLatitude": "41.991",
            "pointLongitude": "-68.211"
          }
        },
        {
          "polygonPoint": {
            "pointLatitude": "41.090",
            "pointLongitude": "-69.622"
          }
        },
        {
          "polygonPoint": {
            "pointLatitude": "41.991",
            "pointLongitude": "-71.032"
          }
        }
      ]
    }
  ],
  "fundingReferences": [
    {
      "awardTitle": "Full DataCite XML Example",
      "funderName": "National Science Foundation",
      "awardNumber": "CBET-106",
      "funderIdentifier": "https://doi.org/10.13039/100000001",
      "funderIdentifierType": "Crossref Funder ID"
    }
  ],
  "relatedIdentifiers": [
    {
      "schemeUri": "https://github.com/citation-style-language/schema/raw/master/csl-data.json",
      "relationType": "HasMetadata",
      "relatedIdentifier": "https://data.datacite.org/application/citeproc+json/10.5072/example-full",
      "relatedIdentifierType": "URL",
      "relatedMetadataScheme": "citeproc+json"
    },
    {
      "relationType": "IsReviewedBy",
      "relatedIdentifier": "arXiv:0706.0001",
      "resourceTypeGeneral": "Text",
      "relatedIdentifierType": "arXiv"
    }
  ],
  "schemaVersion": "http://datacite.org/schema/kernel-4",
  "providerId": "datacite",
  "clientId": "datacite.mary",
  "agency": "DataCite",
  "state": "findable"
}

Examples

1. Search the for a specific publisher

publisher:DataCite

Run the publisher example search in DataCite Commons.

2. Search for a single DOI

To search for a specific DOI use the DOI field in the metadata.

doi:10.11570/18.0006

Run the example DOI search in DataCite Commons.

3. Search the affiliation

In this case include both the parent and child elements from the schema and use a period (.) to separate the different levels in your search query.


 },
  "creators": [
    {
      "name": "Bloggs, Jane",
      "nameType": "Personal",
      "givenName": "Jane",
      "familyName": "Bloggs",
      "affiliation": "DataCite",
      "nameIdentifiers": [
        {

creators.affiliation.name:DataCite

Run the example affiliation search in DataCite Commons.

4. Use quotes

To search for an exact string, for example, an author’s name, include the text between quotation marks, the search looks for the the exact string contained within the quotes.

titles.title:"CrowdoMeter Tweets"

Run the example search using quotation marks in DataCite Commons.

5. Using operators ( e.g AND OR + -)

Building more complex queries can be done with different syntax including AND OR + - (AND / OR must be capitalised)

Search for all works using the AND operator.

types.resourceTypeGeneral:Software AND types.resourceType:XML

Run the example query using the AND boolean in DataCite Commons.

Search for works using the "AND" and "OR" booleans.

publisher:DataCite AND types.resourceTypeGeneral:(Text OR Dataset)

Run the example query using the AND / OR booleans in DataCite Commons.

6. Wildcards

To run a broader search you can include the wildcard (*)

Search for all works with the subject robot*

subjects.subject:robot*

Run the example query using the wildcard in DataCite Commons

7. Longer queries

Combine numerous elements to limit the search results. In this example the creators and the relatedIdentifier properties are used to build the query:

creators:

"creators": [
    {
      "name": "Fenner, Martin",
      "nameType": "Personal",
      "givenName": "Martin",
      "familyName": "Fenner",
      "affiliation": [],
      "nameIdentifiers": [
        {
          "nameIdentifier": "https://orcid.org/0000-0003-1419-2405",
          "nameIdentifierScheme": "ORCID"
        }
      ]
    }
  ],

relatedIdentifiers:

"relatedIdentifiers": [
    {
      "relationType": "HasPart",
      "relatedIdentifier": "10.5438/6423",
      "relatedIdentifierType": "DOI"
    },
creators.name:"Fenner, Martin" AND relatedIdentifiers.relationType:hasPart

Run this longer query example combining 2 elements in DataCite Commons.


Did this page help you?