POST api/excel

Excel Merge request and returns File Content in Base64 string

Request Information

URI Parameters

None.

Body Parameters

excel merge request

SuiteBridge.Models.Excel.ExcelMergeRequest
NameDescriptionTypeAdditional information
Document

document information

SuiteBridge.Models.Excel.ExcelDocument

None.

Request Formats

application/json, text/json

Sample:
{
  "Document": {
    "Name": "sample string 1",
    "Content": "sample string 2",
    "Sheets": [
      {
        "Name": "sample string 1",
        "Tables": [
          {
            "StartingCell": "sample string 1",
            "Rows": [
              {
                "Values": [
                  {},
                  {}
                ]
              },
              {
                "Values": [
                  {},
                  {}
                ]
              }
            ]
          },
          {
            "StartingCell": "sample string 1",
            "Rows": [
              {
                "Values": [
                  {},
                  {}
                ]
              },
              {
                "Values": [
                  {},
                  {}
                ]
              }
            ]
          }
        ],
        "Cells": [
          {
            "CellReference": "sample string 1",
            "CellValue": {}
          },
          {
            "CellReference": "sample string 1",
            "CellValue": {}
          }
        ]
      },
      {
        "Name": "sample string 1",
        "Tables": [
          {
            "StartingCell": "sample string 1",
            "Rows": [
              {
                "Values": [
                  {},
                  {}
                ]
              },
              {
                "Values": [
                  {},
                  {}
                ]
              }
            ]
          },
          {
            "StartingCell": "sample string 1",
            "Rows": [
              {
                "Values": [
                  {},
                  {}
                ]
              },
              {
                "Values": [
                  {},
                  {}
                ]
              }
            ]
          }
        ],
        "Cells": [
          {
            "CellReference": "sample string 1",
            "CellValue": {}
          },
          {
            "CellReference": "sample string 1",
            "CellValue": {}
          }
        ]
      }
    ]
  }
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

response with status 200 OK on successful merge

SuiteBridge.Models.Excel.ExcelMergeResponse
NameDescriptionTypeAdditional information
Document

Document contents in Base64 string

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Document": "sample string 1"
}

application/xml, text/xml

Sample:
<ExcelMergeResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Document>sample string 1</Document>
</ExcelMergeResponse>