Web Service Method: Request Suggested Concepts from a Document

Abstract

Description
Suggest facet values which occur in the document index.

URL: /GraphSearch/api/suggest

Request

Supported Methods
GET

HTTP Parameters

Parameter	Type	Required	Description
context	String	false	Context to search (Facet field)
count	int	false	Number of results
encoding	String	false	Request encoding
fuzzy	boolean	false	Fuzzy search
locale	String	false	Search locale
searchSpaceId	String	false	SearchSpace Identifier
searchString	String	true	Text fragment to search concepts
start	int	false	Start of result (pagination)

Response

Content Type

application/json

Note

The return to this request will display these errors in the following specific cases:

If the Search Space ID is wrong, you will receive a 404 'Bad Request' message, with specific information in a JSON message as to the value that was not found.
If the credentials were mistyped or wrong: a 403 Forbidden, and a JSON message 'Access denied' will be returned.
If you didn't specify a Search Space ID: the return will be made for the default Search Space.
- If the default Search Space is private and you are not authenticated, you will also receive a 403 Forbidden in a JSON message.

SuggestResponse Object

Attribute	Type	Required	Comment
MIMETYPE_PRODUCT_NAME	String	false
message	String	false	short descriptive message of the operation result, or an error description
request	Object	false	Search request
result	Object	false	the actual response content body, defined by the resultType.
resultType	String	false	MIME type of the result if successful, or Exception type if an error occurred
status	int	true	indicates the success or error of the HTTP request, on the protocol layer
success	boolean	false	true if the operation was successful, on the application layer
total	long	false	Result size

Example Response

{
  "MIMETYPE_PRODUCT_NAME" : "some MIMETYPE_PRODUCT_NAME",
  "result" : { },
  "request" : { },
  "total" : 22757,
  "success" : true,
  "message" : "some message",
  "resultType" : "some resultType",
  "status" : 28603
}

In this section: