POST v2/document

Post a template and datasources to start the generation of a document. The generation is async so this request returns immediately.

Request Information

URI Parameters

None.

Body Parameters

Deserialized request body.

Template

Name	Type	Additional information
LicenseFromHeader	string	None.
Guid	string	None.
Callback	string	None.
OutputFormat	string	None.
Data	Collection of byte	None.
ConnectionString	string	None.
EngineVersion	string	None.
Format	string	None.
Version	string	None.
Properties	Collection of Property	None.
Parameters	Collection of Parameter	None.
Datasources	Collection of Datasource	None.
Tag	string	None.
TrackImports	boolean	None.
Timeout	integer	None.
TrackErrors	integer	None.
MainPrinter	string	None.
FirstPagePrinter	string	None.
PrinterJobName	string	None.
PrintCopies	integer	None.
PrintDuplex	string	None.

Request Formats

application/json, text/json

Sample:

{
  "LicenseFromHeader": "sample string 1",
  "Guid": "sample string 2",
  "Callback": "sample string 3",
  "OutputFormat": "sample string 4",
  "Data": "QEA=",
  "ConnectionString": "sample string 5",
  "EngineVersion": "sample string 6",
  "Format": "sample string 7",
  "Version": "sample string 8",
  "Properties": [
    {
      "Name": "sample string 1",
      "Value": "sample string 2"
    },
    {
      "Name": "sample string 1",
      "Value": "sample string 2"
    }
  ],
  "Parameters": [
    {
      "Name": "sample string 1",
      "WrappedValue": {
        "ParamType": "sample string 1",
        "RawValue": "sample string 2"
      }
    },
    {
      "Name": "sample string 1",
      "WrappedValue": {
        "ParamType": "sample string 1",
        "RawValue": "sample string 2"
      }
    }
  ],
  "Datasources": [
    {
      "Name": "sample string 1",
      "Type": "sample string 2",
      "ClassName": "sample string 3",
      "ConnectionString": "sample string 4",
      "Data": "QEA=",
      "SchemaData": "QEA=",
      "SchemaConnectionString": "sample string 5",
      "Datasets": [
        {
          "Name": "sample string 1",
          "Query": "sample string 2"
        },
        {
          "Name": "sample string 1",
          "Query": "sample string 2"
        }
      ]
    },
    {
      "Name": "sample string 1",
      "Type": "sample string 2",
      "ClassName": "sample string 3",
      "ConnectionString": "sample string 4",
      "Data": "QEA=",
      "SchemaData": "QEA=",
      "SchemaConnectionString": "sample string 5",
      "Datasets": [
        {
          "Name": "sample string 1",
          "Query": "sample string 2"
        },
        {
          "Name": "sample string 1",
          "Query": "sample string 2"
        }
      ]
    }
  ],
  "Tag": "sample string 9",
  "TrackImports": true,
  "Timeout": 11,
  "TrackErrors": 0,
  "MainPrinter": "sample string 13",
  "FirstPagePrinter": "sample string 14",
  "PrinterJobName": "sample string 15",
  "PrintCopies": 16,
  "PrintDuplex": "sample string 17"
}

application/xml, text/xml

Sample:

<Template xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <LicenseFromHeader>sample string 1</LicenseFromHeader>
  <Guid>sample string 2</Guid>
  <Callback>sample string 3</Callback>
  <OutputFormat>sample string 4</OutputFormat>
  <Data>QEA=</Data>
  <ConnectionString>sample string 5</ConnectionString>
  <EngineVersion>sample string 6</EngineVersion>
  <Format>sample string 7</Format>
  <Version>sample string 8</Version>
  <Properties>
    <Property>
      <Name>sample string 1</Name>
      <Value>sample string 2</Value>
    </Property>
    <Property>
      <Name>sample string 1</Name>
      <Value>sample string 2</Value>
    </Property>
  </Properties>
  <Parameters>
    <Parameter>
      <Name>sample string 1</Name>
      <WrappedValue>
        <ParamType>sample string 1</ParamType>
        <RawValue>sample string 2</RawValue>
      </WrappedValue>
    </Parameter>
    <Parameter>
      <Name>sample string 1</Name>
      <WrappedValue>
        <ParamType>sample string 1</ParamType>
        <RawValue>sample string 2</RawValue>
      </WrappedValue>
    </Parameter>
  </Parameters>
  <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>
      <SchemaData>QEA=</SchemaData>
      <SchemaConnectionString>sample string 5</SchemaConnectionString>
      <Datasets>
        <DataSet>
          <Name>sample string 1</Name>
          <Query>sample string 2</Query>
        </DataSet>
        <DataSet>
          <Name>sample string 1</Name>
          <Query>sample string 2</Query>
        </DataSet>
      </Datasets>
    </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>
      <SchemaData>QEA=</SchemaData>
      <SchemaConnectionString>sample string 5</SchemaConnectionString>
      <Datasets>
        <DataSet>
          <Name>sample string 1</Name>
          <Query>sample string 2</Query>
        </DataSet>
        <DataSet>
          <Name>sample string 1</Name>
          <Query>sample string 2</Query>
        </DataSet>
      </Datasets>
    </Datasource>
  </Datasources>
  <Tag>sample string 9</Tag>
  <TrackImports>true</TrackImports>
  <Timeout>11</Timeout>
  <TrackErrors>0</TrackErrors>
  <MainPrinter>sample string 13</MainPrinter>
  <FirstPagePrinter>sample string 14</FirstPagePrinter>
  <PrinterJobName>sample string 15</PrinterJobName>
  <PrintCopies>16</PrintCopies>
  <PrintDuplex>sample string 17</PrintDuplex>
</Template>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HTTP status code. 202 with a GUID in the body. 500 if request's body is malformed.

IHttpActionResult

None.

Response Formats

application/json, text/json

Sample:

Sample not available.