This process works in the same way as createWorkflowProof() and takes an additional parent proof Id (ParentFileID). When calling the createWorkflowProof() method the system generates the first version of the proof. Subsequent versions are created using createProofVersion(). If this is the second version being created for a proof then the ParentFileID should equal the file_id obtained from createWorkflowProof(). Alternatively, the ParentFileID should equal the file_id from the last proof version obtained from createWorkflowProofVersion().
Note: in order to make all functionality (such as text selection) available when creating a file proof its important to provide the file name along with it's extension. The "SourceName" parameter is used to determine the extension and file type.Since version: 14.4
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Parameter |
Example |
API version |
|||
|
SessionID* |
The session Id obtained from doLogin() |
String |
7viklshodc6cnsh4s5vu75mqk0 |
|
|
|
ParentFileID* |
Parent proof identifier |
Int |
280755 |
|
|
|
OwnerID* |
Result code |
Int |
0 - current user ownerID - 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 |
|
|
|
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 |
|
|
|
Stages |
The object identifying the stages for this proof |
|
|||
|
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.
|
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 replies2: Replies to my comments3: Daily summary4: Hourly summary5: Decisions only9: Disabled |
String |
4 |
|
|
|
DefaultRole |
IfEnableSubscriptionsValidationis turned on, there is a further setting that you can use, which sets the Role for subscribers. Seehelpfor more information on this setting andherefor help on roles.1: Read only3: Reviewer4: Approver5: Reviewer and approver6: Author7: Moderator |
String |
5 |
|
|
|
AuthorizedOnly |
This is the same as the Login Required function on the new proof page.If used, thenEnableSubscriptionsmust be set tofalse.Seehelpfor more information. |
Boolean |
true false |
|
|
|
EnableAutoLock |
Locks the proof when all required decisions are made. See help for more information. |
Boolean |
true false |
|
|
|
EnableDownload |
Enables download of the source file. |
Boolean |
true false |
|
|
|
EnableTeamURL |
Hides or shows the team URL. |
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 links 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://app.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 helpfor more information. |
String |
application or animation |
|
|
|
ShowDashboardFunctions |
Setting this to false will hide all functions that will navigate the user to the ProofHQ application. This is applicable when proof management is done outside of ProofHQ |
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) |
14.5 |
|
|
ReferenceID |
Reference id for a proof (it can be any string that could be used to identify a proof) |
string |
proof789 |
16.17 |
|
|
ResolutionID |
A comma seperated list of resolution ids used for web capture proofs:
1: WQHD 2560x1440 2: FHD 1920x1080 3: UXGA 1600x1200 4: HD 1366x768 5: WXGA 1280x720 6: XGA 1024x768 7: IPAD 2048x1536 9: STD 2560x1600 10: STD 1920x1280 11: STD 1280x800 12: IPHONE_640x1136 13: STD 1080x1920 14: IPHONE 375x667
|
string |
3 5 11 |
17.16 |
|
|
WorkflowTemplateID |
Id of the proof template that should be used to create a proof |
int |
123 |
17.19 |
|
SOAPWorkflowProofObjectArray
: array of SOAPWorkflowProofObject