REST API

REST API allows you quick and easy access to the main functions of Stimulsoft Cloud and automates user actions of the system in your application. Access points to the REST-services should be on your domain and be accessible via HTTP/HTTPS. For example, we will use the locally installed version of Stimulsoft Server with the URL http://cloud.stimulsoft.com. A relative path begins with the prefix /1/ which means the first version of REST API.

EndPoint	HTTP Verb	Action
/1/login	GET	Login registered user
/1/logout	DELETE	User logout
/1/signup	POST	New user registration
/1/users	GET	Getting a list of users
/1/users	POST	Creating a new user
/1/users/<UserId>	GET	[Getting information about the user ](/Stimulsoft.Server.API.Manual/Stimulsoft_Cloud/REST_API/Users/Get_Info.html)
/1/users/<UserId>	PUT	[Changing user information ](/Stimulsoft.Server.API.Manual/Stimulsoft_Cloud/REST_API/Users/Put_Edit.html)
/1/users/<UserId>	DELETE	[Removing a user ](/Stimulsoft.Server.API.Manual/Stimulsoft_Cloud/REST_API/Users/Delete.html)
/1/users/current	GET	Getting information about the current user
/1/users/current	PUT	Changing the current user information
/1/users/<UserId>/changepassword	PUT	Change user password
/1/users/current/changepassword	PUT	Changing the password of the current user
/1/users/<UserId>/resetpassword	PUT	[Initialize reset the user’s password](/Stimulsoft.Server.API.Manual/Stimulsoft_Cloud/REST_API/Users/Reset_password.html)
/1/users/current/resetpassword	PUT	Initialize the current user password reset
/1/resetpassword/secretcode	PUT	Confirm password reset by a secret code
/1/items	GET	Getting a list of items
/1/items/<ItemId>	GET	[Getting information about the element ](/Stimulsoft.Server.API.Manual/Stimulsoft_Cloud/REST_API/Items/GET_Info.html)
/1/items	POST	Create a new item
/1/items/<ItemId>	PUT	[Changing information about the element ](/Stimulsoft.Server.API.Manual/Stimulsoft_Cloud/REST_API/Items/PUT_Edit.html)
/1/items/<ItemId>	DELETE	[Deleting an element ](/Stimulsoft.Server.API.Manual/Stimulsoft_Cloud/REST_API/Items/DELETE.html)
/1/items/<ItemId>/share	GET	[Getting information about public access to the element ](/Stimulsoft.Server.API.Manual/Stimulsoft_Cloud/REST_API/Items/Share/GET_Info.html)
/1/items/<ItemId>/share	PUT	[Changing data on public access to the element ](/Stimulsoft.Server.API.Manual/Stimulsoft_Cloud/REST_API/Items/Share/PUT_Edit.html)
/1/items/<ItemId>/share	DELETE	[Removing an element from public access](/Stimulsoft.Server.API.Manual/Stimulsoft_Cloud/REST_API/Items/Share/DELETE_Reset.html)
/1/reporttemplates	GET	Getting a list of report templates
/1/reporttemplates/<ReportTemplateId>/	GET	[Getting information about the report template ](/Stimulsoft.Server.API.Manual/Stimulsoft_Cloud/REST_API/Report_Template/GET_Info.html)
/1/reporttemplates	POST	Creating a new report template
/1/reporttemplates/<ReportTemplateId>/	DELETE	[Removing a report template ](/Stimulsoft.Server.API.Manual/Stimulsoft_Cloud/REST_API/Report_Template/DELETE.html)
/1/reporttemplates/<ReportTemplateId>/run	PUT	Build the report template and save result to another item