Start a Report
get
/api/report/Reports/executeStart
Starts a report.
Request
Query Parameters
-
BrokerComponentID(required): integer(int32)
The broker component that will carry out generation of the report.Example:
55
-
ReportIDList(required): string
The comma separated list of report IDs requested for forced execution.Example:
1000
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Root Schema : schema
Type:
Show Source
object
-
message: string
The response message in text.Example:
Report succeeded
-
success: boolean
Successful operationExample:
true
Default Response
Failed operation
Root Schema : schema
Type:
Show Source
object
-
errors: array
errors
The list of errors reported. Validation errors will be keyed by record field.
-
message: string
The response message.Example:
Exception thrown
-
success: boolean
Whether the operation was a success (true) or a failure (false).Example:
false
Nested Schema : errors
Type:
array
The list of errors reported. Validation errors will be keyed by record field.
Show Source
Nested Schema : items
Type:
object