Special Characters in API Call PMQL Searches
Use special characters, such as &, within PMQL searches when getting Request, Task, or Collection data.
Learning this powerful tip how to perform PMQL searches via API calls allows you to perform PMQL searches without using the ProcessMaker user interface. However, having experience making API calls, which is an advanced skill most often performed by software developers and administrators, makes understanding this tip easier.
Understanding how to perform API calls is outside the scope of this topic.
For example, the following API call that gets Collection records from Collection ID
tables & chairsin their names does not work because after the property collection
data.namethere are specials characters such as the
pm_server_namerepresents the name of your ProcessMaker Platform instance.
https://pm_server_name/api/1.0/collections/collection/2/records?pmql=data.Name="tables & chairs"
Follow these steps to make that includes a special character in a ProcessMaker Platform API call:
- 3.Copy the special character(s) in your ProcessMaker Platform API endpoint call into the URI converter Website, and then click to encode the special character(s) to be URI-compliant.Referencing the example above, copy all the content after
data.namefrom the API endpoint URL to encode it. The encoding tool converts the characters
="tables & chairs"to
- 4.Paste the URI-encoded special character(s), and then replace the non-encoded special character(s) in your API endpoint URL.Referencing the example above, replace the
="tables & chairs"in the ProcessMaker Platform API endpoint URL with
- 5.Call the ProcessMaker Platform API endpoint that now includes the URI-encoded special character(s).
Last modified 3mo ago