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 .

[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" }

  • For query text syntax rules, see GEODI Queries .

• 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.

GET, POST

401 Unauthorized access / Access denied

403 Forbidden

511 Network Authentication Required

501 Server Error

You can access the current result object by clicking here.

• GeodiQueryJS Sample

  • Click to run the sample code where you can try to edit the template

• AngularJs Sample

  •  Click to run the sample code

• Vue.js Sample

  •  Click to run the sample code

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

[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
  
  

  • For query text syntax rules, see GEODI Queries .

• 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.

GET, POST

401 Unauthorized access / Access denied

403 Forbidden

511 Network Authentication Required

501 Server Error

• 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.
  
  
  

• .Net WinForm ( C# )

• Java

• Javascript Sample

• AngularJs Sample

• Vue.js Sample