API Reference
  1. PBRS Public REST API
  2. Execution and import

Execute a schedule synchronously

post
{scheme}://{host}:{port}/api/Schedule/ExecuteSchedule

Execute the selected schedule and wait for the execution result. Check Result as well as the HTTP status; a successful HTTP response can carry Result=false.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Send application/json or application/x-www-form-urlencoded. Use JSON to represent nested objects, arrays and explicit null values.

string
enum
required

Execution type. report/single cover single and data-driven schedules; package covers packages and data-driven packages.

Allowed:
int32
required
string | null
string | null

Optional execution correlation value used by applicable execution paths. An omitted value is not an idempotency key or a duplicate-prevention guarantee.

string
Headers
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses

Updated 2 days ago

Did this page help you?
Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 2 days ago

Did this page help you?