Execute one section (or blocks of one section) of a visible published report.
using System.Net.Http.Headers;var client = new HttpClient();var request = new HttpRequestMessage{ Method = HttpMethod.Post, RequestUri = new Uri("https://example.com/api/workspace/reporting/reports/example/execute"), Headers = { { "Authorization", "Bearer <token>" }, }, Content = new StringContent("{ \"SectionId\": \"example\", \"Filters\": { \"additionalProperty\": \"example\" }, \"Blocks\": [ { \"SectionId\": \"example\", \"BlockId\": \"example\", \"Page\": { \"PageNumber\": 1, \"PageSize\": 1 }, \"Sort\": { \"FieldKey\": \"example\", \"Direction\": 1 } } ] }") { Headers = { ContentType = new MediaTypeHeaderValue("application/json") } }};using (var response = await client.SendAsync(request)){ response.EnsureSuccessStatusCode(); var body = await response.Content.ReadAsStringAsync(); Console.WriteLine(body);}const url = 'https://example.com/api/workspace/reporting/reports/example/execute';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"SectionId":"example","Filters":{"additionalProperty":"example"},"Blocks":[{"SectionId":"example","BlockId":"example","Page":{"PageNumber":1,"PageSize":1},"Sort":{"FieldKey":"example","Direction":1}}]}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://example.com/api/workspace/reporting/reports/example/execute \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "SectionId": "example", "Filters": { "additionalProperty": "example" }, "Blocks": [ { "SectionId": "example", "BlockId": "example", "Page": { "PageNumber": 1, "PageSize": 1 }, "Sort": { "FieldKey": "example", "Direction": 1 } } ] }'Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Query Parameters
Section titled “Query Parameters”Optional access token for clients that cannot set Authorization headers. Prefer Authorization: Bearer <token> when possible.
Request Body
Section titled “Request Body”Runtime report execution request for one section.
object
Required section to execute, as stored in the published document (a section saved without an id is section-{n}); viewers see one section at a time. A missing or unknown section returns reporting.report.sections.notFound.
Values of the section’s filters keyed by filter key.
object
Optional block requests inside the section. When omitted, all section blocks execute.
Runtime execution request for one report block.
object
Section id from the published report document; it must equal the request’s SectionId.
Block id from the published report section.
Represents a paging request for table and list DataSource outputs.
object
Represents a sort request for table and list DataSource outputs.
object
Defines sort direction for table and list DataSource requests.
Runtime report execution request for one section.
object
Required section to execute, as stored in the published document (a section saved without an id is section-{n}); viewers see one section at a time. A missing or unknown section returns reporting.report.sections.notFound.
Values of the section’s filters keyed by filter key.
object
Optional block requests inside the section. When omitted, all section blocks execute.
Runtime execution request for one report block.
object
Section id from the published report document; it must equal the request’s SectionId.
Block id from the published report section.
Represents a paging request for table and list DataSource outputs.
object
Represents a sort request for table and list DataSource outputs.
object
Defines sort direction for table and list DataSource requests.
Runtime report execution request for one section.
object
Required section to execute, as stored in the published document (a section saved without an id is section-{n}); viewers see one section at a time. A missing or unknown section returns reporting.report.sections.notFound.
Values of the section’s filters keyed by filter key.
object
Optional block requests inside the section. When omitted, all section blocks execute.
Runtime execution request for one report block.
object
Section id from the published report document; it must equal the request’s SectionId.
Block id from the published report section.
Represents a paging request for table and list DataSource outputs.
object
Represents a sort request for table and list DataSource outputs.
object
Defines sort direction for table and list DataSource requests.
Responses
Section titled “Responses”OK
object
Runtime report batch execution result.
object
Report definition id.
Report key.
Published version number executed.
Per-block execution results.
Runtime execution result for one report block.
object
Section id from the published report document.
Block id from the published report section.
Whether block execution succeeded.
Successful data-source execution result plus source metadata.
object
Catalog item identifier.
Stable data-source identifier.
Data-source key.
Descriptor fingerprint used for this execution.
Represents the result of a DataSource execution.
object
Defines the shape returned by a DataSource execution.
Represents paging metadata returned by a table or list DataSource.
object
Represents a warning emitted by DataSource execution.
object
Represents a typed link emitted by DataSource execution.
object
Defines link target families that can be emitted by DataSources.
object
object
Controlled block execution errors.
object
object
Controlled block execution warnings.
object
object
Output fields of the executed source (names, value types, units) for column titles and workspace-formatted values. Null for a failed execution, and also for a successful one whose source changed its schema or disappeared meanwhile.
Describes a field in a DataSource output payload.
object
Defines a logical field value type in a DataSource output schema.
Represents display text with an invariant default value and optional locale-specific translations.
object
The invariant default text.
Optional locale-specific translations keyed by locale code.
object
Fields whose rows open a record and the record kind, such as a Task; null whenever Fields is null.
Describes a drilldown/link target that can be produced by a DataSource.
object
Defines link target families that can be emitted by DataSources.
object
object
object
object
Example
{ "Data": { "Blocks": [ { "Execution": { "Result": { "Shape": 1, "Links": [ { "TargetKind": 1 } ] } }, "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ], "Fields": [ { "ValueType": 1 } ], "Drilldowns": [ { "TargetKind": 1 } ] } ] }, "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}Bad Request
object
Runtime report batch execution result.
object
Report definition id.
Report key.
Published version number executed.
Per-block execution results.
Runtime execution result for one report block.
object
Section id from the published report document.
Block id from the published report section.
Whether block execution succeeded.
Successful data-source execution result plus source metadata.
object
Catalog item identifier.
Stable data-source identifier.
Data-source key.
Descriptor fingerprint used for this execution.
Represents the result of a DataSource execution.
object
Defines the shape returned by a DataSource execution.
Represents paging metadata returned by a table or list DataSource.
object
Represents a warning emitted by DataSource execution.
object
Represents a typed link emitted by DataSource execution.
object
Defines link target families that can be emitted by DataSources.
object
object
Controlled block execution errors.
object
object
Controlled block execution warnings.
object
object
Output fields of the executed source (names, value types, units) for column titles and workspace-formatted values. Null for a failed execution, and also for a successful one whose source changed its schema or disappeared meanwhile.
Describes a field in a DataSource output payload.
object
Defines a logical field value type in a DataSource output schema.
Represents display text with an invariant default value and optional locale-specific translations.
object
The invariant default text.
Optional locale-specific translations keyed by locale code.
object
Fields whose rows open a record and the record kind, such as a Task; null whenever Fields is null.
Describes a drilldown/link target that can be produced by a DataSource.
object
Defines link target families that can be emitted by DataSources.
object
object
object
object
Example
{ "Data": { "Blocks": [ { "Execution": { "Result": { "Shape": 1, "Links": [ { "TargetKind": 1 } ] } }, "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ], "Fields": [ { "ValueType": 1 } ], "Drilldowns": [ { "TargetKind": 1 } ] } ] }, "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}Forbidden
object
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}Not Found
object
Runtime report batch execution result.
object
Report definition id.
Report key.
Published version number executed.
Per-block execution results.
Runtime execution result for one report block.
object
Section id from the published report document.
Block id from the published report section.
Whether block execution succeeded.
Successful data-source execution result plus source metadata.
object
Catalog item identifier.
Stable data-source identifier.
Data-source key.
Descriptor fingerprint used for this execution.
Represents the result of a DataSource execution.
object
Defines the shape returned by a DataSource execution.
Represents paging metadata returned by a table or list DataSource.
object
Represents a warning emitted by DataSource execution.
object
Represents a typed link emitted by DataSource execution.
object
Defines link target families that can be emitted by DataSources.
object
object
Controlled block execution errors.
object
object
Controlled block execution warnings.
object
object
Output fields of the executed source (names, value types, units) for column titles and workspace-formatted values. Null for a failed execution, and also for a successful one whose source changed its schema or disappeared meanwhile.
Describes a field in a DataSource output payload.
object
Defines a logical field value type in a DataSource output schema.
Represents display text with an invariant default value and optional locale-specific translations.
object
The invariant default text.
Optional locale-specific translations keyed by locale code.
object
Fields whose rows open a record and the record kind, such as a Task; null whenever Fields is null.
Describes a drilldown/link target that can be produced by a DataSource.
object
Defines link target families that can be emitted by DataSources.
object
object
object
object
Example
{ "Data": { "Blocks": [ { "Execution": { "Result": { "Shape": 1, "Links": [ { "TargetKind": 1 } ] } }, "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ], "Fields": [ { "ValueType": 1 } ], "Drilldowns": [ { "TargetKind": 1 } ] } ] }, "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}