REST - Document - AdditionalProperty

REST-Interface

Get additional property by id

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

Path parameter

  • additionalPropertyId

Query parameter

  • languageKey possible: de, en, fr, it, ... default: de The requested language

Produces

application/json
application/xml

com.matterial.mtr.api.object.AdditionalProperty

  • 200 OK
  • 400 BAD_REQUEST
  • 404 NOT_FOUND
  • 500 INTERNAL_SERVER_ERROR

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

  • propertyType possible: 1, 2, 3, 4, 5 The number of a known property-type: 1 - NEWS 2 - URGENT 3 - HELP_SECTION_DASHBOARD 4 - HELP_SECTION_DOCUMENT_EDITOR 5 - SNAP
  • languageKey possible: de, en, fr, it, ... default: de The requested language
  • orderBy possible: id name description default: id the order by
  • orderDir possible: asc, desc default: asc the ordering direction
  • offset
  • limit

Produces

application/json
application/xml

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

  • 200 OK
  • 500 INTERNAL_SERVER_ERROR

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

  • languageKey possible: de, en, fr, it, ... default: de The requested language

Consumes

application/json
application/xml

com.matterial.mtr.api.object.AdditionalProperty

Produces

application/json
application/xml

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

  • 201 CREATED
  • 400 BAD_REQUEST
  • 500 INTERNAL_SERVER_ERROR

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

  • additionalPropertyId

Query parameter

  • languageKey possible: de, en, fr, it, ... default: de The requested language

Consumes

application/json
application/xml

com.matterial.mtr.api.object.AdditionalProperty

Produces

application/json
application/xml

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

  • 201 CREATED
  • 400 BAD_REQUEST
  • 500 INTERNAL_SERVER_ERROR

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

  • additionalpropertyId

Produces

text/plain

Integer - count of removed

  • 200 OK
  • 400 BAD_REQUEST
  • 404 NOT_FOUND
  • 500 INTERNAL_SERVER_ERROR

Permission
EDIT_ADDITIONAL_PROPERTY

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

×
Peter's Problem.