Parameter | Example | API version |
proof_id | Proof 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 | |
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_id | Owner identifier | integer | 34545 | |
owner | Name of the user who created the proof | string | First Last | |
stages
| The objects identifying the stages on this proof | SOAPWorkflowProofStageObjectArray | See SOAPWorkflowProofStageObjectArray | |
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 | Determines the type of swf proof (animation / interactive) | string | animation | |
decision_reasons | The objects identifying the decision reasons for this proof | SOAPRecipientDecisionReasonObjectArray | See SOAPRecipientDecisionReasonObjectArray | |
combined_proof | Determines if this proof is made up of multiple sources | boolean | true | |
token | The unique token that identifies this proof | string | 9qJ4TvoygqtbG3gWMoeCESLNpjGmEOfe | 16.1 |
pages | Number of pages in a proof | int | 1 | 16.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 |