Converting a Word Document into a given output format (Deprecated)
This API converts an agreement Word document into a specific output format using the parameters, such as agreementId and docFormat. This API is deprecated.
API |
Signature |
---|---|
convertAgreementWordDoc |
|
Request Parameters |
|||
---|---|---|---|
Name |
Type |
Description |
Required? |
agreementId |
|
The id of the agreement providing the content for the document. |
Yes |
docId |
|
The id of the agreement document to convert in a different output format. |
Yes |
docFileName |
|
The file name for the Word document. |
Yes |
docFormat |
|
Indicates whether the document will be:
|
Yes |
pLevel |
|
The protection level to apply to the document. Valid values are:
|
Yes |
addWatermark |
|
Indicates whether a draft watermark should be added to the output document. |
Yes |
removeWatermark |
|
Indicates whether a draft watermark on the source word document should be removed from the resulting document. |
Yes |
agreementNbr |
|
The agreement number of the document, upserted in the header. |
Yes |
dateFormat |
|
The date format for the footer of the document. |
Yes |
sessionId |
|
The Salesforce session id. |
Yes |
serverUrl |
|
The Salesforce server URL. |
Yes |
Response Parameter |
||
---|---|---|
Name |
Type |
Description |
result |
|
The id of the converted document. |
Code Sample