Get Records

Description

FreshDesk: Get Record step fetches all FreshDesk records matching the criteria query.

References

To check the Criteria Query [Criteria Value type required for the specified Criteria Field] supported for the given Form Name, use the following link:

text

Configurations

No.	Field Name	Description
	Configuration
1	Step Name	Specify the name of the step. This name has to be unique in a single workflow.
	Connection:
2	Base URL	Specify the base URL of the FreshDesk cloud instance. For example, https://XXXXX. freshdesk.com. The field data type is String. This field is mandatory.
3	Accept value as variable/static	Leave checkbox unchecked to accept API Key value from a field in the previous steps of the stream using a drop down list. Else enable checkbox for API Key field to appear as text box.
4	API Key	Specify the API Key to authenticate FreshDesk cloud instance. The field data type is String. This field is mandatory.
5	Test Connection	Verifies whether the connection is established or not. Note: For the purpose of verification, fields coming from previous steps are not allowed since field values can only be accessed when workflow is in running state. The Test Connection button will only work with static (hardcoded) values and environment variables.
	Input Fields:
1	Form Name	Specify the name of the form to get the matching records. The field data type is String. This field is mandatory.
2	Criteria Query	Provide the criteria query to fetch all FreshDesk records. For Criteria Query sample, see Annexure. The field data type is String. This field is mandatory. Note: You can fetch a maximum 300 records at a time.
3	Get Top N Records	Fetch the top N number of records returned by the criteria query. Note: You can fetch a maximum 300 records at a time.
	Output Fields:
1	Field Name	On click of the cell in the output table, if the connection is successfully established it populates the list of fields associated with the Form Name and Criteria Query on the FreshDesk cloud instance. The field data type is String. This field is mandatory.
2	Output Field	Specify the valid values for the fields associated with the field name.

Annexure

(ticket_field:integer OR ticket_field:'string') AND ticket_field:boolean Sample criteria query • priority:3 • status:3 OR status:4 • group_id:11 • (type:'Question' OR type:'Problem') AND (due_by:>'2017-10-01' AND due_by:<'2024-10-07')

Knwon Issues

Of the 300 records retrieved using the criteria query some records may be duplicate records. [API behavior]