POST api/Document/ConvertToPDF

Converts selected documents to PDFs

Request Information

URI Parameters

None.

Body Parameters

WorkPoint365.WebAPI.Model.Document+DocumentToPDFConversionParameter

Name	Description	Type	Additional information
Items		Collection of Object	None.
TargetBusinessModule		globally unique identifier	Required
TargetBusinessModuleEntity		integer	Required
TargetList		string	Required
TargetFolder		string	None.
OutputExistsBehaviour	The override behaviour	WorkPoint365.WebAPI.Model.Document+OutputExistsBehaviour	Required
PdfFormat	The PDF conversion format. If not specified the default PDF format will be used	WorkPoint365.WebAPI.Model.Document+ValidPdfFormat	Required
UseStepInputValues	Option to select if the process should use the values from the step input when creating the items	boolean	None.
SourceItemFieldsToCopyToPdfItem	Option to Add Index	Collection of string	None.
CombineFiles	Option to select if the converted PDFs should be Concactated	boolean	None.
FieldValues	Collection of the field values for the converted file(s)	Dictionary of string [key] and Object [value]	None.
AddPageNumbers	Option to Add page numbers	boolean	None.
AddIndex	Option to Add Index	boolean	None.
AddSourceInformation	Option to Add Source Information	boolean	None.
DocumentVersion	Option for which Version to use	WorkPoint365.WebAPI.Model.Document+DocumentToPDFConversionParameter+Version	None.
Async	Option for selecting Asyncron mode	boolean	None.
CallbackUrl	Option for Callback Url	string	None.
CallbackHeaders	Option for Callback Headers	Dictionary of string [key] and string [value]	None.

Request Formats

application/json, text/json

Sample:

{
  "Items": null,
  "TargetBusinessModule": "67621c1a-e1fc-43cf-92de-7e29e63189b1",
  "TargetBusinessModuleEntity": 2,
  "TargetList": "sample string 3",
  "TargetFolder": "sample string 4",
  "OutputExistsBehaviour": 10,
  "PdfFormat": 8,
  "UseStepInputValues": true,
  "SourceItemFieldsToCopyToPdfItem": [
    "sample string 1",
    "sample string 2"
  ],
  "CombineFiles": true,
  "FieldValues": {
    "sample string 1": {},
    "sample string 3": {}
  },
  "AddPageNumbers": true,
  "AddIndex": true,
  "AddSourceInformation": true,
  "DocumentVersion": "LatestVersion",
  "Async": true,
  "CallbackUrl": "sample string 11",
  "CallbackHeaders": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  }
}

application/xml, text/xml

Sample:

<Document.DocumentToPDFConversionParameter xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WorkPoint365.WebAPI.Model">
  <AddIndex>true</AddIndex>
  <AddPageNumbers>true</AddPageNumbers>
  <AddSourceInformation>true</AddSourceInformation>
  <Async>true</Async>
  <CallbackHeaders xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value>sample string 2</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 3</d2p1:Key>
      <d2p1:Value>sample string 4</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </CallbackHeaders>
  <CallbackUrl>sample string 11</CallbackUrl>
  <CombineFiles>true</CombineFiles>
  <DocumentVersion>LatestVersion</DocumentVersion>
  <FieldValues xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringanyType>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value />
    </d2p1:KeyValueOfstringanyType>
    <d2p1:KeyValueOfstringanyType>
      <d2p1:Key>sample string 3</d2p1:Key>
      <d2p1:Value />
    </d2p1:KeyValueOfstringanyType>
  </FieldValues>
  <Items xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
  <OutputExistsBehaviour>Cancel</OutputExistsBehaviour>
  <PdfFormat>PDF_v_1_3</PdfFormat>
  <SourceItemFieldsToCopyToPdfItem xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </SourceItemFieldsToCopyToPdfItem>
  <TargetBusinessModule>67621c1a-e1fc-43cf-92de-7e29e63189b1</TargetBusinessModule>
  <TargetBusinessModuleEntity>2</TargetBusinessModuleEntity>
  <TargetFolder>sample string 4</TargetFolder>
  <TargetList>sample string 3</TargetList>
  <UseStepInputValues>true</UseStepInputValues>
</Document.DocumentToPDFConversionParameter>

Response Information

Resource Description

System.Web.Http.IHttpActionResult

None.

Response Formats

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

Sample:

Sample not available.