REST - Licence
REST-Interface
Get licence usage (of current instance)
URL
GET <application-url>/api/licence/usage
Produces
application/json
application/xml
com.matterial.mtr.api.object.LicenceUsage
- 200 OK
- 400 BAD_REQUEST
- 404 NOT_FOUND
- 500 INTERNAL_SERVER_ERROR
Permission
Login
Sample
GET http://localhost:8080/mtr-backend/api/licence/usage
Get licence (of current instance)
URL
GET <application-url>/api/licence
Produces
application/json
application/xml
com.matterial.mtr.api.object.Licence
- 200 OK
- 400 BAD_REQUEST
- 404 NOT_FOUND
- 500 INTERNAL_SERVER_ERROR
Permission
Login
Sample
GET http://localhost:8080/mtr-backend/api/licence
Update Licence (of current instance)
This updates the licence of the current instance. Be sure to add correct “hash”, that corresponds to matterial-server (HashUtil).
URL
PUT <application-url>/api/licence
Consumes
application/json
application/xml
com.matterial.mtr.api.object.Licence
Produces
application/json
application/xml
com.matterial.mtr.api.object.Licence
- 200 OK
- 400 BAD_REQUEST
- 500 INTERNAL_SERVER_ERROR
Permission
instanceOwnerRequired
Sample
PUT http://localhost:8080/mtr-backend/api/licence
Check Licence (of current instance)
This checks a given licence if it could be updated. Be sure to add correct “hash”, that corresponds to matterial-server (HashUtil).
URL
PUT <application-url>/api/licence/check
Consumes
application/json
application/xml
com.matterial.mtr.api.object.Licence
Produces
application/json
application/xml
com.matterial.mtr.api.object.Licence
- 200 OK
- 400 BAD_REQUEST
- 500 INTERNAL_SERVER_ERROR
Permission
instanceOwnerRequired
Sample
PUT http://localhost:8080/mtr-backend/api/licence/check
Generate Licence
Attention:
This API requires the systemAccount which is only available in on-premises installations (private cloud).
This adds a valid licence-key to given licence.
URL
PUT <application-url>/api/licence/generate
Consumes
application/json
application/xml
com.matterial.mtr.api.object.Licence
Produces
application/json
application/xml
com.matterial.mtr.api.object.Licence
- 200 OK
- 400 BAD_REQUEST
- 500 INTERNAL_SERVER_ERROR
Permission
systemAccountRequired
Sample
PUT http://localhost:8080/mtr-backend/api/licence/generate