wisemapping-open-source/wise-webapp/doc/REST Services.md

26 lines
1.1 KiB
Markdown
Raw Normal View History

2012-09-08 17:01:26 +02:00
REST Services
---------------
2012-11-02 01:36:41 +01:00
Introduction
-------------
All WiseMapping services are exposed as REST services. Those services are the same used by the WiseMapping when you are using it.
In the following section, all supported services are listed. The following variables should be replaced:
- host.name: Host name where WiseMapping is deployed. Default Value: localhost
- host.post: Post number where WiseMapping is deployed. Default Value: 8080
- context.path: Context Path name where the application is deployed. Default Value: wisemapping
2012-09-08 17:01:26 +02:00
2012-11-02 01:36:41 +01:00
Supported Operations
----------------------
Obtaining user information by email:
* Template Path: /service/admin/users/email/{user.email}.json
* Example: curl "http://{host.name}:{host.port}/{context.path}/service/admin/users/email/{user.email}.json" --get --basic -u "admin@wisemapping.org:admin"
2012-09-08 17:01:26 +02:00
Deleting a based on the user id:
2012-11-02 01:36:41 +01:00
* Template Path: /service/admin/users/{userId}
* curl "http://{host.name}:{host.port}/{context.path}/service/admin/users/{userId}" --request delete --basic -u "admin@wisemapping.org:admin"
2012-09-08 17:01:26 +02:00