Get Incidents

Description

This step retrieves incident details from TOPdesk. You provide the incident number or ID, and the step returns the incident data. Use this step in workflows that look up ticket details for processing, check incident status before taking action, or collect incident data for reporting and downstream operations.

Reference URL

• https://developers.TOPdesk.com/explorer/?page=incident
• https://developers.TOPdesk.com/tutorial.html#query

General Tab

No.	Field Name	Description
1	Step Name	Name of the step. This name has to be unique in 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)	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 Name	Description
	Input Fields:
1	Criteria Query	Specify the criteria query expression for the TOPdesk query operator to perform query operations. Incidents matching the criteria query will be outputted in the output. Examples: status==secondLine briefDescription=sw=PS number==I2201-047 briefDescription=sw=PS;id==8ce6c299-2ed2-460d-82b5-4e9f93c13370
2	Fetch Records Batch Size	Fetch the records in the provided batch.
3	Get Top N Records	Fetch the top N records matching the criteria query.

Output Tab

No.	Field Name	Description
	Output Field:
1	Incident Details	Hold the result of successful plugin execution. Default value: IncidentDetails

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.