POST v1/reports

POST /v1/reports Post a template for the report generation.

Request Information

URI Parameters

None.

Body Parameters

Deserialized request body.

Template
NameDescriptionTypeAdditional information
Data

Base64 encoded template file.

Collection of byte

None.

Uri

string

None.

OutputFormat

Tells what format of the report to generate. The known formats are pdf Portable document format. docx Microsoft Word document. xlsx Microsoft Excel document. pptx Microsoft PowerPoint document. html HTML file. csv Coma delemeted format. rtf Rich-text format. prn Send the output directly to a printer. Make sure that the server, where the report is generating, has access to that printer. ps PostScript document The following image output formats can be specified. png jpg bmp gif svg eps

string

None.

Dpi

DPI for the bitmap images (BMP, GIF, JPG, PNG). 72 by default.

integer

None.

Async

boolean

None.

ApiKey

string

None.

EngineVersion

string

None.

Format

string

None.

Version

string

None.

Datasources

Collection of Datasource

None.

CopyMetadata

string

None.

Description

string

None.

Title

string

None.

Subject

string

None.

Keywords

string

None.

Locale

string

None.

Hyphenate

string

None.

TrackImports

boolean

None.

Timeout

integer

None.

RemoveUnusedFormats

boolean

None.

TrackErrors

Enable or disable the error handling and verify functionality. Available options are: 0 - error handling and verify is disabled. This is the default. 1 - enable error handling. 2 - enable verify. 3 - enable both error handling and verify. Any other value is ignored and disables the functionality.

integer

None.

MainPrinter

A name of the printer to send the output to. This is used as the main printer The server, where the report generation is run, must have an access to this printer.

string

None.

FirstPagePrinter

A name of the printer to use for the first page of the report. All subsequent pages will be sent to the main printer. The server, where the report generation is run, must have an access to this printer.

string

None.

PrinterJobName

A client defined name for the printing job.

string

None.

PrintCopies

The number of copies to print. Must be greater than 0. The default is 1.

integer

None.

PrintDuplex

Selects the printer duplex mode. Only if supported by the printer. Valid value are simplex One-sided printing. This is the default. horizontal Two-sided printing. Prints on both sides of the paper for portrait output. vertical Two-sided printing. Prints on both sides of the paper for landscape output.

string

None.

Request Formats

application/json, text/json

