Stimulsoft Server

REST API

REST API allows you quick and easy access to the main functions of Stimulsoft Server 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://reports.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 <UserId>
/1/users/<UserId>	PUT	Changing user information <UserId>
/1/users/<UserId>	DELETE	Removing a user <UserId>
/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 <UserId> password
/1/users/current/resetpassword	PUT	Initialize the current user password reset
/1/resetpassword/secretcode	PUT	Confirm password reset by a secret code
/1/roles	GET	Getting a list of roles
/1/roles/<RoleId>	GET	Getting information about the role <RoleId>
/1/roles	POST	Creating a new role
/1/roles/<RoleId>	PUT	Changing information about the role <RoleId>
/1/roles/<RoleId>	DELETE	Remove a role <RoleId>
/1/items	GET	Getting a list of items
/1/items/<ItemId>	GET	Getting information about the element <ItemId>
/1/items	POST	Create a new item
/1/items/<ItemId>	PUT	Changing information about the element <ItemId>
/1/items/<ItemId>	DELETE	Deleting an element <ItemId>
/1/items/<ItemId>/share	GET	Getting information about public access to the element <ItemId>
/1/items/<ItemId>/share	PUT	Changing data on public access to the element <ItemId>
/1/items/<ItemId>/share	DELETE	Removing an element <ItemId> from public access
/1/schedulers	GET	Getting a list of schedulers
/1/schedulers/<SchedulerId>	GET	Getting information about the scheduler <SchedulerId>
/1/schedulers	POST	Creating a new scheduler
/1/schedulers/<SchedulerId>	PUT	Changing information about the scheduler <SchedulerId>
/1/schedulers/<SchedulerId>	DELETE	Removal of scheduler <SchedulerId>
/1/schedulers/<SchedulerId>/status	GET	Getting information about the state of the scheduler <SchedulerId>
/1/schedulers/<SchedulerId>/status	PUT	Setting state of scheduler <SchedulerId>
/1/schedulers/<SchedulerId>/run	PUT	Immediate start of scheduler <SchedulerId>
/1/files	GET	Getting a list of files
/1/files/<FileId>/	GET	Downloading a file <FileId>
/1/files	POST	Creating a new file
/1/files/<FileId>/	PUT	Appending a new chunk to file <FileId>
/1/files/<FileId>/	DELETE	Removing a file <FileId>
/1/reporttemplates	GET	Getting a list of report templates
/1/reporttemplates/<ReportTemplateId>/	GET	Getting information about the report template <ReportTemplateId>
/1/reporttemplates	POST	Creating a new report template
/1/reporttemplates/<ReportTemplateId>/	DELETE	Removing a report template <ReportTemplateId>
/1/reporttemplates/<ReportTemplateId>/run	PUT	Build the report template and save result to another item
/1/reporttemplates/<ReportTemplateId>/duplicate	POST	Creating a new copy of the report template in a workspace of the logged-in user.
/1/reportsnapshots	GET	Getting a list of report snapshots
/1/reportsnapshots/<ReportSnapshotId>/	GET	Getting information about the report snapshot <ReportSnapshotId>
/1/reportsnapshots	POST	Creating a new report snapshot
/1/reportsnapshots/<ReportSnapshotId>/	DELETE	Removing a report snapshot <ReportSnapshotId>
/1/reportsnapshots/<ReportSnapshotId>/export	PUT	Export data from report snapshot