API Documentation

REST - Person - Search

REST-Interface

Search persons by ‘query’

URL
GET <application-url>/api/person/search

Query parameter

  • query
    mandatory: true
    url encoded search query
  • roleId
  • instanceOwnerOnly
    possible: true, false
    default: false
    only load instanceOwners, if true
  • hideInstanceOwner
    possible: true, false
    default: false
    hide instanceOwners, if true
  • demoOnly
    possible: true, false
    default: false
    only load demo users, if true
  • hideDemo
    possible: true, false
    default: false
    hide demo users, if true
  • limitedOnly
    possible: true, false
    default: false
    only load limited users, if true
  • hideLimited
    possible: true, false
    default: false
    hide limited users, if true
  • activeOnly
    possible: true, false
    default: false
    only load active persons
  • hideActive
    possible: true, false
    default: false
    only load inactive persons
  • orderBy
    possible:
    id
    active
    login
    createTime
    lastLogin
    lastName
    firstName
    the order by
  • orderDir
    possible: asc, desc
    default: asc
    the ordering direction
  • offset
  • limit

Produces

application/json
application/xml

com.matterial.mtr.api.object.SearchResult<Person>

  • 200 OK
  • 400 BAD_REQUEST
  • 500 INTERNAL_SERVER_ERROR

Permission
Login

Sample
GET http://localhost:8080/mtr-backend/api/person/search?query=philipp

Search autocomplete

URL
GET <application-url>/api/person/search/autocomplete

Query parameter

  • query
    mandatory: true
    url encoded search query
  • roleId
  • instanceOwnerOnly
    possible: true, false
    default: false
    only load instanceOwners, if true
  • hideInstanceOwner
    possible: true, false
    default: false
    hide instanceOwners, if true
  • activeOnly
    possible: true, false
    default: false
    only load active persons
  • hideActive
    possible: true, false
    default: false
    only load inactive persons

Produces

application/json
application/xml

List<com.matterial.mtr.api.object.SearchAutocompleteSuggest>

  • 200 OK
  • 400 BAR_REQUEST
  • 500 INTERNAL_SERVER_ERROR

Permission
Login

Sample
GET http://localhost:8080/mtr-backend/api/person/search/autocomplete

Reindex all persons

URL
PUT / POST <application-url>/api/person/search/reindexall

  • 202 ACCEPTED
  • 500 INTERNAL_SERVER_ERROR

Permission
ADMINISTRATE_ALL

Sample
PUT http://localhost:8080/mtr-backend/api/person/search/reindexall

Contact sales