DownloadFile
Download a file attached to a specified entity.
Input
| Name | Type | Required | Accepts Output Streams | Description |
| EntityType | String | True | False | The type of the entity to get the file from. This must be one of: Candidate, ClientContact, ClientCorporation, JobOrder, Opportunity, Placement.
The allowed values are Candidate, ClientContact, ClientCorporation, JobOrder, Opportunity, Placement. |
| EntityId | String | True | False | The identifier of the entity. You can query the respective table to list all entities. |
| FileId | String | True | False | The identifier of the file. You can query the EntityFiles view to list all file Ids. |
| OutputFolder | String | False | False | The location of the folder you want to save the file in. |
| FileStream | String | False | True | An instance of an output stream where file data is written to. Only used if OutputFolder is not set. |
Result Set Columns
| Name | Type | Description |
| FileData | String | If the OutputFolder input is empty, file data will be output encoded in base64. |
| Success | String | Indicates whether or not the operation was successful. |