API Documentation

REST - Activity

REST-Interface

Activities stores all notifications that might go to a user via email or websocket. You can load the past activities which may be sent to you as notification via this API.

Get activity by id

URL
GET <application-url>/api/activity/<activityId>

Path parameter

  • activityId

Produces

application/json
application/xml

com.matterial.mtr.api.object.Activity

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

Permission
Login

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

Get activities

URL
GET <application-url>/api/activity

Query parameter

  • languageKey
    possible: en, de, …
    filter by language key of the notification
  • messageType
    • DOCUMENT_READ
    • DOCUMENT_STORED
    • DOCUMENT_CHANGED
    • DOCUMENT_PUBLISHED
    • DOCUMENT_DELETION
    • DOCUMENT_REVIEW_REQUEST
    • DOCUMENT_REVIEWED
    • DOCUMENT_REVIEW_DECLINED
    • DOCUMENT_COMMENT
    • DOCUMENT_COMMENT_ACCOUNT_MENTIONED
    • DOCUMENT_ARCHIVE
    • DOCUMENT_UNARCHIVE
    • DOCUMENT_RESTORE
    • DOCUMENT_DELETE_LANGUAGE
    • DOCUMENT_DELETE_LANGUAGE_VERSION
    • DOCUMENT_HELPFUL
    • DOCUMENT_LOCK_OVERWRITTEN
    • TASK_CREATED
    • TASK_CHANGED
    • TASK_REMOVED
    • INVITATION
    • PASSWORD_RESET_LINK
    • SIGNUP
  • personAccountId
    filter by account
    This is the account that changed something, for example somebody who published or commented a document the current user is following.
  • documentId
    filter by related document
  • documentLanguageVersionId
    filter by related version
  • documentLanguageVersionLanguageKey
    possible: en, de, …
    filter by language key of the related document
  • taskId
    filter by related task
  • notificationStatus
    • NOTIFICATION_STATUS_FALSE = 0
      No notification
    • NOTIFICATION_STATUS_PENDING = 1
      Notification pending (will be sent in next summary email)
    • NOTIFICATION_STATUS_SENT = 2
      Notification already sent via email
    • NOTIFICATION_STATUS_OPENED = 3
      Notification already opened within app (no email)
  • count
    possible: true, false
    default: false
    additionally loading count of activities
  • orderBy
    possible:
    id
    date
    documentId
    documentTitle
    default: date
    the order by
  • orderDir
    possible: asc, desc
    default: asc
    the ordering direction
  • offset
  • limit

Produces

application/json
application/xml

com.matterial.mtr.api.object.ListResult<Activity>

  • 200 OK
  • 500 INTERNAL_SERVER_ERROR

Permission
Login

Sample
GET http://localhost:8080/mtr-backend/api/activity?count=true&limit=10

Contact sales