Oskari API documentation

Select request

admindown-arrow
frameworkdown-arrow
mappingdown-arrow
uidown-arrow

MetadataSearchRequest RPC

Make a metadata search query.

Use cases

  • Make a generic metadata search to get metadata results

Description

Requests metadata search results by given params. After the search is completed a MetadataSearchResultEvent is triggered where following data is available:

  • event.getResults(), returns search result object. Look at MetadataSearchResultEvent.md for more details
  • event.hasError(), returns boolean. If true, search has errors

Parameters

(* means the parameter is required)

Name Type Description Default value
\* searchObject Object Metadata search object, for example { search: 'search text" }. Object supports same keys as geoportal metadata search.

Examples

Find metadata for tie search.

const sb = Oskari.getSandbox();
sb.postRequestByName('MetadataSearchRequest', [{ search: 'tie' }]);

Find metadata for tie search and where responsible organization is Väylävirasto.

const sb = Oskari.getSandbox();
sb.postRequestByName('MetadataSearchRequest', [{ search: 'tie', OrganisationName: 'Väylävirasto' }]);