Web Service Method: Retrieve Search Space Configuration

Abstract

Description
Retrieve configuration of specific search space.

URL: /api/context

Content Type

application/x-www-form-urlencoded

Request

Supported Methods
GET

HTTP Parameters

Parameter	Comment	Type	Required
searchSpaceId	ID of the search space	String	true

Response

Content Type

application/json

Space Object Response Attributes

Attribute	Type	Required	Comment
availableLanguages	Array of String	false	GraphSearch optional languages
chartConfigs	Map of String	false	GraphSearch Engine
defaultLanguage	String	false	Default language
defaultSearchSpace	boolean	false	Default search space
defaultView	String	false	Context default view
disableDefaultPlugins	boolean	false	Disable default plugins
disableEntitySorting	boolean	false	Disable entity sorting
documentModelIds	Array of FacetContext	false	Document model ids
facetCount	int	false	Default field count
facetIds	Array of FacetContext	false	Facet ids
graphContexts	Array of String	false	Graph contexts
horizontalAlignment	String	false	Horizontal alignment
integrationType	String	false	Integration type
searchSpaceAccessType	String	false	SearchSpace Access Type
searchSpaceId	String	false	SearchSpace Identifier
searchSpaceName	String	false	Search Space name
store	Store	false	Search store
verticalAlignment	String	false	Vertical alignment

Example Response

{
  "graphContexts" : [ "some graphContexts", "some graphContexts" ],
  "defaultSearchSpace" : true,
  "searchSpaceName" : "some searchSpaceName",
  "availableLanguages" : [ "en", "en-gb" ],
  "facetIds" : [ {
    "facetType" : "THESAURUS",
    "facetId" : "some facetId",
    "label" : "some label"
  } ],
  "chartConfigs" : { },
  "facetCount" : 11672,
  "store" : {
    "serverType" : "some serverType",
    "index" : true,
    "label" : "some label",
    "serverId" : "some serverId",
    "reachable" : false
  },
  "documentModelIds" : [ {
    "facetType" : "CUSTOMSCHEME",
    "facetId" : "some facetId",
    "label" : "some label"
  } ],
  "searchSpaceId" : "some searchSpaceId",
  "horizontalAlignment" : "some horizontalAlignment",
  "defaultLanguage" : "de",
  "defaultView" : "some defaultView",
  "disableDefaultPlugins" : false,
  "disableEntitySorting" : true,
  "integrationType" : "some integrationType",
  "searchSpaceAccessType" : "some searchSpaceAccessType",
  "verticalAlignment" : "some verticalAlignment"
}

In this section: