POST api/BusinessModules/{businessModuleId}/Entity/{entityId}/ConcatenateFiles

Concatenate multiple files and save as PDF

Request Information

URI Parameters

Name	Description	Type	Additional information
businessModuleId		globally unique identifier	Required
entityId		string	Required

Body Parameters

WorkPoint365.WebAPI.Model.ConcateOperationPdf

Name	Type	Additional information
Items	Collection of Object	None.
PdfFormat	WorkPoint365.WebAPI.Model.Document+PdfFormat	None.
IncludePageNumbers	boolean	None.
IncludeSourceInformation	boolean	None.
IncludeTableOfContents	boolean	None.
UseLatestMinorVersion	boolean	None.
OverwriteExistingFiles	boolean	None.
SourceFolderPath	string	None.
SourceListRelativWebPath	string	Required
TargetBusinessModuleId	globally unique identifier	Required
TargetBusinessModuleItemId	integer	Required
TargetFolderPath	string	None.
TargetListRelativWebPath	string	Required
OutputFileName	string	Required

Request Formats

application/json, text/json

Sample:

{
  "Items": null,
  "PdfFormat": 0,
  "IncludePageNumbers": true,
  "IncludeSourceInformation": true,
  "IncludeTableOfContents": true,
  "UseLatestMinorVersion": true,
  "OverwriteExistingFiles": true,
  "SourceFolderPath": "sample string 6",
  "SourceListRelativWebPath": "sample string 7",
  "TargetBusinessModuleId": "9ad8ab85-a8e5-41ec-b0be-d81917594ad2",
  "TargetBusinessModuleItemId": 9,
  "TargetFolderPath": "sample string 10",
  "TargetListRelativWebPath": "sample string 11",
  "OutputFileName": "sample string 12"
}

application/xml, text/xml

Sample:

<ConcateOperationPdf xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WorkPoint365.WebAPI.Model">
  <IncludePageNumbers>true</IncludePageNumbers>
  <IncludeSourceInformation>true</IncludeSourceInformation>
  <IncludeTableOfContents>true</IncludeTableOfContents>
  <Items xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
  <OutputFileName>sample string 12</OutputFileName>
  <OverwriteExistingFiles>true</OverwriteExistingFiles>
  <PdfFormat>PDF_A_1A</PdfFormat>
  <SourceFolderPath>sample string 6</SourceFolderPath>
  <SourceListRelativWebPath>sample string 7</SourceListRelativWebPath>
  <TargetBusinessModuleId>9ad8ab85-a8e5-41ec-b0be-d81917594ad2</TargetBusinessModuleId>
  <TargetBusinessModuleItemId>9</TargetBusinessModuleItemId>
  <TargetFolderPath>sample string 10</TargetFolderPath>
  <TargetListRelativWebPath>sample string 11</TargetListRelativWebPath>
  <UseLatestMinorVersion>true</UseLatestMinorVersion>
</ConcateOperationPdf>

Response Information

Resource Description

System.Web.Http.IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.