vmario/wisemapping-open-source
1
0
Fork 0
mirror of https://bitbucket.org/wisemapping/wisemapping-open-source.git synced 2024-11-09 00:43:23 +01:00
Code Issues Packages Projects Releases Wiki Activity
b5a7a11920
wisemapping-open-source/wise-webapp/doc/REST Services.md
Paulo Gustavo Veiga a7316d516c Add rest service doc.
2013-02-22 20:08:48 -03:00

1.6 KiB
Raw Blame History

REST Services

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

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"

Deleting a based on the user id:

  • 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"

Changing Password: Template Path: /service/admin/users/{userId}/password

  • curl "http://{host.name}:{host.port}/{context.path}/service/admin/users/{userId}/password" --request put --basic -u "admin@wisemapping.org:admin" -H "Content-Type:text/plain" --data "<new_password>"

Creating a new user:

  • Template Path: /service/admin/users/
  • Method: Post
  • curl "http://{host.name}:{host.port}/{context.path}/service/admin/users/" --request post --basic -u "admin@wisemapping.org:admin" -H "Content-Type:text/json" --data "{email:"some email", lastname:"last name",fistname="my first name",password:"password"}"