Grundlagen6
App6
REST-Endpunkte44
- Activity
- Category
- Category - CategoryType
- ChangeLog
- Client
- Client - ClientPreference
- Client - CompanyInfoResource
- Client - Logo
- Comment
- Conversion
- Document
- Document - AdditionalProperty
- Document - ChangeLog
- Document - ExtensionValue
- Document - Lock
- Document - Rating
- Document - SavedSearch
- Document - Search
- InstanceControl
- InstanceControl - MtrMessage
- InstanceControl - Preference
- Language
- Licence
- Logon
- Logon - AutoLogin
- Logon - LTI
- Logon - MagicLink
- Logon - Ntlm
- Logon - OAuth2 - Cobot
- Logon - OAuth2 - Google
- Logon - OAuth2 - Microsoft
- Logon - Saml
- Notification
- Person
- Person - AccountSetting
- Person - Search
- Role
- Skin
- Task
- Task - TaskStatus
- TempFile
- Test
- Tracking
- Version
API-Objekte41
- AccountSetting
- Activity
- AdditionalProperty
- Attachment
- Category
- CategoryType
- Client
- Comment
- CompanyInfoItem
- Credential
- CredentialWithInvitationText
- DataSource
- Document
- DocumentChangeLog
- DocumentChangeLogMap
- DocumentClipBoardEntry
- DocumentDuplicate
- DocumentForPdfConversion
- DocumentLock
- ExtensionValue
- Language
- Licence
- LicenceUsage
- LoginData
- Logon
- MtrMessage
- MtrVersion
- NotificationContainer
- PasswordContainer
- Person
- PreferenceMapContainer
- Role
- SavedSearch
- SearchAutocompleteSuggest
- SearchResult<Document/Person>
- Signup
- Task
- TaskStatus
- TempFileDescriptor
- TrackingItem
- WildflyDataSource
Get file
Loading logo of current client.
URLGET <application-url>/api/client/logo
Query parameter
- size
possible values: s, l, t
s - small (400px width)
l - large (800px width)
t - thumbnail (200px width)
Produces
File as stream
- 200 OK
- 204 NO CONTENT
- 404 NOT FOUND
- 500 INTERNAL_SERVER_ERROR
Permission
Login
SampleGET http://localhost:8080/mtr-backend/api/client/logo?size=t
Update logo and skin
URLPUT <application-url>/api/client/logo
Query parameter
- contextToken
This token is used to identify the temporarily uploaded file (logo)
Consumes
application/json
application/xml
com.matterial.mtr.api.object.Client
You should only fill the three skinColours, that you want to store:
{
"jsonType": "Client",
"skinColourButton": "red",
"skinColourNotification": "blue",
"skinColourLabel": "orange"
}
Produces
application/json
application/xml
com.matterial.mtr.api.object.Client
- 200 OK
- 400 BAD_REQUEST
- 500 INTERNAL_SERVER_ERROR
Permission
instanceOwnerRequired
SamplePUT http://localhost:8080/mtr-backend/api/client/logo?contextToken=5b3f2a1c-4a7d-49a3-bfeb-41d0e1e3835d
Remove logo
Remove the logo from current client: Removes the cas-file and the casid from db.
URLDELETE <application-url>/api/client/logo
Produces
text/plain
Integer - count
- 200 OK
- 400 BAD_REQUEST
- 500 INTERNAL_SERVER_ERROR
Permission
instanceOwnerRequired
SampleDELETE http://localhost:8080/mtr-backend/api/client/logo