Versions Compared

Old Version 8

changes.mady.by.user Dece Translate

Saved on

compared with

New Version 9

changes.mady.by.user Dece Translate

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

...

It is a service where all features can be used and the objects matching the query are returned.  AdvancedQuery Token requires to be received by Generating a Geodi GEODI Token. If you are preparing an end-user interface, Displaying search results with templates page will be more useful.

Query
Definition

Returns the list of documents matching the search result. Allows users to search from documents within GEODI Workspace.

All current requests and results are available at  GeodiJSONService .

Request

[GEODIURL]/GeodiJSONService?op=getDocuments&wsName=[WSNAME]&query=[StrorageManagerQueryOptions_JSON]&UserSession=[TOKEN]

  • wsName(string): Name of the workspace to search inside
  • query(JSON): The SearchString property within the Object JSON definition is sufficient for all searches. Example{ SearchString: "query" }
  • SummaryCount(int - Optional):  Specified number of summaries are returned if the value is greater than 0. Summary lenght can be set using  query.GetSummaryType paramters.
  • RunUpdateClientData(bool - Optional):
    It is used to retrieve additional information provided by tools such as TextPro and FacePro.


HttpMethodGET, POST
Expected Errors

401 Unauthorized access / Access denied

403 Forbidden

511 Network Authentication Required

501 Server Error

Return valueYou can access the current result object by clicking here.
Example Applications



...

The simple query service includes inputs and outputs containing simplified, basic information that is sufficient for most applications. Generating a Geodi GEODI Token is needed. If you are preparing an end-user interface, Displaying search results with templates page will be more useful.

...