Fulltext Search

Interface to our embedded Fulltext Search

rebuild index for type(s)

post

Bodystring[]

application/json

string[]Optional

Responses

200

OK

application/json

stringOptional

post/cmn/ft-search/types/index

HTTPcURLJavaScriptPython

POST /api/cmn/ft-search/types/index HTTP/1.1
Host: 10.102.24.218:32792
Content-Type: application/json
Accept: */*
Content-Length: 8

[
  "text"
]

200

OK

text

phonetic search

post

Query parameters

perspectiveanyOptional

Perspective of result

Body

application/json

languageCodestring · max: 2Optional

language code

typesstring[]Optional

Die Types, die durchsucht werden sollen. Oder null für alle

name1stringOptional

(optional) ein name1

name2stringOptional

(optional) ein name2

name3stringOptional

(optional) ein name3

streetstringOptional

(optional) eine street

citystringOptional

(optional) eine city

emailstringOptional

(optional) eine email

Responses

200

successful operation

application/json

entryTypestringOptional

origin of document

refIdstringOptional

origin id

parentEntryTypestringOptional

parent of document

parentRefIdstringOptional

parent id

documentanyOptional

Search-Dialog

422

query was not valid to process

application/json

post/cmn/ft-search/phonetic

HTTPcURLJavaScriptPython

POST /api/cmn/ft-search/phonetic HTTP/1.1
Host: 10.102.24.218:32792
Content-Type: application/json
Accept: */*
Content-Length: 130

{
  "languageCode": "text",
  "types": [
    "text"
  ],
  "name1": "text",
  "name2": "text",
  "name3": "text",
  "street": "text",
  "city": "text",
  "email": "text"
}

[]

Find the Resource by query-parameters

get

Query parameters

wordsanyOptional

terms to search for

typesanyOptional

types to search into

groupedanyOptional

should the result be grouped by types

_limitanyOptional

max number of search results (per group, if grouped == true)

_startanyOptional

Offset

modestring · enumOptionalPossible values:

perspectiveanyOptional

Perspective of result

Responses

200

successful operation

application/json

entryTypestringOptional

origin of document

refIdstringOptional

origin id

parentEntryTypestringOptional

parent of document

parentRefIdstringOptional

parent id

documentanyOptional

Search-Dialog

422

query was not valid to process

application/json

get/cmn/ft-search

HTTPcURLJavaScriptPython

GET /api/cmn/ft-search HTTP/1.1
Host: 10.102.24.218:32792
Accept: */*

[]

return all available types

get

Query parameters

indexablebooleanOptional

Responses

200

OK

application/json

string[]Optional

get/cmn/ft-search/types

HTTPcURLJavaScriptPython

GET /api/cmn/ft-search/types HTTP/1.1
Host: 10.102.24.218:32792
Accept: */*

200

OK

[
  "text"
]

get

Responses

200

OK

application/json

typestringOptional

countinteger · int64Optional

get/cmn/ft-search/types/statistics

HTTPcURLJavaScriptPython

GET /api/cmn/ft-search/types/statistics HTTP/1.1
Host: 10.102.24.218:32792
Accept: */*

200

OK

[]

unstructured search

get

Query parameters

wordsanyOptional

terms to search for

typesanyOptional

types to search into

perspectiveanyOptional

Perspective of result

Responses

200

successful operation

application/json

entryTypestringOptional

origin of document

refIdstringOptional

origin id

parentEntryTypestringOptional

parent of document

parentRefIdstringOptional

parent id

documentanyOptional

Search-Dialog

422

query was not valid to process

application/json

get/cmn/ft-search/find-first

HTTPcURLJavaScriptPython

GET /api/cmn/ft-search/find-first HTTP/1.1
Host: 10.102.24.218:32792
Accept: */*

{
  "entryType": "text",
  "refId": "text",
  "parentEntryType": "text",
  "parentRefId": "text",
  "document": null
}