Download Attachments

Description

This step downloads attachments from an incident in TOPdesk to a local folder. You provide the incident ID and the output folder path. Use this step in workflows that retrieve supporting documents from incidents, collect evidence for processing, or archive attachments for compliance.

Reference URL https://developers.TOPdesk.com/explorer/?page=incident#/attachments/get_incidents_number__incidentNumber__attachments

Configurations

General Tab

No.	Field Name	Description
1	Step Name	Name of the step. This name must be unique within a single workflow.
	Connection:
2	Base URL	Base URL of the TOPdesk instance. For example: https://xxxx.TOPdesk.net for a cloud instance. Data type: String. This field is mandatory.
3	Username	Specify the username of the TOPdesk instance that has administrative permission to authenticate. Data type: String. This field is mandatory.
	Password:
4	Accept Values as variable/static	Leave the checkbox unchecked to accept the Password value from a field in the previous steps using a drop-down list. Enable the checkbox to display the Password field as a text box.
5	Application Password (Token)	Enter the application password (token) of the TOPdesk instance using a widget. The widget supports both Text (static value or environment variable) and Combo (drop-down from previous steps). If the checkbox above is enabled, the Password field appears as a text box and accepts static values or variables. If the checkbox is disabled, the Password field appears as a drop-down to select fields from previous steps. Data type: Secure string. This field is mandatory. Steps to create a password in TOPdesk: To create a password, go to the following URL:<a href="https://developers.TOPdesk.com/tutorial.html#show-collapse-usage-createAppPassword">https://developers.TOPdesk.com/tutorial.html#show-collapse-usage-createAppPassword</a>

Input Tab

No.	Field Name	Description
	Input Fields:
1	Incident Number / ID	Specify the incident ID or number of the file to download. Data type: String. This field is mandatory.
2	Output Folder Path	Specify the folder to store the downloaded file. Data type: String. This field is mandatory.
3	Browse	Click this button and select the output folder path.

Output Tab

No.	Field Name	Description
	Output Field:
1	Total Files	Specify the output field to hold the result of the successful plugin execution. The default label value for this field is “TotalFiles”.
2	Download Files	Specify the output field to hold the result of the successful plugin execution. The default label value for this field is “DownloadFiles”.
3	File Overwritten	Specify the output field to hold the result of the successful plugin execution. The default label value for this field is “FileOverwritten”.

Common Buttons

No.	Field Name	Description
	Buttons:
1	OK	On click of this button, it will check the field values. If any required field values are missing, it will display a validation error message. If all required field values are provided, it will save the field values.
2	Cancel	On click of this button, it will cancel the window and will not save any values.