matterial

Zurück zur Übersicht » REST - Client

REST - Client

REST-Interface

Get client by id

URL
GET <application-url>/api/client/<clientId>

Path parameter

Query parameter

Produces

application/json
application/xml

com.matterial.mtr.api.object.Client

Permission
Login

Sample
GET http://localhost:8080/mtr-backend/api/client/1?loadClientPreferences=true


Get clients

URL
GET <application-url>/api/client

Query parameter

Produces

application/json
application/xml

List<com.matterial.mtr.api.object.Client>

Permission
Login

Sample
GET http://localhost:8080/mtr-backend/api/client?accountId=1


Create client

Attention:
This API only supported by on-premises installations (private cloud).

URL
POST <application-url>/api/client

Consumes

application/json
application/xml

com.matterial.mtr.api.object.client

Produces

application/json
application/xml

com.matterial.mtr.api.object.Client (id only)

Permission
systemAccountRequired

Sample
POST http://localhost:8080/mtr-backend/api/client


Update client

Attention:
This API only supported by on-premises installations (private cloud).

URL
PUT <application-url>/api/client/<clientId>

Path parameter

Consumes

application/json
application/xml

com.matterial.mtr.api.object.Client

Produces

application/json
application/xml

com.matterial.mtr.api.object.Client (id only)

Permission
systemAccountRequired

Sample
PUT http://localhost:8080/mtr-backend/api/client/2


Remove client

Attention:
This API only supported by on-premises installations (private cloud).

URL
DELETE <application-url>/api/client/<clientId>

Path parameter

Produces

text/plain

Integer - count of removed

Permission
systemAccountRequired

Sample
DELETE http://localhost:8080/mtr-backend/api/client/2