POST Service/v1/Export

Processes the request and returns an a file in the requested format. Only "SpreadSheet" and "SpreadSheetPDF" formats are supported in v1 requests.

Request Information

URI Parameters

None.

Body Parameters

The requested document specification

ExportRequestV1

Name	Description	Type	Additional information
Format	(Required) The requested document format of the exported data. Valid Values are "SpreadSheet" and "SpreadSheetPDF"	string	None.
Title	(Optional) The Title of the requested export document. Typically the Title is used as the default filename for the returned document.	string	None.
Author	(Optional) the name of the user requesting the export document	string	None.
Sections	(Required) The top level building block of the export document. For spreadsheets this translates into a worksheet on the workbook. If this is not present, the document will be empty.	Collection of ExportSection	None.

Request Formats

application/json, text/json

Sample:

{
  "Format": "sample string 1",
  "Title": "sample string 2",
  "Author": "sample string 3",
  "Sections": [
    {
      "Title": "sample string 1",
      "Cells": [
        {
          "Row": 1,
          "Column": 2,
          "Value": {},
          "Format": "sample string 4",
          "Alignment": {
            "Vertical": "sample string 1",
            "Horizontal": "sample string 2"
          }
        },
        {
          "Row": 1,
          "Column": 2,
          "Value": {},
          "Format": "sample string 4",
          "Alignment": {
            "Vertical": "sample string 1",
            "Horizontal": "sample string 2"
          }
        }
      ]
    },
    {
      "Title": "sample string 1",
      "Cells": [
        {
          "Row": 1,
          "Column": 2,
          "Value": {},
          "Format": "sample string 4",
          "Alignment": {
            "Vertical": "sample string 1",
            "Horizontal": "sample string 2"
          }
        },
        {
          "Row": 1,
          "Column": 2,
          "Value": {},
          "Format": "sample string 4",
          "Alignment": {
            "Vertical": "sample string 1",
            "Horizontal": "sample string 2"
          }
        }
      ]
    }
  ]
}

application/xml, text/xml

Sample:

<ExportRequestV1 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ExportToDocumentService.Models">
  <Author>sample string 3</Author>
  <Format>sample string 1</Format>
  <Sections xmlns:d2p1="http://schemas.datacontract.org/2004/07/ExportToDocumentService.Common.Models">
    <d2p1:ExportSection>
      <d2p1:Cells>
        <d2p1:ExportCell>
          <d2p1:Alignment xmlns:d6p1="http://schemas.datacontract.org/2004/07/ExportToDocumentService.Common.Models.Style">
            <d6p1:Horizontal>sample string 2</d6p1:Horizontal>
            <d6p1:Vertical>sample string 1</d6p1:Vertical>
          </d2p1:Alignment>
          <d2p1:Column>2</d2p1:Column>
          <d2p1:Format>sample string 4</d2p1:Format>
          <d2p1:Row>1</d2p1:Row>
          <d2p1:Value />
        </d2p1:ExportCell>
        <d2p1:ExportCell>
          <d2p1:Alignment xmlns:d6p1="http://schemas.datacontract.org/2004/07/ExportToDocumentService.Common.Models.Style">
            <d6p1:Horizontal>sample string 2</d6p1:Horizontal>
            <d6p1:Vertical>sample string 1</d6p1:Vertical>
          </d2p1:Alignment>
          <d2p1:Column>2</d2p1:Column>
          <d2p1:Format>sample string 4</d2p1:Format>
          <d2p1:Row>1</d2p1:Row>
          <d2p1:Value />
        </d2p1:ExportCell>
      </d2p1:Cells>
      <d2p1:Title>sample string 1</d2p1:Title>
    </d2p1:ExportSection>
    <d2p1:ExportSection>
      <d2p1:Cells>
        <d2p1:ExportCell>
          <d2p1:Alignment xmlns:d6p1="http://schemas.datacontract.org/2004/07/ExportToDocumentService.Common.Models.Style">
            <d6p1:Horizontal>sample string 2</d6p1:Horizontal>
            <d6p1:Vertical>sample string 1</d6p1:Vertical>
          </d2p1:Alignment>
          <d2p1:Column>2</d2p1:Column>
          <d2p1:Format>sample string 4</d2p1:Format>
          <d2p1:Row>1</d2p1:Row>
          <d2p1:Value />
        </d2p1:ExportCell>
        <d2p1:ExportCell>
          <d2p1:Alignment xmlns:d6p1="http://schemas.datacontract.org/2004/07/ExportToDocumentService.Common.Models.Style">
            <d6p1:Horizontal>sample string 2</d6p1:Horizontal>
            <d6p1:Vertical>sample string 1</d6p1:Vertical>
          </d2p1:Alignment>
          <d2p1:Column>2</d2p1:Column>
          <d2p1:Format>sample string 4</d2p1:Format>
          <d2p1:Row>1</d2p1:Row>
          <d2p1:Value />
        </d2p1:ExportCell>
      </d2p1:Cells>
      <d2p1:Title>sample string 1</d2p1:Title>
    </d2p1:ExportSection>
  </Sections>
  <Title>sample string 2</Title>
</ExportRequestV1>

application/x-www-form-urlencoded

Sample:

Sample not available.

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.