Sample:
{
  "Data": "QEA=",
  "Uri": "sample string 1",
  "OutputFormat": "sample string 2",
  "Dpi": 3,
  "Async": true,
  "ApiKey": "sample string 5",
  "EngineVersion": "sample string 6",
  "Format": "sample string 7",
  "Version": "sample string 8",
  "Datasources": [
    {
      "Name": "sample string 1",
      "Type": "sample string 2",
      "ClassName": "sample string 3",
      "ConnectionString": "sample string 4",
      "Data": "QEA=",
      "Uri": "sample string 5",
      "SchemaData": "QEA=",
      "SchemaUri": "sample string 6",
      "SchemaConnectionString": "sample string 7",
      "Username": "sample string 8",
      "Password": "sample string 9",
      "Domain": "sample string 10",
      "ODataVersion": "sample string 11",
      "ODataProtocol": "sample string 12",
      "SalesforceToken": "sample string 13",
      "SalesforceAccessToken": "sample string 14",
      "SalesforceSoapEndpoint": "sample string 15",
      "Variables": [
        {
          "Name": "sample string 1",
          "Description": "sample string 2",
          "Value": "sample string 3",
          "Type": "sample string 4",
          "UdtGuid": "sample string 5",
          "Required": true,
          "AllowAll": true,
          "AllowList": true,
          "AllowFilter": true,
          "AllowSort": true,
          "AutoMetadata": "sample string 11",
          "DefaultValues": [
            {
              "Label": "sample string 1",
              "Name": "sample string 2",
              "Value": {},
              "ValueReference": "sample string 4"
            },
            {
              "Label": "sample string 1",
              "Name": "sample string 2",
              "Value": {},
              "ValueReference": "sample string 4"
            }
          ],
          "AllowedValues": [
            {
              "Label": "sample string 1",
              "Name": "sample string 2",
              "Value": {},
              "ValueReference": "sample string 4"
            },
            {
              "Label": "sample string 1",
              "Name": "sample string 2",
              "Value": {},
              "ValueReference": "sample string 4"
            }
          ],
          "Datasource": "sample string 12",
          "CalOffset": "sample string 13"
        },
        {
          "Name": "sample string 1",
          "Description": "sample string 2",
          "Value": "sample string 3",
          "Type": "sample string 4",
          "UdtGuid": "sample string 5",
          "Required": true,
          "AllowAll": true,
          "AllowList": true,
          "AllowFilter": true,
          "AllowSort": true,
          "AutoMetadata": "sample string 11",
          "DefaultValues": [
            {
              "Label": "sample string 1",
              "Name": "sample string 2",
              "Value": {},
              "ValueReference": "sample string 4"
            },
            {
              "Label": "sample string 1",
              "Name": "sample string 2",
              "Value": {},
              "ValueReference": "sample string 4"
            }
          ],
          "AllowedValues": [
            {
              "Label": "sample string 1",
              "Name": "sample string 2",
              "Value": {},
              "ValueReference": "sample string 4"
            },
            {
              "Label": "sample string 1",
              "Name": "sample string 2",
              "Value": {},
              "ValueReference": "sample string 4"
            }
          ],
          "Datasource": "sample string 12",
          "CalOffset": "sample string 13"
        }
      ]
    },
    {
      "Name": "sample string 1",
      "Type": "sample string 2",
      "ClassName": "sample string 3",
      "ConnectionString": "sample string 4",
      "Data": "QEA=",
      "Uri": "sample string 5",
      "SchemaData": "QEA=",
      "SchemaUri": "sample string 6",
      "SchemaConnectionString": "sample string 7",
      "Username": "sample string 8",
      "Password": "sample string 9",
      "Domain": "sample string 10",
      "ODataVersion": "sample string 11",
      "ODataProtocol": "sample string 12",
      "SalesforceToken": "sample string 13",
      "SalesforceAccessToken": "sample string 14",
      "SalesforceSoapEndpoint": "sample string 15",
      "Variables": [
        {
          "Name": "sample string 1",
          "Description": "sample string 2",
          "Value": "sample string 3",
          "Type": "sample string 4",
          "UdtGuid": "sample string 5",
          "Required": true,
          "AllowAll": true,
          "AllowList": true,
          "AllowFilter": true,
          "AllowSort": true,
          "AutoMetadata": "sample string 11",
          "DefaultValues": [
            {
              "Label": "sample string 1",
              "Name": "sample string 2",
              "Value": {},
              "ValueReference": "sample string 4"
            },
            {
              "Label": "sample string 1",
              "Name": "sample string 2",
              "Value": {},
              "ValueReference": "sample string 4"
            }
          ],
          "AllowedValues": [
            {
              "Label": "sample string 1",
              "Name": "sample string 2",
              "Value": {},
              "ValueReference": "sample string 4"
            },
            {
              "Label": "sample string 1",
              "Name": "sample string 2",
              "Value": {},
              "ValueReference": "sample string 4"
            }
          ],
          "Datasource": "sample string 12",
          "CalOffset": "sample string 13"
        },
        {
          "Name": "sample string 1",
          "Description": "sample string 2",
          "Value": "sample string 3",
          "Type": "sample string 4",
          "UdtGuid": "sample string 5",
          "Required": true,
          "AllowAll": true,
          "AllowList": true,
          "AllowFilter": true,
          "AllowSort": true,
          "AutoMetadata": "sample string 11",
          "DefaultValues": [
            {
              "Label": "sample string 1",
              "Name": "sample string 2",
              "Value": {},
              "ValueReference": "sample string 4"
            },
            {
              "Label": "sample string 1",
              "Name": "sample string 2",
              "Value": {},
              "ValueReference": "sample string 4"
            }
          ],
          "AllowedValues": [
            {
              "Label": "sample string 1",
              "Name": "sample string 2",
              "Value": {},
              "ValueReference": "sample string 4"
            },
            {
              "Label": "sample string 1",
              "Name": "sample string 2",
              "Value": {},
              "ValueReference": "sample string 4"
            }
          ],
          "Datasource": "sample string 12",
          "CalOffset": "sample string 13"
        }
      ]
    }
  ],
  "CopyMetadata": "sample string 9",
  "Description": "sample string 10",
  "Title": "sample string 11",
  "Subject": "sample string 12",
  "Keywords": "sample string 13",
  "Locale": "sample string 14",
  "Hyphenate": "sample string 15",
  "TrackImports": true,
  "Timeout": 17,
  "RemoveUnusedFormats": true,
  "TrackErrors": 0,
  "MainPrinter": "sample string 20",
  "FirstPagePrinter": "sample string 21",
  "PrinterJobName": "sample string 22",
  "PrintCopies": 23,
  "PrintDuplex": "sample string 24"
}

application/xml, text/xml

