|
Parameter |
Example |
API Version |
||
|
file_id |
File identifier |
integer |
36456 |
|
|
type |
File type (file / proof) |
string |
File type (file / proof) |
|
|
filename |
File/proof name. If the proof name is different to the file then this parameter will contain the proof name |
string |
Proofhq-api.pdf |
|
|
sourcename |
File name. If the proof is made up of multiple files return a list of comma delimited names e.g. "filename1.jpg, filename2.jpg,..." |
string |
Proofhq-api.pdf |
15.17 |
|
filesize |
File size (in KB) |
string |
35 |
|
|
version |
Version number |
integer |
1 |
|
|
versions |
Versions count |
integer |
1 |
|
|
upload_time |
Upload date |
string |
2011-08-01 23:59 (YYYY-MM-DD hh:mm) |
|
|
uploader |
Name of the user who uploaded the file |
string |
First Last |
|
|
owner |
Name of the user who created the proof |
string |
First Last |
|
|
owner_email |
Email address of the user who created the proof |
string |
user@example.net |
18.2 |
| deadline |
Deadline date of reviewing | string | 2011-09-01 23:59 (YYYY-MM-DD hh:mm) |
|
| workspace_id |
Workspace identifier (0 if no workspace was specified) |
integer | 100 |
|
| workspace_name |
The name of the workspace | string |
Some workspace |
|
| workflow_template_id |
The id of workflow template (value returned if the proof was created from workflow template) | int |
1234 |
16.7 |
| status |
Locked / Unlocked status of the proof unlocked locked |
string |
unlocked |
|
| decision |
The current decision status of the proof. See the available decisions here and how the proof status is calculated here (Proof results: status). |
string | pending |
|
| team_url |
Proof team URL. See help for more information. |
string | http://app.proofhq.com/proof/XXXXXXX |
|
| settings |
Settings object |
SOAPFileSettingsObject |
|
|
| custom_link_url |
Allows you to specify a custom URL. |
string | http://app.proofhq.com/ |
|
| custom_link_label |
Enables download of source file |
string | ProofHQ Home |
|
| menus_links |
Deprecated |
|
||
| swf |
string |
|
||
|
decision_reasons |
The decision reasons for each of the reviewers on this proof |
Array of |
|
|
|
electronic_signatures |
Indicates if electronic signatures have been enabled for this proof |
boolean |
|
|
|
owner_id |
The id of the user that owns this proof |
integer |
89766 |
|
|
uploader_id |
The id of the user that uploaded this proof |
integer |
76565 |
|
|
show_send_decision_confirmation_checkbox |
Toggle on / off the "Send me an email confirmation of my decision" option in the Proofing tool (ProofViewer) |
boolean |
true (default) |
|
|
parent_file_id |
If this is the first version then this field will be empty, otherwise the identifier of the previous proof version |
integer |
|
13.17 |
|
automated_workflow |
if this is an automated workflow proof, otherwise 0 |
integer |
|
13.17 |
|
stages |
A collection of all the proof stages |
Array of |
|
13.17 |
|
progress |
Indicates the progress of the proof |
|
13.17 |
|
|
last_decision_change_date |
Indicates date on which last decision was changed |
int |
2011-08-01 23:59 (YYYY-MM-DD hh:mm) |
14.7 |
|
token |
The unique token that identifies this proof |
string |
9qJ4TvoygqtbG3gWMoeCESLNpjGmEOfe |
16.1 |
|
pages |
Number of pages in a proof |
int |
1 |
16.3 |
|
upload_timezone |
Timezone related to upload date |
string |
(GMT+1:00) Warsaw |
17.3 |
|
reference_id |
Reference id for a proof (it can be any string that could be used to identify a proof) |
string |
refnum1234 |
16.17 |
|
resolution |
Id of the resolution used to create a web proof
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 |
int |
5 |
17.15 |
|
processing_status |
Status fo the proof processing (one of: success, processing, failed) |
string |
success |
17.16 |
|
is_interactive |
Is proof interactive |
boolean |
true / false |
17.16 |
|
is_url_proof |
Is proof web capture |
boolean |
true / false |
17.16 |
|
is_combined |
If proof is combined of several files |
boolean |
true / false |
17.17 |
|
creator_email |
Email address of the user who createa the proof |
string |
creator@example.com |
17.16 |
|
decision_id |
Type of the decision on the proof: 0: pending 1: changes required 2: approved with changes 3: approved 4: not relevant |
int |
3 |
17.16 |