Index BlackBerry Workspaces SDK
BlackBerry Workspaces Resource
Search
Function Summary
Name Path Version Description

autoCompleteV30

/search/autocomplete

3.0

searchV30

/search/

3.0

Function Details

autoCompleteV30

Autocomplete route

Version: 3.0
Synopsis: POST
Path: /search/autocomplete
Request Body: AutocompleteRequest
Response Headers: N/A
Response Body: PagingItemListJson

Request format:

POST /search/autocomplete

Authorization: Bearer <ssid>
Content-type: application/json

{
searchString: String,
locationContext: SearchContext,
connectorUuid: String,
workspaceUuid: String,
workspaceId: Integer,
folderUuid: String,
folderId: Integer,
pagination:
{
pageSize: Integer,
pageNumber: Integer
},
searchFilters: List(
{
filterName: SearchFilter,
filterValue: String
})
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
offset: Integer,
total: Integer,
items: List(Json )
}

searchV30

Main Search Route

Version: 3.0
Synopsis: POST
Path: /search/
Request Body: SearchRequest
Response Headers: N/A
Response Body: PagingItemListJson

Request format:

POST /search/

Authorization: Bearer <ssid>
Content-type: application/json

{
searchString: String,
locationContext: SearchContext,
connectorUuid: String,
workspaceUuid: String,
workspaceId: Integer,
folderUuid: String,
folderId: Integer,
pagination:
{
pageSize: Integer,
pageNumber: Integer
},
orderAscending: Boolean,
searchFilters: List(
{
filterName: SearchFilter,
filterValue: String
}),
documentOrder: SearchOrder
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
offset: Integer,
total: Integer,
items: List(Json )
}