matterial

Zurück zur Übersicht » REST - Document - AdditionalProperty

REST - Document - AdditionalProperty

REST-Interface

Get additional property by id

URL
GET <application-url>/api/document/additionalproperty/<additionalPropertyId>

Path parameter

Query parameter

Produces

application/json
application/xml

com.matterial.mtr.api.object.AdditionalProperty

Permission
Login

Sample
GET http://localhost:8080/mtr-backend/api/document/additionalproperty/2?languageKey=en


Get additional properties

URL
GET <application-url>/api/document/additionalproperty

Query parameter

Produces

application/json
application/xml

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

Permission
Login

Sample
GET http://localhost:8080/mtr-backend/api/document/additionalproperty?propertyType=5


Create additional property

URL
POST <application-url>/api/document/additionalproperty

Query parameter

Consumes

application/json
application/xml

com.matterial.mtr.api.object.AdditionalProperty

Produces

application/json
application/xml

com.matterial.mtr.api.object.AdditionalProperty (id only)

Permission
EDIT_ADDITIONAL_PROPERTY

Sample
POST http://localhost:8080/mtr-backend/api/document/additionalproperty?languageKey=en


Update additional property

URL
PUT <application-url>/api/document/additionalproperty/<additionalPropertyId>

Path parameter

Query parameter

Consumes

application/json
application/xml

com.matterial.mtr.api.object.AdditionalProperty

Produces

application/json
application/xml

com.matterial.mtr.api.object.AdditionalProperty (id only)

Permission
EDIT_ADDITIONAL_PROPERTY

Sample
PUT http://localhost:8080/mtr-backend/api/document/additionalproperty/4?languageKey=de


Remove additional property

URL
DELETE <application-url>/api/document/additionalproperty/<additionalpropertyId>

Path parameter

Produces

text/plain

Integer - count of removed

Permission
EDIT_ADDITIONAL_PROPERTY

Sample
DELETE http://localhost:8080/mtr-backend/api/document/additionalproperty/4


Is following (logged-in account follows an additional property)

URL
GET <application-url>/api/document/additionalproperty/<additionalPropertyId>/follow

Path parameter

Query parameter

Produces

text/plain

Boolean - true, if following this additional property in language

Permission
Login

Sample
GET http://localhost:8080/mtr-backend/api/document/additionalproperty/2/follow?languageKey=de


Follow additional property (logged-in account)

URL
PUT <application-url>/api/document/additionalproperty/<additionalPropertyId>/follow

Path parameter

Query parameter

Produces

text/plain

Integer - count of updates

Permission
Login

Sample
PUT http://localhost:8080/mtr-backend/api/document/additionalproperty/2/follow?languageKey=de


Follow additional property (other account)

URL
PUT <application-url>/api/document/additionalProperty/<additionalPropertyId> /follow/byaccount/<accountId>

Path parameter

Query parameter

Produces

text/plain

Integer - count of updates

Permission
Login

Sample
PUT http://localhost:8080/mtr-backend/api/document/additionalproperty/2/follow/byaccount/3?languageKey=de


Unfollow additional property (logged-in account)

URL
PUT <application-url>/api/document/additionalproperty/<additionalPropertyId> /unfollow

Path parameter

Query parameter

Produces

text/plain

Integer - count of updates

Permission
Login

Sample
PUT http://localhost:8080/mtr-backend/api/document/additionalproperty/2/unfollow?languageKey=de


Unfollow additional property (other account)

URL
PUT <application-url>/api/document/additionalproperty/<additionalPropertyId> /unfollow/byaccount/<accountId>

Path parameter

Query parameter

Produces

text/plain

Integer - count of updates

Permission
Login

Sample
PUT http://localhost:8080/mtr-backend/api/document/additionalproperty/2/unfollow/byaccount/3?languageKey=de