POST api/merge

Merge request and returns File Content in Base64 string

Request Information

URI Parameters

None.

Body Parameters

merge request

SuiteBridge.Models.Merge.MergeRequest
NameDescriptionTypeAdditional information
Fields

list of fields mapping

Collection of SuiteBridge.Models.Merge.FieldMap

None.

Tables

list of tables mapping

Collection of SuiteBridge.Models.Merge.TableMap

None.

Document

document information

SuiteBridge.Models.Merge.Document

None.

Request Formats

application/json, text/json

Sample:
{
  "Fields": [
    {
      "Name": "sample string 1",
      "Value": "sample string 2"
    },
    {
      "Name": "sample string 1",
      "Value": "sample string 2"
    }
  ],
  "Tables": [
    {
      "Name": "sample string 1",
      "Rows": [
        {
          "Cells": [
            "sample string 1",
            "sample string 2"
          ]
        },
        {
          "Cells": [
            "sample string 1",
            "sample string 2"
          ]
        }
      ]
    },
    {
      "Name": "sample string 1",
      "Rows": [
        {
          "Cells": [
            "sample string 1",
            "sample string 2"
          ]
        },
        {
          "Cells": [
            "sample string 1",
            "sample string 2"
          ]
        }
      ]
    }
  ],
  "Document": {
    "Name": "sample string 1",
    "Content": "sample string 2"
  }
}

application/xml, text/xml

Sample:
<MergeRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Fields>
    <FieldMap>
      <Name>sample string 1</Name>
      <Value>sample string 2</Value>
    </FieldMap>
    <FieldMap>
      <Name>sample string 1</Name>
      <Value>sample string 2</Value>
    </FieldMap>
  </Fields>
  <Tables>
    <TableMap>
      <Name>sample string 1</Name>
      <Rows>
        <TableRowMap>
          <Cells>
            <string>sample string 1</string>
            <string>sample string 2</string>
          </Cells>
        </TableRowMap>
        <TableRowMap>
          <Cells>
            <string>sample string 1</string>
            <string>sample string 2</string>
          </Cells>
        </TableRowMap>
      </Rows>
    </TableMap>
    <TableMap>
      <Name>sample string 1</Name>
      <Rows>
        <TableRowMap>
          <Cells>
            <string>sample string 1</string>
            <string>sample string 2</string>
          </Cells>
        </TableRowMap>
        <TableRowMap>
          <Cells>
            <string>sample string 1</string>
            <string>sample string 2</string>
          </Cells>
        </TableRowMap>
      </Rows>
    </TableMap>
  </Tables>
  <Document>
    <Name>sample string 1</Name>
    <Content>sample string 2</Content>
  </Document>
</MergeRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

response with status 200 OK on successful merge

SuiteBridge.Models.Merge.MergeResponse
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:
<MergeResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Document>sample string 1</Document>
</MergeResponse>