Web Service Method: Request Document Search Index

Abstract

Description
This method queries the search index for qualified resources based on the given filters and returns search results in JSON.

URL: /GraphSearch/api/search

Request

Supported Methods
POST
GET

Content-Type

application/x-www-form-urlencoded

HTTP Parameters

Attribute	Type	Required	Comment
count	int	false	Number of results
documentFacets	Array of String	false	Fetch facets of a document. Set to all to fetch all facets.
encoding	String	false	Request encoding
facetMinCount	int	false	Minimal facets
locale	String	false	Search locale
maxFacetCount	int	false	Maximal facets
nativeQuery	String	false	You can use it to apply a filter for a result to be displayed based on title or description.
searchFacets	Array of SearchFacet	false	Returns the facets based on the result. Leave empty to fetch all.
searchFilters	Array of SearchFilter	false	Search filters
searchSpaceId	String	false	SearchSpace Identifier
sort	SortInfo	false	Sorting
start	int	false	Start of result (pagination)

Example Request

{
  "searchSpaceId" : "some searchSpaceId",
  "facetMinCount" : 18121,
  "count" : 18245,
  "start" : 1491,
  "documentFacets" : [ "some documentFacets", "some documentFacets" ],
  "searchFilters" : [ {
    "boosting" : 0.40903503,
    "field" : "some field",
    "NULL_BOOSTING" : 0.6452422,
    "language" : "en-gb",
    "optional" : false,
    "value" : "some value"
  } ],
  "sort" : {
    "field" : "some field",
    "direction" : "DESC"
  },
  "encoding" : "some encoding",
  "locale" : "some locale",
  "maxFacetCount" : 11578,
  "searchFacets" : [ {
    "field" : "some field",
    "facetMode" : "aggregate"
  } ]
}

Search Facet Object

SearchFacet

Attribute	Type	Required	Comment
facetMode	FacetMode	false	Facet mode (aggregate, list or tree) aggregate \| list \| tree
field	String	false	Facet field

Example of a Search Facet Object

{
  "field" : "some field",
  "facetMode" : "tree"
}

Search Filter Object

SearchFilter

Attribute	Type	Required	Comment
NULL_BOOSTING	float	false
boosting	float	false	Boost filter
field	String	false	Search field
language	String	false	Filter language
optional	boolean	false	Optional filter
value	String	false	Value to filter

Example of a Search Filter Object

{
  "boosting" : 0.6660242,
  "field" : "some field",
  "NULL_BOOSTING" : 0.5724136,
  "language" : "de",
  "optional" : false,
  "value" : "some value"
}

Sort Info Object

SortInfo

Attribute	Type	Required	Comment
direction	SortDirection	false	Sort direction (ASC \|\| DESC) DESC \| ASC
field	String	false	Sort field

Example Sort Info Object

{
  "field" : "some field",
  "direction" : "DESC"
}

Response

Content-Type: application/json

Response Attributes

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.

Attribute	Type	Required	Comment
MIMETYPE_PRODUCT_NAME	string	false
facetList	Array of FacetInfo	false	Facets based on the result space
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" : 9782,
  "success" : false,
  "facetList" : [ {
    "field" : "some field",
    "label" : "some label",
    "facets" : [ {
      "count" : 10706,
      "language" : "fr",
      "label" : "some label",
      "value" : "some value"
    }, {
      "count" : 18921,
      "language" : "en",
      "label" : "some label",
      "value" : "some value"
    } ]
  }, {
    "field" : "some field",
    "label" : "some label",
    "facets" : [ {
      "count" : 19935,
      "language" : "it",
      "label" : "some label",
      "value" : "some value"
    }, {
      "count" : 14335,
      "language" : "de",
      "label" : "some label",
      "value" : "some value"
    } ]
  }, {
    "field" : "some field",
    "label" : "some label",
    "facets" : [ {
      "count" : 30599,
      "language" : "nl",
      "label" : "some label",
      "value" : "some value"
    } ]
  } ],
  "message" : "some message",
  "resultType" : "some resultType",
  "status" : 17616
}

Facet Info Object

FacetInfo

Attribute	Type	Required	Comment
facets	Array of Facet	false	List of facets
field	string	false	Facet field
label	string	false	Facet label

Example Facet Info Object

{
  "field" : "some field",
  "label" : "some label",
  "facets" : [ {
    "count" : 8281,
    "language" : "en-gb",
    "label" : "some label",
    "value" : "some value"
  } ]
}

Facet Object

Attribute	Type	Required	Comment
count	long	false	Facet count
label	String	false	Facet label
language	String	false	Facet language
value	String	false	Facet value

Example Facet Object

{
  "count" : 22106,
  "language" : "cz",
  "label" : "some label",
  "value" : "some value"
}

In this section:

Web Service Method: Request Document Search Index

Request

HTTP Parameters

Response

Note

Refine search

Search results