Search Data API - Revision history

Vmurrell at 10:28, 12 November 2025

2025-11-12T10:28:18Z

2023-09-11T06:59:57Z

2021-03-02T09:06:15Z

‎Overview

2021-03-02T09:00:58Z

‎Overview

2021-03-02T08:59:26Z

‎Search Response

2021-03-02T08:59:12Z

‎Search Response

2021-03-02T08:57:49Z

‎Overview

2021-03-02T08:50:06Z

‎Search Response

2021-03-02T08:49:32Z

‎Search Response

2021-03-02T08:49:16Z

‎Auto Complete Response

@@ Line 1: / Line 1: @@
 [[Category:WebService]]
+[[Category:How_To]]
 = Overview =

← Older revision		Revision as of 09:06, 2 March 2021
Line 6:		Line 6:

	The searched structures are Dataflows and Codes. The searched properties of these structures are the Ids, Names, and Descriptions (in all languages).		The searched structures are Dataflows and Codes. The searched properties of these structures are the Ids, Names, and Descriptions (in all languages).
		+
		+	The results of the Search API can be combined with metadata fetched from the structure web service in order to build the presentation for the user. An example of the search API in use can be seen in the [https://demo.metadatatechnology.com/DataBrowser/ Fusion Data Browser].

	= API =		= API =

@@ Line 5: / Line 5: @@
 The data search API provides the ability to perform a free text search for data.  The response is broken down by Dataflow, along with the matched [[Component|Components]] related to the Dataflow.  The Data Search API only includes Dataflows that have data loaded against them, and will only search Codes related to the Dataflow which have series loaded.  The result includes the number of series that match each 'hit' within a Dataflow, where the hit is the Component that matched.  For example a search for '''USA''' may match a Dataflow in the Reporting Country Dimension because there are a number of series which have Reporting Country USA.  If there are also Counterpart Countries for the same Dataflow, and they too have series for USA, then this will also be a hit within the same Dataflow - although the series count for each hit may differ depending on the number of series that exist.  If the match is on the Dataflow itself, and there are no hits on the individual components, then the series count will be given at the level of the Dataflow.
-The searched structures are are the Codes, Dataflows and the searched facets are the Ids, Names, and Descriptions (in all languages).
+The searched structures are Dataflows and Codes.  The searched properties of these structures are the Ids, Names, and Descriptions (in all languages).
 = API =

@@ Line 54: / Line 54: @@
 The search response is a list a list of results, each result is a match on a Dataflow and a list of Components that matched with the match text, and the number of series that exist for the matched term
-<b><u>Example: </u></b>[https://demo.metadatatechnology.com/FusionRegistry/ws/public/datasearch?query=money /ws/public/datasearch?query=population]
+<b><u>Example: </u></b>[https://demo.metadatatechnology.com/FusionRegistry/ws/public/datasearch?query=money /ws/public/datasearch?query=population]<br>
 Match on multiple Dataflows, multiple Components
@@ Line 81: / Line 81: @@
+  }
-<b><u>Example: </u></b>[https://demo.metadatatechnology.com/FusionRegistry/ws/public/datasearch?query=money /ws/public/datasearch?query=WDI_HEALTH]
+<b><u>Example: </u></b>[https://demo.metadatatechnology.com/FusionRegistry/ws/public/datasearch?query=money /ws/public/datasearch?query=WDI_HEALTH]<br>
 Match on the Dataflow (no individual Components)

@@ Line 55: / Line 55: @@
 <b><u>Example: </u></b>[https://demo.metadatatechnology.com/FusionRegistry/ws/public/datasearch?query=money /ws/public/datasearch?query=population]
+Match on multiple Dataflows, multiple Components
+  {
     "time" : 28,
@@ Line 78: / Line 79: @@
+      }
+    ]
+  }

@@ Line 72: / Line 72: @@
                      "Match": "Improved water source, rural (% of rural population with access)"
                  },
-         .....
+                .....
-−
+       }
+      }
+    ]
+  }

@@ Line 52: / Line 52: @@
 The search response is a list a list of results, each result is a match on a Dataflow and a list of Components that matched with the match text, and the number of series that exist for the matched term
-<b><u>Example: <b>[https://demo.metadatatechnology.com/FusionRegistry/ws/public/datasearch?query=money /ws/public/datasearch?query=population]</b></u>
+<b><u>Example: </u></b>[https://demo.metadatatechnology.com/FusionRegistry/ws/public/datasearch?query=money /ws/public/datasearch?query=population]
+  {
@@ Line 76: / Line 76: @@
+      }
+    ]
+  }

@@ Line 39: / Line 39: @@
 The response is a JSON array of search options based on the query term
-<b><u>Example: <b>[https://demo.metadatatechnology.com/FusionRegistry/ws/public/datasearch?auto=true&query=money /ws/public/datasearch?query=money&auto=true]</b></u>
+<b><u>Example: </u></b>[https://demo.metadatatechnology.com/FusionRegistry/ws/public/datasearch?auto=true&query=money /ws/public/datasearch?query=money&auto=true]
+  [