POST Report/{reportId}/Run?reportRunId={reportRunId}&startRowIndex={startRowIndex}&endRowIndexExclusive={endRowIndexExclusive}&culture={culture}&maximumExecutionTimeSeconds={maximumExecutionTimeSeconds}

Runs the report with the parameters given in the Body. If parameters are invalid this is returned in the ReportRunDetailsRestResult.Errors. The reportRunId is optional, but it is used for optimization. Calls to subsequent pages of the report should be done with the reportRunId.

Request Information

URI Parameters

Name	Description	Type	Additional information
reportId	The report to run	string	Required
reportRunId	The (optional) id of the reportResult. Used to identify an existing/cached reportResult	string	Required
startRowIndex	The first row index to get	integer	Required
endRowIndexExclusive	The first row index to NOT get (if null then get all rows)	integer	Required
culture	The culture to localize the report in	string	Required
maximumExecutionTimeSeconds	The maximum time it can take to execute the report	integer	Required

Body Parameters

The parameters with which to run the report

Dictionary of string [key] and Object [value]

Request Formats

application/json, text/json

Sample:

{
  "sample string 1": {},
  "sample string 3": {}
}

application/xml, text/xml

Sample:

<ArrayOfKeyValueOfstringanyType xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
  <KeyValueOfstringanyType>
    <Key>sample string 1</Key>
    <Value />
  </KeyValueOfstringanyType>
  <KeyValueOfstringanyType>
    <Key>sample string 3</Key>
    <Value />
  </KeyValueOfstringanyType>
</ArrayOfKeyValueOfstringanyType>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'Dictionary`2'.

Response Information

Resource Description

ReportRunDetailsRestResult

Name	Description	Type	Additional information
Errors		Collection of ValidationErrorRestResult	None.
Result	The actual result of running the report, please check if there were errors first	ReportRunRestResult	None.

Response Formats

application/json, text/json

Sample:

{
  "Errors": [
    {
      "Key": "sample string 1",
      "Message": "sample string 2"
    },
    {
      "Key": "sample string 1",
      "Message": "sample string 2"
    }
  ]
}

application/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'application/xml'. Exception message: Type 'Api360.Models.ReportRunRestResult' cannot be serialized. Consider marking it with the DataContractAttribute attribute, and marking all of its members you want serialized with the DataMemberAttribute attribute. If the type is a collection, consider marking it with the CollectionDataContractAttribute. See the Microsoft .NET Framework documentation for other supported types.

text/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'text/xml'. Exception message: Type 'Api360.Models.ReportRunRestResult' cannot be serialized. Consider marking it with the DataContractAttribute attribute, and marking all of its members you want serialized with the DataMemberAttribute attribute. If the type is a collection, consider marking it with the CollectionDataContractAttribute. See the Microsoft .NET Framework documentation for other supported types.