/search

This API provides the user the search results for a given search query.

Method

GET

Search Params

searchText - term that is being searched for (string)

start - row of record to start fetching from (optional; number; defaults to 0)

rows - number of rows to be fetched in a call (optional; number; defaults to 10)

documentType - the identifier of the category of interest (optional; string; see /categories for possible values)

includeFacet - flag to indicate whether dynamic filters are required for a given search (optional; boolean)

facetType - identifier of the dynamic filter (optional, works with facetName; string; see data model for possible values)

facetName - value of the dynamic filter chosen (optional, works with facetType; string; this depends on the possible values made available for this filter type)

URL

https://search.unhide.helmholtz-metadaten.de/api/search?[searchParams]

Response Model

{
  "records": [
    {
      "id": string,
      "type": string,
      "keys": [ string ],
      ...
      "recordConfig": {
        "index_id": string,
        "_version_": string,
        "indexed_ts": timestamp string
      }
    },
  ],
  "totalCount": number,
  "categoryCounts": {
    {categoryid}: count,
    ...
  },
  "filters": [
    {
      "filterName": string,
      "itemName": string,
      "itemCount": number
    },
    ...
  ]
}

where,

records is a list of records fetched based on the search params. Each record object can have different key-value pairs depending upon the category of the data under interest.

totalCount is the total number of records available for the given search

categoryCounts presents the total number of records available for the given category and search,

filters provides a list of filter objects if the facetType and facetName are supplied when includeFacet is set to true for a given search call.

Example

For the following search params:

searchText - "Forschungszentrum Jülich"

documentType - "documents"

facetType - "txt_contributor"

facetName - "Angst, Manuel"

facetType - "txt_contributor"

facetName - "Zorn, Reiner"

facetType - "txt_publisher"

facetName - "Forschungszentrum Jülich GmbH, JCNS / RWTH Aachen / Univ. Münster"

facetType - "txt_keywords"

facetName - "info:eu-repo/classification/ddc/600"

