GET
- The GET method returns an array of items with the given query.
- This example shows the JSON result for a query “opsommingen”. Result is similar to what is returned by Item API with the addition of a “score” field. The results are returned in order of relevance as indicated by the score.
- By default, the API will search in the Home-group if you can access it, or the last office you visited.
- To search in a specific group, add the following parameter to GET:
&office=1234-456f44 - To search in the entire Viadesk domain, add the following parameter to GET:
&isGlobal=true
GET development.viadesk.com/api/search?query=opsomm…
Response body:
[
{
"id":"157531-6e6f7465",
"kind":"note",
"name":"Opsommingen",
"created":"2012-06-08T17:08:08CEST",
"modified":"2012-06-08T17:08:08CEST",
"body":"eerste\n tweede \neerste\n tweede",
"replyCount":3,
“diggsPositive”: 2,
"author":
{
"id":"5-756e6b6e6f776e",
"email":"unknown@viadesk.com",
"name":"Peter Verhulst"
},
"canAddChildren":true,
"canWrite":true,
"score":0.0341060645878315 // the relevance score as indicated by Viadesk search engine
}
etc.
]