UploadFile
Uploads a file to a specified entity. This stored procedure supports documentation workflows by allowing users to add attachments that enhance record completeness or compliance.
Input
| Name | Type | Required | Accepts Input Streams | Description |
| EntityType | String | True | False | Specifies the entity type that is associated with the UploadFile stored procedure. This input determines which entity the system links to the uploaded file.
The allowed values are Candidate, ClientContact, ClientCorporation, JobOrder, Opportunity, Placement. |
| EntityId | String | True | False | Specifies the unique identifier (Id) of the entity that receives the uploaded file. This input ensures that the attachment is associated with the correct entity record. |
| FileLocation | String | False | False | Specifies the full file path of the file that the UploadFile stored procedure processes. This input directs the system to retrieve the local file content to include in the upload. |
| ExternalId | String | True | False | Specifies the external Id that is associated with the file. This input allows external systems or integrations to reference the uploaded file consistently. |
| ContentType | String | False | False | Specifies the content type for the file that the UploadFile stored procedure uploads. This input enables the system to record the file's format for processing and retrieval. |
| Description | String | False | False | Specifies the descriptive comment that is associated with the uploaded file. This input provides additional context for users who view the attachment in Bullhorn CRM. |
| Type | String | False | False | Specifies the classification type that is associated with the uploaded file. This input allows the system to categorize the attachment for organizational and workflow purposes. |
| Content | String | False | True | Represents the input-stream content that is uploaded when the FileLocation input is not provided. This input enables direct streaming of file data without requiring a physical file path. |
| FileName | String | False | False | Specifies the name of the file that is uploaded when the Content input is provided. This input allows the system to assign a file name to streamed content during the upload process. |
Result Set Columns
| Name | Type | Description |
| Success | String | Returns a value of 'true' when the UploadFile stored procedure completes the file upload successfully. It returns a value of 'false' when the system cannot process or attach the file. |
| FileId | String | Represents the unique Id of the file that the UploadFile stored procedure attaches. This output enables the system or caller to reference the newly uploaded file in subsequent operations. |