Documentation
    {{docApp.userSession.userId}}
    {{docApp.userSession.userName}}
    {{docApp.userSession.email}}
    Issuer : {{docApp.userSession.issuerInstance}}
    Expires : {{new Date(docApp.userSession.validUntil).toLocaleDateString()}}

{{docApp.title}}

{{docApp.description}}

How can we help?

{{docApp.searchError}}
{{product.name}}

Searching in {{docApp.searchFilterBySpecificBookTitle}}

{{docApp.searchResultFilteredItems.length}} results for: {{docApp.currentResultsSearchText}} in {{docApp.searchFilterBySpecificBookTitle}}
Search results have been limited. There are a total of {{docApp.searchResponse.totalResultsAvailable}} matches.

You have an odd number of " characters in your search terms - each one needs closing with a matching " character!

{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

{{group.title || group.id}}

{{group.description}}

  1. {{book.title}}

{{group.title}}

{{book.title}}
More...

/ reporting / reportRun

  • Article
  • 1 minutes to read

Description

Initiate a report run

API Details

  • Status:
  • The required privilege level to invoke this method is user
  • The supported database role for this method is none
  • Transactional database functions are used during this method when supported by the target database.
System Rights Database Rights Mail Rights Calendar Rights
sys.f.manageReports
 --- --- ---

Request Parameters

The reportRun method takes the following input parameters.

Note

When sending a JSON request payload to the API, the order of parameters is not significant. However, for XML request payloads, parameters must be provided in the exact order specified in this documentation to comply with input validation requirements.

Name Type Attributes Description
reportId xs:unsignedInt Required The identifier of the report you want to run
outputFormat printOrientationType Optional
Default=portrait		 DEPRECATED: INSTEAD USE reporting::reportUpdate to set any output format presentation options The output orientation of the report.
runtimeParameter reportRuntimeParametersType Optional Runtime parameter(s) needed by the report to run
comment xs:string Optional Add a comment to help identify this report run/its purpose
publish xs:boolean Optional
Default=false		 If the report should be published using its saved publishing options

Response Parameters

Name Type Attributes Description
runId xs:integer Required The identifier of the report run
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document