{
  "records": [
    {
      "id": "https://juser.fz-juelich.de/record/22096",
      "type": "DigitalDocument",
      "txt_contributor": ["Angst, Manuel", "Brückel, Thomas", "Roth, G", "Zorn, Reiner"],
      "txt_creator": ["Brückel, Thomas"],
      "txt_identifier": [
        "https://juser.fz-juelich.de/record/22096",
        "https://juser.fz-juelich.de/search?p=id:%22PreJuSER-22096%22"
      ],
      "txt_keywords": [
        "info:eu-repo/classification/ddc/530",
        "info:eu-repo/classification/ddc/600"
      ],
      "txt_license": ["info:eu-repo/semantics/openAccess"],
      "name": "01: Introduction: Neutron Scattering in Contemporary Research",
      "txt_provider": [
        "JCNS Neutron Lab Course / Th. Brückel, D. Richter, G. Roth, R. Zorn (Eds.) ; Schriften des Forschungszentrums Jülich / Reihe Schlüsseltechnologien / Key Technologies, Vol. 39, Forschungszentrum Jülich GmbH, 2012; 978-3-89336-789-4<br/>JCNS Neutron Laborator Course, Jülich/München, Germany, 2012-09-03 - 2012-09-14"
      ],
      "txt_publisher": ["Forschungszentrum Jülich GmbH, JCNS / RWTH Aachen / Univ. Münster"],
      "txt_sameAs": ["[info:eu-repo, semantics, altIdentifier, hdl, 2128, 4740]"],
      "keys": [
        "id",
        "type",
        "txt_contributor",
        "txt_creator",
        "txt_identifier",
        "txt_keywords",
        "txt_license",
        "name",
        "txt_provider",
        "txt_publisher",
        "txt_sameAs"
      ],
      "recordConfig": {
        "index_id": "3915592a-f9cd-4932-a048-7aa1019d3a67",
        "_version_": "1778867342397145088",
        "indexed_ts": "2023-10-04T22:54:56.738Z"
      }
    },
    {
      "id": "https://juser.fz-juelich.de/record/19548",
      "type": "DigitalDocument",
      "txt_contributor": ["Angst, Manuel", "Brückel, Thomas", "Roth, G", "Zorn, Reiner"],
      "txt_creator": ["Frielinghaus, Henrich"],
      "txt_identifier": [
        "https://juser.fz-juelich.de/record/19548",
        "https://juser.fz-juelich.de/search?p=id:%22PreJuSER-19548%22"
      ],
      "txt_keywords": [
        "info:eu-repo/classification/ddc/530",
        "info:eu-repo/classification/ddc/600"
      ],
      "txt_license": ["info:eu-repo/semantics/openAccess"],
      "name": "05: Nanostructures Investigated by Small Angle Neutron Scattering",
      "txt_provider": [
        "JCNS Neutron Lab Course / Th. Brückel, D. Richter, G. Roth, R. Zorn (Eds.) ; Schriften des Forschungszentrums Jülich / Reihe Schlüsseltechnologien / Key Technologies, Vol. 39, Forschungszentrum Jülich GmbH, 2012; 978-3-89336-789-4<br/>JCNS Neutron Laborator Course, Jülich/München, Germany, 2012-09-03 - 2012-09-14"
      ],
      "txt_publisher": ["Forschungszentrum Jülich GmbH, JCNS / RWTH Aachen / Univ. Münster"],
      "txt_sameAs": ["[info:eu-repo, semantics, altIdentifier, isbn, 978-3-89336-789-4]"],
      "keys": [
        "id",
        "type",
        "txt_contributor",
        "txt_creator",
        "txt_identifier",
        "txt_keywords",
        "txt_license",
        "name",
        "txt_provider",
        "txt_publisher",
        "txt_sameAs"
      ],
      "recordConfig": {
        "index_id": "4e71f085-59f4-4dc0-8ac5-4f07a2c8af15",
        "_version_": "1778856255287197696",
        "indexed_ts": "2023-10-04T19:58:43.246Z"
      }
    }
  ],
  "totalCount": 2,
  "categoryCounts": {
    "experts": 0,
    "documents": 2,
    "datasets": 0,
    "institutions": 0,
    "trainings": 0,
    "projects": 0,
    "software": 0,
    "instruments": 0
  },
  "filters": [
    {
      "filterName": "txt_keywords",
      "itemName": "info:eu-repo/classification/ddc/530",
      "itemCount": 2
    },
    {
      "filterName": "txt_keywords",
      "itemName": "info:eu-repo/classification/ddc/600",
      "itemCount": 2
    },
    {
      "filterName": "txt_contributor",
      "itemName": "Angst, Manuel",
      "itemCount": 2
    },
    {
      "filterName": "txt_contributor",
      "itemName": "Brückel, Thomas",
      "itemCount": 2
    },
    { "filterName": "txt_contributor", "itemName": "Roth, G", "itemCount": 2 },
    { "filterName": "txt_contributor", "itemName": "Zorn, Reiner", "itemCount": 2 },
    {
      "filterName": "txt_license",
      "itemName": "info:eu-repo/semantics/openAccess",
      "itemCount": 2
    },
    {
      "filterName": "txt_provider",
      "itemName": "JCNS Neutron Lab Course / Th. Brückel, D. Richter, G. Roth, R. Zorn (Eds.) ; Schriften des Forschungszentrums Jülich / Reihe Schlüsseltechnologien / Key Technologies, Vol. 39, Forschungszentrum Jülich GmbH, 2012; 978-3-89336-789-4<br/>JCNS Neutron Laborator Course, Jülich/München, Germany, 2012-09-03 - 2012-09-14",
      "itemCount": 2
    },
    {
      "filterName": "txt_publisher",
      "itemName": "Forschungszentrum Jülich GmbH, JCNS / RWTH Aachen / Univ. Münster",
      "itemCount": 2
    }
  ]
}