Geodi Query API - Document Search

Owned by Kemal Candan
Last updated: Oct 13, 2022 by Özgür Balcı
3 min read

Standard Query API

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 Token. If you are preparing an end-user interface, Displaying search results with templates page will be more useful.

Query

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.



HttpMethod

GET, POST

Expected Errors

401 Unauthorized access / Access denied

403 Forbidden

511 Network Authentication Required

501 Server Error

Return value

You can access the current result object by clicking here.

Example Applications







Simple

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

Query

Query

Definition

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

Request

[GEODIURL]/QueryHandler?op=Query&wsName=[WSNAME]&q=[SearchString]&startIndex=[StartIndex]&endIndex=[EndIndex]&options=[OptionsJSON]&UserSession=[TOKEN]

  • wsName(string): Name of the workspace to search inside

  • q(string): Query text

  • StartIndex(int - Optional): The Index which the query results will start.(limit 0)

  • EndIndex(int - Optional): The Index which the query results will end.(limit 0)

  • options(Optional): Additional parameters to change the query result

    • ContentIDFilter(int[] - Optional): Filters the content from which to query.

    • Envelope([LonMin(int),LatMin(int),LonMax(int),LatMax(int)] - Optional): Returns the words within the boundaries of the given BBOX geometry.

    • LayerIdFilter(int[] - Optional): Filters the words according to the IDs of the recognizers that recognize these words.

    • KeywordIdFilter(int[] - Optional): Filters words by IDs

    • CalculateCounts(true/false - Optional): If true, the NumberOfOccurences field is calculated in the result returned from the query.

    • SummaryFill(true/false - Optional): If true, it returns summary information in the Summary field in the results returned from the query.

HttpMethod

GET, POST

Expected Errors

401 Unauthorized access / Access denied

403 Forbidden

511 Network Authentication Required

501 Server Error

Return Value



[ { "ContentID":2, "Content": { "DisplayName": "", "EnumeratorID": 0, "ContentType": "", "HasViewer": true, "DisableDownload": true, "HasNote": true }, "Summary": { "SummaryID": "", "Text": "" }, "Attributes": { "FolderCanBeShown": "1", "PDisplayName": "", "PId": "1" }, NumberOfOccurences: 1 } ]
  • ContentID: ID of the content.

  • Content: Content information.

    • DisplayName: The display name of the content. (Filename, etc.)

    • EnumeratorID: The name of the enumerator that provides the content.

    • ContentType: The type of content, extension.

    • HasViewer: Whether the content has a viewer or not

    • DisableDownload: Whether the content is prevented from downloading by the user or not

    • HasNote: Whether the content has a note or not

  • Summary: Document summary information. Returns if SummaryFill field in options is true

    • SummaryID: Id of the summary

    • Text: Summary text

  • Attributes: Extra information about the content

    • FolderCanBeShown:

    • PDisplayName: If parent content exists, the display name of that content.

    • PId: If parent content exists, the ID of that content.

    • PcontentType: Parent content exists, type of content

  • NumberOfOccurences: How many times the word has occurred.


Examples











Exmple applications