REST - InstanceControl
REST-Interface
REST-Interface
Attention:
This API requires the systemAccount which is only available in on-premises installations (private cloud).
Creates and inits another instance. This also creates a credential and the corresponding person (account/contact) as instanceadmin with all initial functional roles assigned (including admin). At least this updates the licence for the newly created instance.
You can set a password optionally. Therfore set Signup.password AND Signup.updatePassword = true. If updatePassword is false a Credential without password will be created! Only in this case an E-Mail notification with link will be sent.
URL
POST <application-url>/api/instancecontrol/signup
Query parameter
Consumes
application/json
application/xml
com.matterial.mtr.api.object.Signup
Produces
application/json
application/xml
com.matterial.mtr.api.object.LoginData
Permission
systemAccountRequired
Sample
POST http://localhost:8080/mtr-backend/api/instancecontrol/signup
Attention:
This API requires the systemAccount which is only available in on-premises installations (private cloud).
URL
POST <application-url>/api/instancecontrol/instance
Consumes
application/json
application/xml
com.matterial.mtr.api.object.WildflyDataSource
Produces
application/json
application/xml
com.matterial.mtr.api.object.LoginData
Permission
systemAccountRequired
Sample
POST http://localhost:8080/mtr-backend/api/instancecontrol/instance
Attention:
Won’t work on multiserve-installation.
Use Logon.preChangeinstance-API!
URL
PUT <application-url>/api/instancecontrol/instance/<dataSourceName>
Path parameter
Produces
application/json
application/xml
com.matterial.mtr.api.object.LoginData
Permission
Login
Sample
PUT http://localhost:8080/mtr-backend/api/instancecontrol/instance/MtrInst2DS
Attention:
Won’t work on multiserve-installation.
Use Logon.preChangeinstance-API!
URL
PUT <application-url>/api/instancecontrol/instance/byid/<dataSourceId>
Path parameter
Produces
application/json
application/xml
com.matterial.mtr.api.object.LoginData
Permission
Login
Sample
PUT http://localhost:8080/mtr-backend/api/instancecontrol/instance/byid/4
Get all invitees, that do not exist in instance yet.
URL
GET <application-url>/api/instancecontrol/credential/invitee
Produces
application/json
application/xml
List<com.matterial.mtr.api.object.Credential>
Permission
Login, instanceOwnerRequired
Sample
GET http://localhost:8080/mtr-backend/api/instancecontrol/credential/invitee
This resends the invitation mail to the invitee and renews its LoginToken.
URL
PUT <application-url>/api/instancecontrol/credential/invitee/<credentialId>
Path parameter
Query parameter
Produces
Permission
instanceOwnerRequired
Sample
PUT http://localhost:8080/mtr-backend/api/instancecontrol/credential/invitee/5
Remove the credential from current instance. Additionally this removes the whole credential if no more related instances are left.
URL
DELETE <application-url>/api/instancecontrol/credential/invitee/<credentialId>
Path parameter
Produces
text/plain
[Integer] count of removed invitees
Permission
instanceOwnerRequired
Sample
DELETE http://localhost:8080/mtr-backend/api/instancecontrol/credential/invitee/5
Attention:
This API requires the systemAccount which is only available in on-premises installations (private cloud).
This is only available for system-account. This sets the password and is the only possibility to store credentials for several data-sources.
URL
PUT <application-url>/api/instancecontrol/credential/withdatasources
Consumes
application/json
application/xml
com.matterial.mtr.api.object.Credential
Produces
text/plain
Long - credential-id
Permission
Login, systemAccount
Sample
PUT http://localhost:8080/mtr-backend/api/instancecontrol/credential/withdatasources
This is only available for instance-admins. Instance-Admins can only create credentials within the current instance (datasource). Credential.password and Credential.dataSources will be ignored. The current instance will be added to the existing. Set Credential.limited=true
to create (“invite”) a user with limited permissions. An E-Mail-notification-link will be created to login without password.
URL
PUT <application-url>/api/instancecontrol/credential
Query parameter
Consumes
application/json
application/xml
com.matterial.mtr.api.object.CredentialWithInvitationText
Produces
text/plain
Long - credential-id
Permission
Login, instanceAdmin
Sample
PUT http://localhost:8080/mtr-backend/api/instancecontrol/credential
This is only available for instance-admins. Instance-Admins can only create credentials within the current instance (datasource). Credential.password and Credential.dataSources will be ignored. The current instance will be added to the existing. Set Credential.limited=true
to create (“invite”) a user with limited permissions. An E-Mail-notification-link will be created to login without password.
URL
PUT <application-url>/api/instancecontrol/credential/list
Query parameter
Consumes
application/json
application/xml
List<com.matterial.mtr.api.object.CredentialWithInvitationText>
Produces
application/json
application/xml
List<Long>
- credential-ids
Permission
Login, instanceAdmin
Sample
PUT http://localhost:8080/mtr-backend/api/instancecontrol/credential/list
URL
PUT <application-url>/api/instancecontrol/credential/favdatasource
Consumes
application/json
application/xml
com.matterial.mtr.api.object.DataSource
Produces
application/json
application/xml
com.matterial.mtr.api.object.LoginData
Permission
Login
Sample
PUT http://localhost:8080/mtr-backend/api/instancecontrol/credential/favdatasource
Attention:
This API requires the systemAccount which is only available in on-premises installations (private cloud).
URL
GET <application-url>/api/instancecontrol/instance/<dataSourceId>
Path parameter
Produces
application/json
application/xml
com.matterial.mtr.api.object.DataSource
Permission
Login, systemAccountRequired
Sample
GET http://localhost:8080/mtr-backend/api/instancecontrol/instance/1
Attention:
This API requires the systemAccount which is only available in on-premises installations (private cloud).
URL
GET <application-url>/api/instancecontrol/instance
Query parameter
Produces
application/json
application/xml
com.matterial.mtr.api.object.ListResult<DataSource>
Permission
Login, systemAccountRequired
Sample
GET http://localhost:8080/mtr-backend/api/instancecontrol/instance?count=true
URL
PUT <application-url>/api/instancecontrol/instance/displayname/<displayName>
Path parameter
Produces
application/json
application/xml
com.matterial.mtr.api.object.LoginData
Permission
instanceOwnerRequired
Sample
PUT http://localhost:8080/mtr-backend/api/instancecontrol/instance/displayname/MyCompany
Attention:
This API requires the systemAccount which is only available in on-premises installations (private cloud).
Activates an instance (datasource) for unlimited days.
URL
PUT <application-url>/api/instancecontrol/instance/<dataSourceName>/activate/unlimited
Path parameter
Produces
text/plain
[Integer] updated
Permission
Login, systemAccountRequired
Sample
PUT http://localhost:8080/mtr-backend/api/instancecontrol/instance/MtrDS/activate/unlimited
Attention:
This API requires the systemAccount which is only available in on-premises installations (private cloud).
Activates an instance (datasource) for the next specified days.
URL
PUT <application-url>/api/instancecontrol/instance/<dataSourceName>/activate/days/<days>
Path parameter
Produces
text/plain
[Integer] updated
Permission
Login, systemAccountRequired
Sample
PUT http://localhost:8080/mtr-backend/api/instancecontrol/instance/MtrDS/activate/days/30
Attention:
This API requires the systemAccount which is only available in on-premises installations (private cloud).
Deactivates an active instance (datasource).
URL
PUT <application-url>/api/instancecontrol/instance/<dataSourceName>/deactivate
Path parameter
Produces
text/plain
[Integer] updated
Permission
Login, systemAccountRequired
Sample
PUT http://localhost:8080/mtr-backend/api/instancecontrol/instance/MtrDS/deactivate
Attention:
This API requires the systemAccount which is only available in on-premises installations (private cloud).
Removes inactive instance (datasource). Instance / DataSource has to be deactivated before removing it.
URL
DELETE <application-url>/api/instancecontrol/instance/<dataSourceName>
Path parameter
Produces
text/plain
[Boolean] success
Permission
Login, systemAccountRequired
Sample
DELETE http://localhost:8080/mtr-backend/api/instancecontrol/instance/MtrDS
Get Two Factor Auth QR-Code.
URL
GET <application-url>/api/instancecontrol/twofactorauth/qrcode
Produces
Permission
Login
Sample
GET http://localhost:8080/mtr-backend/api/instancecontrol/twofactorauth/qrcode
Activate Two Factor Auth for current user.
URL
POST <application-url>/api/instancecontrol/twofactorauth
Produces
application/json
application/xml
com.matterial.mtr.api.object.LoginData
Permission
Login
Sample
POST http://localhost:8080/mtr-backend/api/instancecontrol/twofactorauth
Authorize the given Two Factor Auth verification code.
URL
PUT <application-url>/api/instancecontrol/twofactorauth
Consumes
text/plain
Integer - verification code
Produces
application/json
application/xml
com.matterial.mtr.api.object.LoginData
Permission
Login, twoFactorAuthNotRequired
Sample
PUT http://localhost:8080/mtr-backend/api/instancecontrol/twofactorauth
Deactivate Two Factor Auth for current user.
URL
DELETE <application-url>/api/instancecontrol/twofactorauth
Produces
application/json
application/xml
com.matterial.mtr.api.object.LoginData
Permission
Login
Sample
DELETE http://localhost:8080/mtr-backend/api/instancecontrol/twofactorauth
Attention:
This API requires the systemAccount which is only available in on-premises installations (private cloud).
This removes the complete index from filesystem of the current instance!
URL
DELETE <application-url>/api/instancecontrol/search/index
Produces
text/plain
boolean - true on success
Permission
systemAccountRequired
Sample
DELETE http://localhost:8080/mtr-backend/api/instancecontrol/search/index
Attention:
This API requires the systemAccount which is only available in on-premises installations (private cloud).
This removes the complete index from filesystem and reindexes all persons and documents for each instance.
URL
PUT <application-url>/api/instancecontrol/search/reindexall
Permission
systemAccountRequired
Sample
PUT http://localhost:8080/mtr-backend/api/instancecontrol/search/reindexall