Overview‎ > ‎Creating proofs‎ > ‎

createWorkflowTemplateProof()

Creates a proof using a workflow template. 

Note: In order for this method to work you MUST upload the file using a provided SessionID see the upload page. Additionally you must ensure your template has been validated without any errors.

Since version: 14.7

Unlimited only



Request parameters


* denotes a required field


Parameter

Example

SessionID*

The session Id obtained from doLogin()

String

7viklshodc6cnsh4s5vu75mqk0

OwnerID*

Result code

Int

0 - current user 

ownerOID - see getOwners()

Hash*

File identifier

String

ffc50a5fdd43ff.046772a6b09987aa1

Name*

Proof name

String

 

SourceName*

Source file name. We allow you to provide a web URL as the source name in order to generate a web captured proof. In addition to this you can supply a set of space character delimited web source names that will automatically be combined into a single proof with multiple pages

String

Proofhq-api.pdf

OR

http://www.myurl1.com http://www.mmyurl2.com

WorkflowTemplateID*

Template identifier

Int

 346

Subject

File subject

String

Custom subject

Message

Message to reviewers. We accept the following formatting tags within the message: 

<a>        href

<i>         italic

<span>   group inline-elements

<div>      defines a division or a section

<p>        paragraph

<font>    specifying a font

 <u>       underline

<br>       new line

String

Email body text inserted here

WorkspaceId

Workspace identifier

Int

245 - see getWorkspaces()

EnableSubscriptions

Allows people who are not participants to subscribe themselves to the proof. See help for more information. Default taken from the user's personal settings -> proofing defaults

Boolean

true

false

EnableSubscriptionsValidation

People subscribing can only access the proof using their personal URL sent in the email. See help for more information.

Boolean

true

false

DefaultEmailNotifications

Email notification settings for reviewers. It will not override a user's personal setting or the proof-level setting set by a reviewer. See help for more information.

1: All new comments and replies

2: Replies to my comments

3: Daily summary

4: Hourly summary

5: Decisions only

9: Disabled

String

4

DefaultRole

If EnableSubscriptionsValidationis turned on, there is a further setting that you can use, which sets the Role for subscribers. See help for more information.

1: Read only

3: Reviewer

4: Approver

5: Reviewer and approver

6: Author

7: Moderator

String

5

AuthorizedOnly

This is the same as the Login Required function on the new proof page.


If used, then EnableSubscriptionsmust be set to false.


See help for more information. Default taken from the user's personal settings -> proofing defaults

Boolean

true

false

EnableAutoLock

Locks the proof when all required decisions are made. See help for more information. Default taken from the user's personal settings -> proofing defaults

Boolean

true

false

EnableDownload

Enables download of the source file. Default taken from the user's personal settings -> proofing defaults

Boolean

true

false

EnableTeamURL

Hides or shows the team URL. Default taken from the user's personal settings -> proofing defaults

Boolean

true

false

EnableEmbedPlayer

Shows or hides the embed viewer URL.

Boolean

true

false  (default)

ShowDashboardLink

Shows / hides the navigation link to the dashboard in the proof page.

Boolean

true

false  (default)

ShowWorkspaceLink

Shows / hides the navigation link to the workspace in the proof page.

Boolean

true

false (default)

ShowDetailsPageLink

Shows / hides the navigation link to the proof details in the proof page.

Boolean

true

false (default)

ShowVersionsLink

Shows / hides the navigation link to the versions window will be displayed in the proof page.

Boolean

true

false (default)

ShowHelpLink

Shows / hides the help link in the proof page.

Boolean

true

false (default)

ShowHelpQuickStartLink

Shows / hides the Getting started link in the proof page.

Boolean

true

false (default)

ShowHelpUserGuideLink

Shows / hides the Knowledgebase link in the proof page.

Boolean

true

false (default)

ShowHelpWelcomeScreenLink

Displays or not Getting started popup

Boolean

true

false (default)

ShowHelpForumLink

Shows / hides the forum link.

Boolean

true

false (default)

ShowHelpBlogLink

Show / hides the blog link.

Boolean

true

false (default)

CustomLinkUrl

Allows you to specify a custom URL.

String

http://www.proofhq.com/

CustomLinkLabel

The label for the CustomLinkUrl

String

ProofHQ Home

SuppressNewProofNotification

Determine if a new proof notification email will be sent to the recipient

Boolean

true

false (default)

SWF

When creating a SWF proof, you can specify if this is an application or animation type.See our help for more information.

String

application or animation

ShowDashboardFunctions

Shows / hides the navigation link to the dashboard in the proof page.

Boolean

true

false (default)

ShowCloseIcon

Setting this to false will hide the close icon within the proof viewer

Boolean

true (default)

false

ShowPublishToTheWeb

Setting this to false will hide the publish to web option within the proof viewer

Boolean

true (default)

false

ShowPrintComments

Setting this to false will hide the print comments option within the proof viewer

Boolean

true (default)

false

ShowEmailAlertSettings

Setting this to false will hide the email alert settings within the proof viewer

Boolean

true (default)

false

CombinedProof

Determines if a single combined proof will be created from all the sources

Boolean

true

false (default)

EnableElectronicSignatures

Setting this to true will enable electronic signatures on this proof. If electronic signatures have been enabled on the account then this parameter will be ignored

Boolean

true

false (default)

DisableSubscriptionEmail

Determines if the subscription email should be send or not

Boolean

true

false (default)

 DisablePDFSummary  Determines if the PDF print summary should be available on the print summary page  boolean  true
 false (default)
 14.17
 DisableExcelSummary  Determines if the Excel print summary should be available on the print summary page  boolean  true
 false (default)
 14.17


Response parameters

SOAPWorkflowProofObjectArrayarray of SOAPWorkflowProofOject

Comments