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 | |
---|---|
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]
|
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 | |
---|---|
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]
|
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 } ]
|
Examples | //Request : [GEODIURL]/QueryHandler?op=Query&wsName=PROJE&q=ankara,&StartIndex=0&EndIndex=1 [ { "ContentID":2, "Content": { "DisplayName": "1234.doc", "EnumeratorID": -1324, "ContentType": ".doc", "HasViewer": true, "DisableDownload": false, "HasNote": false }, "Attributes": { "FolderCanBeShown":"1", "PDisplayName":"Folder", "PId":"1", "PContentType":"foldercontent:.folder" } } ] //Request : [GEODIURL]/QueryHandler?op=Query&wsName=PROJE&q=ankara,&StartIndex=0&EndIndex=3 [ { "ContentID":2, "Content": { "DisplayName": "1234.doc", "EnumeratorID": -1324, "ContentType": ".doc", "HasViewer": true, "DisableDownload": false, "HasNote": false }, "Attributes": { "FolderCanBeShown":"1", "PDisplayName":"Folder", "PId":"1", "PContentType":".folder" } }, { "ContentID":3, "Content": { "DisplayName": "5678.xls", "EnumeratorID": -1324, "ContentType": ".xls", "HasViewer": true, "DisableDownload": false, "HasNote": false }, "Attributes": { "FolderCanBeShown":"1", "PDisplayName":"Folder", "PId":"1", "PContentType":".folder" } }, { "ContentID":4, "Content": { "DisplayName": "90.pdf", "EnumeratorID": -1324, "ContentType": ".pdf", "HasViewer": true, "DisableDownload": false, "HasNote": false }, "Attributes": { "FolderCanBeShown":"1", "PDisplayName":"Folder", "PId":"1", "PContentType":".folder" } } ] //Request : [GEODIURL]/QueryHandler?op=Query&wsName=PROJE&q=ankara,&StartIndex=0&EndIndex=1&options={"SummaryFill":true} [ { "ContentID":2, "Content": { "DisplayName": "1234.doc", "EnumeratorID": -1324, "ContentType": ".doc", "HasViewer": true, "DisableDownload": false, "HasNote": false }, "Summary": { "SummaryID": "FTS_0_123_4567_8" "Text": ... ankara ... } "Attributes": { "FolderCanBeShown":"1", "PDisplayName":"Folder", "PId":"1", "PContentType":".folder" } }, ] //Request : [GEODIURL]/QueryHandler?op=Query&wsName=PROJE&q=ankara,&StartIndex=0&EndIndex=1&options={"CalculateCounts":true} [ { "ContentID":2, "Content": { "DisplayName": "1234.doc", "EnumeratorID": -1324, "ContentType": ".doc", "HasViewer": true, "DisableDownload": false, "HasNote": false }, "Attributes": { "FolderCanBeShown":"1", "PDisplayName":"Folder", "PId":"1", "PContentType":".folder" }, NumberOfOccurentces: 3 }, ] |
Exmple applications |