Skip to main content

Upload Attachment

Description

TOPdesk: Upload Attachment uploads an attachment for an incident on a specified TOPdesk incident.

tip
  • The step does not support custom fields and other fields, such as phone number, mobile number, and email because the Metadata API call which provides the field details is not available. Field metadata is required to prevent hardcoding and develop a plugin step generically.
  • Some Display Values on UI are not the same as that of Logical values in API. For example, the display value on UI for the Category field is Software but the Logical value (API) for that field (Category) is Software specific.

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

General Tab

No.Field NameDescription
1Step NameName of the step.

This name has to be unique in a single workflow.

Connection:
2Base URLBase URL of the TOPdesk instance.

For example: https://xxxx.TOPdesk.net for a cloud instance.

Data type: String.

This field is mandatory.

3UsernameSpecify the username of the TOPdesk instance that has administrative permission to authenticate.

Data type: String.

This field is mandatory.

Password:
4Accept Values as variable/staticLeave 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.

5Application Password (Token)Application Password (Token) of the TOPdesk instance is entered using a widget.

The widget handles both Text (static value or environment variable) and Combo (drop-down containing values 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 above 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 NameDescription
Input Fields:
1Incident Number/IDSpecify the incident number or ID of the file to be uploaded.
2File To UploadSpecify the name of the file that is to be uploaded.

Provide the local file path of the file to upload.

3BrowseClick the button to select the path of the file which is to be uploaded.

Output Tab

Field NameDescription
Output Fields:
Attachment IDSpecify the output field to hold the result of the successful plugin execution. The default label value is “AttachmentID”.

Common Buttons

No.Field NameDescription
Buttons:
1OKOn 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.

2CancelOn click of this button, it will cancel the window and will not save any values.