REST - Category
REST-Interface
REST-Interface
URL
GET <application-url>/api/category/<categoryId>
Path parameter
Query parameter
Category.following
for current account.Produces
application/json
application/xml
com.matterial.mtr.api.object.Category
Permission
Login
Sample
GET http://localhost:8080/mtr-backend/api/category/7?languageKey=de
URL
GET <application-url>/api/category/bytype/<categoryTypeId>
Path parameter
Query parameter
Category.following
for current account.Produces
application/json
application/xml
List<com.matterial.mtr.api.object.Category>
Permission
Login
Sample
GET http://localhost:8080/mtr-backend/api/category/bytype/1
URL
GET <application-url>/api/category
Query parameter
Category.following
for current account.Produces
application/json
application/xml
List<com.matterial.mtr.api.object.Category>
Permission
Login
Sample
GET http://localhost:8080/mtr-backend/api/category?categoryTypeId=1
URL
POST <application-url>/api/category
Query parameter
Consumes
application/json
application/xml
com.matterial.mtr.api.object.Category
Produces
application/json
application/xml
com.matterial.mtr.api.object.Category (id only)
Permission
EDIT_CATEGORY
Sample
POST http://localhost:8080/mtr-backend/api/category
URL
PUT <application-url>/api/category/<categoryId>
Path parameter
Query parameter
Consumes
application/json
application/xml
com.matterial.mtr.api.object.Category
Produces
application/json
application/xml
com.matterial.mtr.api.object.Category (id only)
Permission
EDIT_CATEGORY
Sample
PUT http://localhost:8080/mtr-backend/api/category/8
URL
DELETE <application-url>/api/category/<categoryId>
Path parameter
Produces
text/plain
Integer - count of removed
Permission
EDIT_CATEGORY
Sample
DELETE http://localhost:8080/mtr-backend/api/category/9
URL
DELETE <application-url>/api/category/bytype/<categoryTypeId>
Path parameter
Produces
text/plain
Integer - count of removed
Permission
EDIT_CATEGORY
Sample
DELETE http://localhost:8080/mtr-backend/api/category/bytype/1
URL
GET <application-url>/api/category/<categoryId>/follow
Path parameter
Query parameter
Produces
text/plain
Boolean - true, if following this category in language
Permission
Login
Sample
GET http://localhost:8080/mtr-backend/api/category/2/follow?languageKey=de
URL
PUT <application-url>/api/category/<categoryId>/follow
Path parameter
Query parameter
Produces
text/plain
Integer - count of updates
Permission
Login
Sample
PUT http://localhost:8080/mtr-backend/api/category/2/follow?languageKey=de
URL
PUT <application-url>/api/category/<categoryId>/follow/byaccount/<accountId>
Path parameter
Query parameter
Produces
text/plain
Integer - count of updates
Permission
Login
Sample
PUT http://localhost:8080/mtr-backend/api/category/2/follow/byaccount/3?languageKey=de
URL
PUT <application-url>/api/category/<categoryId>/unfollow
Path parameter
Query parameter
Produces
text/plain
Integer - count of updates
Permission
Login
Sample
PUT http://localhost:8080/mtr-backend/api/category/2/unfollow?languageKey=de
URL
PUT <application-url>/api/category/<categoryId>/unfollow/byaccount/<accountId>
Path parameter
Query parameter
Produces
text/plain
Integer - count of updates
Permission
Login
Sample
PUT http://localhost:8080/mtr-backend/api/category/2/unfollow/byaccount/3?languageKey=de
URL
PUT <application-url>/api/category/<categoryId>/assign
Path parameter
Query parameter
Produces
text/plain
Integer - count of updates
Permission
Login
Sample
PUT http://localhost:8080/mtr-backend/api/category/2/assign?documentId=1
URL
PUT <application-url>/api/category/quick/assign
Query parameter
Produces
text/plain
Integer - count of updates
Permission
Login
Sample
PUT http://localhost:8080/mtr-backend/api/category/quick/assign?documentId=1
URL
DELETE/PUT <application-url>/api/category/<categoryId>/unassign
Path parameter
Query parameter
Produces
text/plain
Integer - count of updates
Permission
Login
Sample
PUT http://localhost:8080/mtr-backend/api/category/2/unassign?documentId=1
URL
DELETE/PUT <application-url>/api/category/quick/unassign
Query parameter
Produces
text/plain
Integer - count of updates
Permission
Login
Sample
PUT http://localhost:8080/mtr-backend/api/category/quick/unassign?documentId=1