POST api/reports/generate

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
ReportName	string	Required String length: inclusive between 0 and 100
CompanyName	string	Required String length: inclusive between 0 and 100
SessionId	string	Required String length: inclusive between 0 and 100
LoginId	string	Required String length: inclusive between 0 and 100
DatabaseServer	string	String length: inclusive between 0 and 50
DatabaseName	string	String length: inclusive between 0 and 50
UseIntegratedSecurity	boolean	None.
DatabaseUser	string	String length: inclusive between 0 and 50
DatabasePassword	string	String length: inclusive between 0 and 50
Parameters	Dictionary of string [key] and Object [value]	None.
SubReportParameters	Dictionary of string [key] and Dictionary of string [key] and Object [value] [value]	None.
RecordSelectionFormula	string	String length: inclusive between 0 and 1000
FormulaFields	Dictionary of string [key] and string [value]	None.
GroupFields	Dictionary of string [key] and string [value]	None.
ExportFormat	string	Matching regular expression pattern: PDF\|EXCEL\|WORD\|CSV
OutputFileName	string	String length: inclusive between 0 and 100

Request Formats

application/json, text/json

Sample:

{
  "ReportName": "sample string 1",
  "CompanyName": "sample string 2",
  "SessionId": "sample string 3",
  "LoginId": "sample string 4",
  "DatabaseServer": "sample string 5",
  "DatabaseName": "sample string 6",
  "UseIntegratedSecurity": true,
  "DatabaseUser": "sample string 8",
  "DatabasePassword": "sample string 9",
  "Parameters": {
    "sample string 1": {},
    "sample string 3": {}
  },
  "SubReportParameters": {
    "sample string 1": {
      "sample string 1": {},
      "sample string 3": {}
    },
    "sample string 2": {
      "sample string 1": {},
      "sample string 3": {}
    }
  },
  "RecordSelectionFormula": "sample string 10",
  "FormulaFields": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  },
  "GroupFields": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  },
  "ExportFormat": "sample string 11",
  "OutputFileName": "sample string 12"
}

application/xml, text/xml

Sample:

<ReportRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CrystalReportsAPI.Models">
  <CompanyName>sample string 2</CompanyName>
  <DatabaseName>sample string 6</DatabaseName>
  <DatabasePassword>sample string 9</DatabasePassword>
  <DatabaseServer>sample string 5</DatabaseServer>
  <DatabaseUser>sample string 8</DatabaseUser>
  <ExportFormat>sample string 11</ExportFormat>
  <FormulaFields xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value>sample string 2</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 3</d2p1:Key>
      <d2p1:Value>sample string 4</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </FormulaFields>
  <GroupFields xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value>sample string 2</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 3</d2p1:Key>
      <d2p1:Value>sample string 4</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </GroupFields>
  <LoginId>sample string 4</LoginId>
  <OutputFileName>sample string 12</OutputFileName>
  <Parameters xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringanyType>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value />
    </d2p1:KeyValueOfstringanyType>
    <d2p1:KeyValueOfstringanyType>
      <d2p1:Key>sample string 3</d2p1:Key>
      <d2p1:Value />
    </d2p1:KeyValueOfstringanyType>
  </Parameters>
  <RecordSelectionFormula>sample string 10</RecordSelectionFormula>
  <ReportName>sample string 1</ReportName>
  <SessionId>sample string 3</SessionId>
  <SubReportParameters xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringArrayOfKeyValueOfstringanyTypety7Ep6D1>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value>
        <d2p1:KeyValueOfstringanyType>
          <d2p1:Key>sample string 1</d2p1:Key>
          <d2p1:Value />
        </d2p1:KeyValueOfstringanyType>
        <d2p1:KeyValueOfstringanyType>
          <d2p1:Key>sample string 3</d2p1:Key>
          <d2p1:Value />
        </d2p1:KeyValueOfstringanyType>
      </d2p1:Value>
    </d2p1:KeyValueOfstringArrayOfKeyValueOfstringanyTypety7Ep6D1>
    <d2p1:KeyValueOfstringArrayOfKeyValueOfstringanyTypety7Ep6D1>
      <d2p1:Key>sample string 2</d2p1:Key>
      <d2p1:Value>
        <d2p1:KeyValueOfstringanyType>
          <d2p1:Key>sample string 1</d2p1:Key>
          <d2p1:Value />
        </d2p1:KeyValueOfstringanyType>
        <d2p1:KeyValueOfstringanyType>
          <d2p1:Key>sample string 3</d2p1:Key>
          <d2p1:Value />
        </d2p1:KeyValueOfstringanyType>
      </d2p1:Value>
    </d2p1:KeyValueOfstringArrayOfKeyValueOfstringanyTypety7Ep6D1>
  </SubReportParameters>
  <UseIntegratedSecurity>true</UseIntegratedSecurity>
</ReportRequest>

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 'ReportRequest'.

Response Information

Resource Description

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.