App - API Changes

Breaking changes and additions in `App` and `Messaging-Service` for each release.

Zurück zur Übersicht

App v2.4.0


Assigning / unassigning roles from persons now produces Json / XML (List<Person>) instead of nothing:

  • Assign role to person
  • Assign roles to persons
  • Unassign role from person
  • Unassign roles from persons

Changed path for assigning / unassigning multiple roles from persons. Added byaccount because of colliding paths.

  • Assign roles to persons
  • Unassign roles from persons


Automatically set (overwrite) contact (author) of comment on update / create.


REST API path renamed: permissionfree to unrestricted.

  • Get unrestricted preference by key
    • New: GET <application-url>/api/instancecontrol/preference/cache/byunrestrictedkey/<preferenceKey>
    • Old: GET <application-url>/api/instancecontrol/preference/cache/bypermissionfreekey/<preferenceKey>


  • Changed Flexmark parser options:
    • HtmlRenderer.GENERATE_HEADER_ID=true, HtmlRenderer.RENDER_HEADER_ID=true
    • AttributesExtension.FENCED_CODE_INFO_ATTRIBUTES=true
    • TocExtension / SimTocExtension activated
    • AsideExtension activated
  • Added attribute matPopout to tables and FencedCodeBlocks
  • InlineParserExtension and AttributeProvider for AsideBlocks with special info added (@info, @warn)

POM matterial-api + messaging-service


  • Search: New param allLanguages added to search, autocomplete, SavedSearch.execute (overwrites languageKey)
  • Document/Search: Do not set additionalPropertyId if additionalPropertyType is also set
  • Preferences: Possibility added to get all unrestricted keys with one API-call
  • Document: Added ignore options for related data on update (AdditionalProperties, Categories, ExtensionValues, Attachments, RoleRights, Responsibles)
  • Person: Added ignore options for related data on update / update personal data (Clients, ContactImages, Addresses, CommunicationData)
  • Version: API added to get version information as JSON
  • Client: New API for “Company info” added
  • Person/Credential: New flag limited added
  • New API: Store (invite) Credential as limited
  • New API: Person - set / remove limited flag
  • Licence: New licence part limited user added
  • Document: Action-interface “Set Responsibles” for documents on clipboard
  • Document: Action-interface “Set RoleRights” for documents on clipboard
  • Document: Automatically add in-text-links additionally to database as related document
  • Document: New param mentionedAccountIdInComment added to search and autocomplete

App v2.3.0

Parameter documentValid removed

Parameter documentValid removed and replaced by showInvalid and showInvalidOnly. The new parameters are also available now for Search.

  • Document => Get documents
  • Document => Get documents in trash (admin trash)

JSON instead of text/plain

Several interfaces will “produce” application/json / application/xml instead of text/plain:

  • Document.archive
  • Document.unarchive
  • Document.trash
  • Document.untrash
  • Document.finallyRemove
  • Document.removeLanguageVersions
  • Document.removeVersion
  • Document.setAdditionalProperties

Messaging Service v1.5

New path mail instead of messaging

Old path: /messaging-service/api/messaging.
New path: /messaging-service/api/mail.
The components of the path now are available via Api.

App v2.2.0

DocumentResource: markdownToHtml replaced by loadHtml

The misleading query parameter named markdownToHtml is replaced by loadHtml. Behaviour still keeps the same.

On true this tries to load html.
If the source is markdown, it will be converted to html.
If the source is html, the original html will be loaded.

On false this tries to load markdown, which is the default.
If the source is html, it will be converted to markdown.
If the source is markdown, the original markdown will be loaded.