Sample:
<Template xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Data>QEA=</Data>
  <Uri>sample string 1</Uri>
  <OutputFormat>sample string 2</OutputFormat>
  <Dpi>3</Dpi>
  <Async>true</Async>
  <ApiKey>sample string 5</ApiKey>
  <EngineVersion>sample string 6</EngineVersion>
  <Format>sample string 7</Format>
  <Version>sample string 8</Version>
  <Datasources>
    <Datasource>
      <Name>sample string 1</Name>
      <Type>sample string 2</Type>
      <ClassName>sample string 3</ClassName>
      <ConnectionString>sample string 4</ConnectionString>
      <Data>QEA=</Data>
      <Uri>sample string 5</Uri>
      <SchemaData>QEA=</SchemaData>
      <SchemaUri>sample string 6</SchemaUri>
      <SchemaConnectionString>sample string 7</SchemaConnectionString>
      <Username>sample string 8</Username>
      <Password>sample string 9</Password>
      <Domain>sample string 10</Domain>
      <ODataVersion>sample string 11</ODataVersion>
      <ODataProtocol>sample string 12</ODataProtocol>
      <SalesforceToken>sample string 13</SalesforceToken>
      <SalesforceAccessToken>sample string 14</SalesforceAccessToken>
      <SalesforceSoapEndpoint>sample string 15</SalesforceSoapEndpoint>
      <Variables>
        <Variable>
          <Name>sample string 1</Name>
          <Description>sample string 2</Description>
          <Value>sample string 3</Value>
          <Type>sample string 4</Type>
          <UdtGuid>sample string 5</UdtGuid>
          <Required>true</Required>
          <AllowAll>true</AllowAll>
          <AllowList>true</AllowList>
          <AllowFilter>true</AllowFilter>
          <AllowSort>true</AllowSort>
          <AutoMetadata>sample string 11</AutoMetadata>
          <DefaultValues>
            <VariableValue>
              <Label>sample string 1</Label>
              <Name>sample string 2</Name>
              <Value />
              <ValueReference>sample string 4</ValueReference>
            </VariableValue>
            <VariableValue>
              <Label>sample string 1</Label>
              <Name>sample string 2</Name>
              <Value />
              <ValueReference>sample string 4</ValueReference>
            </VariableValue>
          </DefaultValues>
          <AllowedValues>
            <VariableValue>
              <Label>sample string 1</Label>
              <Name>sample string 2</Name>
              <Value />
              <ValueReference>sample string 4</ValueReference>
            </VariableValue>
            <VariableValue>
              <Label>sample string 1</Label>
              <Name>sample string 2</Name>
              <Value />
              <ValueReference>sample string 4</ValueReference>
            </VariableValue>
          </AllowedValues>
          <Datasource>sample string 12</Datasource>
          <CalOffset>sample string 13</CalOffset>
        </Variable>
        <Variable>
          <Name>sample string 1</Name>
          <Description>sample string 2</Description>
          <Value>sample string 3</Value>
          <Type>sample string 4</Type>
          <UdtGuid>sample string 5</UdtGuid>
          <Required>true</Required>
          <AllowAll>true</AllowAll>
          <AllowList>true</AllowList>
          <AllowFilter>true</AllowFilter>
          <AllowSort>true</AllowSort>
          <AutoMetadata>sample string 11</AutoMetadata>
          <DefaultValues>
            <VariableValue>
              <Label>sample string 1</Label>
              <Name>sample string 2</Name>
              <Value />
              <ValueReference>sample string 4</ValueReference>
            </VariableValue>
            <VariableValue>
              <Label>sample string 1</Label>
              <Name>sample string 2</Name>
              <Value />
              <ValueReference>sample string 4</ValueReference>
            </VariableValue>
          </DefaultValues>
          <AllowedValues>
            <VariableValue>
              <Label>sample string 1</Label>
              <Name>sample string 2</Name>
              <Value />
              <ValueReference>sample string 4</ValueReference>
            </VariableValue>
            <VariableValue>
              <Label>sample string 1</Label>
              <Name>sample string 2</Name>
              <Value />
              <ValueReference>sample string 4</ValueReference>
            </VariableValue>
          </AllowedValues>
          <Datasource>sample string 12</Datasource>
          <CalOffset>sample string 13</CalOffset>
        </Variable>
      </Variables>
    </Datasource>
    <Datasource>
      <Name>sample string 1</Name>
      <Type>sample string 2</Type>
      <ClassName>sample string 3</ClassName>
      <ConnectionString>sample string 4</ConnectionString>
      <Data>QEA=</Data>
      <Uri>sample string 5</Uri>
      <SchemaData>QEA=</SchemaData>
      <SchemaUri>sample string 6</SchemaUri>
      <SchemaConnectionString>sample string 7</SchemaConnectionString>
      <Username>sample string 8</Username>
      <Password>sample string 9</Password>
      <Domain>sample string 10</Domain>
      <ODataVersion>sample string 11</ODataVersion>
      <ODataProtocol>sample string 12</ODataProtocol>
      <SalesforceToken>sample string 13</SalesforceToken>
      <SalesforceAccessToken>sample string 14</SalesforceAccessToken>
      <SalesforceSoapEndpoint>sample string 15</SalesforceSoapEndpoint>
      <Variables>
        <Variable>
          <Name>sample string 1</Name>
          <Description>sample string 2</Description>
          <Value>sample string 3</Value>
          <Type>sample string 4</Type>
          <UdtGuid>sample string 5</UdtGuid>
          <Required>true</Required>
          <AllowAll>true</AllowAll>
          <AllowList>true</AllowList>
          <AllowFilter>true</AllowFilter>
          <AllowSort>true</AllowSort>
          <AutoMetadata>sample string 11</AutoMetadata>
          <DefaultValues>
            <VariableValue>
              <Label>sample string 1</Label>
              <Name>sample string 2</Name>
              <Value />
              <ValueReference>sample string 4</ValueReference>
            </VariableValue>
            <VariableValue>
              <Label>sample string 1</Label>
              <Name>sample string 2</Name>
              <Value />
              <ValueReference>sample string 4</ValueReference>
            </VariableValue>
          </DefaultValues>
          <AllowedValues>
            <VariableValue>
              <Label>sample string 1</Label>
              <Name>sample string 2</Name>
              <Value />
              <ValueReference>sample string 4</ValueReference>
            </VariableValue>
            <VariableValue>
              <Label>sample string 1</Label>
              <Name>sample string 2</Name>
              <Value />
              <ValueReference>sample string 4</ValueReference>
            </VariableValue>
          </AllowedValues>
          <Datasource>sample string 12</Datasource>
          <CalOffset>sample string 13</CalOffset>
        </Variable>
        <Variable>
          <Name>sample string 1</Name>
          <Description>sample string 2</Description>
          <Value>sample string 3</Value>
          <Type>sample string 4</Type>
          <UdtGuid>sample string 5</UdtGuid>
          <Required>true</Required>
          <AllowAll>true</AllowAll>
          <AllowList>true</AllowList>
          <AllowFilter>true</AllowFilter>
          <AllowSort>true</AllowSort>
          <AutoMetadata>sample string 11</AutoMetadata>
          <DefaultValues>
            <VariableValue>
              <Label>sample string 1</Label>
              <Name>sample string 2</Name>
              <Value />
              <ValueReference>sample string 4</ValueReference>
            </VariableValue>
            <VariableValue>
              <Label>sample string 1</Label>
              <Name>sample string 2</Name>
              <Value />
              <ValueReference>sample string 4</ValueReference>
            </VariableValue>
          </DefaultValues>
          <AllowedValues>
            <VariableValue>
              <Label>sample string 1</Label>
              <Name>sample string 2</Name>
              <Value />
              <ValueReference>sample string 4</ValueReference>
            </VariableValue>
            <VariableValue>
              <Label>sample string 1</Label>
              <Name>sample string 2</Name>
              <Value />
              <ValueReference>sample string 4</ValueReference>
            </VariableValue>
          </AllowedValues>
          <Datasource>sample string 12</Datasource>
          <CalOffset>sample string 13</CalOffset>
        </Variable>
      </Variables>
    </Datasource>
  </Datasources>
  <CopyMetadata>sample string 9</CopyMetadata>
  <Description>sample string 10</Description>
  <Title>sample string 11</Title>
  <Subject>sample string 12</Subject>
  <Keywords>sample string 13</Keywords>
  <Locale>sample string 14</Locale>
  <Hyphenate>sample string 15</Hyphenate>
  <TrackImports>true</TrackImports>
  <Timeout>17</Timeout>
  <RemoveUnusedFormats>true</RemoveUnusedFormats>
  <TrackErrors>0</TrackErrors>
  <MainPrinter>sample string 20</MainPrinter>
  <FirstPagePrinter>sample string 21</FirstPagePrinter>
  <PrinterJobName>sample string 22</PrinterJobName>
  <PrintCopies>23</PrintCopies>
  <PrintDuplex>sample string 24</PrintDuplex>
</Template>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HTTP status code. 200 with generated report in the body if Async = false. 200 with a GUID in the body if Async = true. 400 if request's body is malformed. 500 if error occurred during the report generation. The body contains the error's description.

IHttpActionResult

None.

Response Formats

application/json, text/json

Sample:

Sample not available.