Web Service Method: Retrieve All Search Space Configurations

Description

Retrieve configuration of all search spaces.

URL: /api/context/all

Content Type

*/*

Request

Supported Methods

GET

Note

This request call will return all Search Spaces you have access rights to, which means ALL, if you are authenticated, otherwise only those that are PUBLIC.

Response

Content Type

application/json

A Space Object

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", "some graphContexts" ],
  "defaultSearchSpace" : true,
  "searchSpaceName" : "some searchSpaceName",
  "availableLanguages" : [ "fr", "en-gb" ],
  "facetIds" : [ {
    "facetType" : "THESAURUS",
    "facetId" : "some facetId",
    "label" : "some label"
  }, {
    "facetType" : "CUSTOMSCHEME",
    "facetId" : "some facetId",
    "label" : "some label"
  } ],
  "chartConfigs" : { },
  "facetCount" : 13228,
  "store" : {
    "serverType" : "some serverType",
    "index" : true,
    "label" : "some label",
    "serverId" : "some serverId",
    "reachable" : true
  },
  "documentModelIds" : [ {
    "facetType" : "CUSTOMSCHEME",
    "facetId" : "some facetId",
    "label" : "some label"
  }, {
    "facetType" : "THESAURUS",
    "facetId" : "some facetId",
    "label" : "some label"
  } ],
  "searchSpaceId" : "some searchSpaceId",
  "horizontalAlignment" : "some horizontalAlignment",
  "defaultLanguage" : "fr",
  "defaultView" : "some defaultView",
  "disableDefaultPlugins" : true,
  "disableEntitySorting" : true,
  "integrationType" : "some integrationType",
  "searchSpaceAccessType" : "some searchSpaceAccessType",
  "verticalAlignment" : "some verticalAlignment"
}