PBRS REST API Endpoint Reference
Use one canonical catalog for PBRS API methods, paths, authentication, requests, responses and side effects.
Review status: Draft for Development and Support review. Routes and models labelled validation required must be tested against the supported PBRS build before publication.
How to read an endpoint entry
Every production endpoint must be documented with the same contract: purpose, supported build, method, canonical path, authentication, permission, parameter location, request model, success response, errors, retryability, side effects and read-back verification.
Verified operation catalog
| Area | Operation | Status |
|---|---|---|
| Power BI schedules | GET /api/singleschedule/getall |
Published reference; verify current build |
| Power BI schedules | GET /api/singleschedule/get/{id} |
Published reference; verify current build |
| Power BI schedules | POST /api/singleschedule/createforpowerbi |
Published reference; verify model |
| Power BI schedules | POST /api/singleschedule/updateforpowerbi |
Published reference; verify model |
| Paginated schedules | GET /api/singleschedule/getallpaginated |
Published reference; verify current build |
| Paginated schedules | GET /api/singleschedule/getpaginated/{id} |
Published reference; verify current build |
| Paginated schedules | POST /api/singleschedule/createpaginated |
Published reference; verify model |
| Paginated parameters | POST /api/singleschedule/updateparameterspaginated |
Support-evidenced; build and schema validation required |
Operations requiring contract validation
- Single and paginated delete operations
- Bulk paginated creation
- Visual and paginated discovery routes with disputed method or body behavior
- SSRS creation and complete discovery
- Package schedule update
- Pagination, batch, payload, rate, concurrency and timeout limits
Do not publish a route as supported merely because a controller or error message suggests that it exists.
Canonical operation catalogue
| Area | Method and path | Purpose | Status |
|---|---|---|---|
| Authentication | POST /api/login/token |
User-context token | Published |
| Authentication | POST /oauth2/token |
Client-credentials token | Published |
| Service | GET /api/service/ping |
API health | Published; unauthenticated |
| Service | GET /api/service/isschedulerrunning |
Scheduler state | Published |
| Service | GET /api/service/startscheduler |
Start scheduler | Published; state-changing GET |
| Service | GET /api/service/stopscheduler |
Stop scheduler | Published; state-changing GET |
| Service | GET /api/service/getconfigpath |
Configuration path | Published; sensitive |
| Service | POST /api/service/updatecollaborationsettings |
Collaboration settings | Published; model validation required |
| Execution | POST /api/schedule/executeschedule |
Synchronous execution | Published |
| Execution | POST /api/schedule/executescheduleasync |
Asynchronous execution | Published |
| Execution | POST /api/schedule/executescheduleontimeasync |
Scheduled-time execution; advances NextRun | Published |
| Execution | GET /api/schedule/getnumberoffreethreads |
Available capacity | Published |
| Execution | GET /api/schedule/cancelexecution?ExecutionId={id} |
Attempt cancellation | Published |
| Execution | GET /api/schedule/GetExecutionStatus?ExecutionId={id} |
Execution state | Published |
| Execution | GET /api/schedule/GetExecutionQueue |
Waiting, active and recent work | Published; 12-hour window |
| Folder | GET /api/folder/get/{id} |
Folder | Published |
| Folder | GET /api/folder/getsubfolders/{id} |
Child folders | Published |
| Folder | GET /api/folder/getschedules/{id} |
Folder schedules | Published |
| Folder | POST /api/folder/getuniqueidfrompath |
Resolve schedule ID | Published |
| Folder | POST /api/folder/getfolderfrompath |
Resolve folder | Published |
| Power BI | GET /api/powerbiaccount/getall |
Accounts | Published |
| Power BI | GET /api/powerbiaccount/getworkspaces/{id} |
Workspaces | Published |
| Power BI | GET /api/powerbiaccount/getreports |
Reports | GET-body validation required |
| Power BI | GET /api/powerbiaccount/getdashboards |
Dashboards | GET-body validation required |
| Power BI | /api/powerbiaccount/getvisualsforreport |
Visuals/page indexes | Method conflict; validate |
| Power BI | Paginated discovery route | Paginated reports | Published path is wrong; validate |
| SSRS | GET /api/ssrsaccount/getall |
Configured accounts | Published |
| Single | GET /api/singleschedule/getall |
Power BI schedules | Published; GET-body filtering |
| Single | GET /api/singleschedule/getallpaginated |
Paginated schedules | Published; GET-body filtering |
| Single | GET /api/singleschedule/get/{id} |
Power BI schedule | Published |
| Single | GET /api/singleschedule/getpaginated/{id} |
Paginated schedule | Published |
| Single | POST /api/singleschedule/createforpowerbi |
Create Power BI schedule | Published |
| Single | POST /api/singleschedule/createpaginated |
Create paginated schedule | Published; full model validation required |
| Single | Bulk paginated creation route | Create multiple paginated schedules | Published link malformed; validate |
| Single | POST /api/singleschedule/updateforpowerbi |
Update Power BI schedule | Published |
| Single | POST /api/singleschedule/updateparameterspaginated |
Update paginated parameters | Support-evidenced; validate contract |
| Destination | POST /api/singleschedule/addemaildestination?clearExisting={bool} |
Add/replace email destination | Published; build-label behavior |
| Destination | POST /api/schedule/UpdateEmailDestination |
Update email destination | Published; introduced 20250924 |
| Destination | POST /api/schedule/DeleteEmailDestination?destinationId={id} |
Delete email destination | Published; introduced 20250924 |
| Package | GET /api/packageschedule/getall |
Packages | Published; GET-body filtering |
| Package | GET /api/packageschedule/get/{id} |
Package | Published |
| Package | POST /api/packageschedule/create |
Create package | Published |
| Package | DELETE /api/packageschedule/delete/{id} |
Delete package | Published |
Reference limitation: This catalog captures every operation established by the reviewed public reference plus the support-evidenced parameter update. It is not a substitute for endpoint-level request, response, authentication, permission and build validation.
Documentation standard: Record the PBRS build used for verification, test in a non-production environment, redact credentials and customer data, and confirm the saved PBRS state after every write.