REST - Comment

REST-Interface

Get comment by id

URL
GET <application-url>/api/comment/<commentId>

Path parameter

Produces

application/json
application/xml

Permission
Login

Sample
GET http://localhost:8080/mtr-backend/api/comment/7

URL
GET <application-url>/api/comment

Query parameter

documentId
Id of a document
documentLanguageVersionId
The id of a document language version
contactId
Id of a contact
mentionedAccountId
Id of an account, that was mentioned within a comment
languageKey
possible: de, en, fr, it, …
default: de
The requested language
count
possible: true, false
default: false
additionally loading count of comments
orderBy
possible:
createtime
default: createtime
the order by
orderDir
possible: asc, desc
default: desc
the ordering direction
offset
limit

Produces

application/json
application/xml

Permission
Login

Sample
GET http://localhost:8080/mtr-backend/api/comment?contactId=2&count=true

URL
POST <application-url>/api/comment

Consumes

application/json
application/xml

Produces

application/json
application/xml

Permission
COMMENT

Sample
POST http://localhost:8080/mtr-backend/api/comment

URL
PUT <application-url>/api/comment/<commentId>

Path parameter

Consumes

application/json
application/xml

Produces

application/json
application/xml

Permission
COMMENT

Sample
PUT http://localhost:8080/mtr-backend/api/comment/8

URL
DELETE <application-url>/api/comment/<commentId>

Path parameter

Produces

text/plain

Integer - count of removed

Permission
COMMENT

Sample
DELETE http://localhost:8080/mtr-backend/api/comment/9