UploadFile
Upload a file to a specified entity.
Input
Name | Type | Required | Accepts Input 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. |
FileLocation | String | False | False | Full path of the file you want to attach. |
ExternalId | String | True | False | External identifier for the file. |
ContentType | String | False | False | Type/subtype of the file content. |
Description | String | False | False | Comment that describes the file. |
Type | String | False | False | Type of file that is attached. For example, resume, cover etc... |
Content | String | False | True | The content as InputStream to be uploaded when FileLocation is not specified. |
FileName | String | False | False | FileName is required when Content is specified. |
Result Set Columns
Name | Type | Description |
Success | String | Indicates whether or not the operation was successful. |
FileId | String | The identifier of the attached file. |