REST - Tracking

REST-Interface

Zurück zur Übersicht

Get tracking items

URL
GET <application-url>/api/tracking

Query parameter

  • count
    possible: true, false
    default: false
    load count
  • orderBy
    possible:
    id
    date
    default: date
    the order by
  • orderDir
    possible: asc, desc
    default: asc
    the ordering direction
  • offset
  • limit

Produces

application/json
application/xml

com.matterial.mtr.api.object.ListResult<TrackingItem>

  • 200 OK
  • 500 INTERNAL_SERVER_ERROR

Permission
VIEW_STATISTIC

Sample
GET http://localhost:8080/mtr-backend/api/tracking?offset=1&limit=4

Search tracking items by ‘query’

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

Query parameter

  • query
    mandatory: true
    url encoded search query
  • orderBy
    possible:
    id
    date
    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<TrackinItem>

  • 200 OK
  • 400 BAD_REQUEST
  • 500 INTERNAL_SERVER_ERROR

Permission
VIEW_STATISTIC

Sample
GET http://localhost:8080/mtr-backend/api/tracking/search?query=*

Reindex all tracking items

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

  • 202 ACCEPTED
  • 500 INTERNAL_SERVER_ERROR

Permission
ADMINISTRATE_ALL

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

×