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 |
|
/1/logout |
DELETE |
|
/1/signup |
POST |
|
/1/users |
GET |
|
/1/users |
POST |
|
/1/users/<UserId> |
GET |
|
/1/users/<UserId> |
PUT |
|
/1/users/<UserId> |
DELETE |
|
/1/users/current |
GET |
|
/1/users/current |
PUT |
|
/1/users/<UserId>/changepassword |
PUT |
|
/1/users/current/changepassword |
PUT |
|
/1/users/<UserId>/resetpassword |
PUT |
|
/1/users/current/resetpassword |
PUT |
|
/1/resetpassword/secretcode |
PUT |
|
/1/roles |
GET |
|
/1/roles/<RoleId> |
GET |
|
/1/roles |
POST |
|
/1/roles/<RoleId> |
PUT |
|
/1/roles/<RoleId> |
DELETE |
|
/1/items |
GET |
|
/1/items/<ItemId> |
GET |
|
/1/items |
POST |
|
/1/items/<ItemId> |
PUT |
|
/1/items/<ItemId> |
DELETE |
|
/1/items/<ItemId>/share |
GET |
Getting information about public access to the element <ItemId> |
/1/items/<ItemId>/share |
PUT |
|
/1/items/<ItemId>/share |
DELETE |
|
/1/schedulers |
GET |
|
/1/schedulers/<SchedulerId> |
GET |
|
/1/schedulers |
POST |
|
/1/schedulers/<SchedulerId> |
PUT |
|
/1/schedulers/<SchedulerId> |
DELETE |
|
/1/schedulers/<SchedulerId>/status |
GET |
Getting information about the state of the scheduler <SchedulerId> |
/1/schedulers/<SchedulerId>/status |
PUT |
|
/1/schedulers/<SchedulerId>/run |
PUT |
|
/1/files |
GET |
|
/1/files/<FileId>/ |
GET |
|
/1/files |
POST |
|
/1/files/<FileId>/ |
PUT |
|
/1/files/<FileId>/ |
DELETE |
|
/1/reporttemplates |
GET |
|
/1/reporttemplates/<ReportTemplateId>/ |
GET |
Getting information about the report template <ReportTemplateId> |
/1/reporttemplates |
POST |
|
/1/reporttemplates/<ReportTemplateId>/ |
DELETE |
|
/1/reporttemplates/<ReportTemplateId>/run |
PUT |
|
/1/reporttemplates/<ReportTemplateId>/duplicate |
POST |
Creating a new copy of the report template in a workspace of the logged-in user. |
/1/reportsnapshots |
GET |
|
/1/reportsnapshots/<ReportSnapshotId>/ |
GET |
Getting information about the report snapshot <ReportSnapshotId> |
/1/reportsnapshots |
POST |
|
/1/reportsnapshots/<ReportSnapshotId>/ |
DELETE |
|
/1/reportsnapshots/<ReportSnapshotId>/export |
PUT |