ProcessMaker Documentation
ProcessMaker HomeGive Us FeedbackRelease NotesDownload Open-Source Edition
Search…
ProcessMaker 4.2
ProcessMaker Documentation
Quick Links
ProcessMaker Home
Give Us Feedback
Contact Sales
Start Here
How to Use This Document
Get Started with ProcessMaker
Use ProcessMaker
Web Browser Requirements
Log On to ProcessMaker
Profile Settings
View File Manager
View ProcessMaker Product Documentation
View ProcessMaker Version Information
Session Timeout Warning
Log Out of ProcessMaker
Requests
Task Management
File Management
Search ProcessMaker Data Using ProcessMaker Query Language (PMQL)
What is PMQL?
PMQL Syntax to Search ProcessMaker Data
PMQL Data Types: Request, Task, and Collection
PMQL Properties by Data Type
Special Characters in API Call PMQL Searches
Saved Searches
Notifications
Control How Tabular Information Displays
JSON: The Foundation of Request Data
What is Request Data?
What is a Request Variable?
What is JSON?
Manage and Model Processes
Process Management
Script Management
Screen Management
Environment Variable Management
Signal Management
Data Connector Management
Vocabularies Management
Process Modeling
Reference Magic Variables in ProcessMaker Assets
Expression Syntax Components
ProcessMaker Administration
User Management
Group Management
Permission Descriptions for Users and Groups
Manage Saved Searches
Settings
Client Authentication Management
Customize the User Interface
Queue Management
Script Executor Management
ProcessMaker Collections
User Interface Language Management
Download for On-Premises Installation
On-Premises Server Requirements
Download the Open-Source Edition for On-Premises Installation
Open-Source Edition Installation Instructions
Packages
What is a Package?
ProcessMaker Packages
ProcessMaker API Documentation
Access ProcessMaker RESTful API Documentation
ProcessMaker Examples
Collections Examples
Data Connector Examples
Screen Design Examples
Script Executor Examples
Deprecation Notices
Advanced Screens Package
Other Links
Download ProcessMaker Open-Source Edition
ProcessMaker Open-Source Edition Installation Instructions
Privacy Statement
Powered By GitBook
Special Characters in API Call PMQL Searches
Use special characters, such as &, within PMQL searches when getting Request, Task, or Collection data.

Special Characters in API Call PMQL Searches

Perform ProcessMaker Query Language (PMQL) searches in ProcessMaker Application Program Interface (API) calls using any properties of the following data types:
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.
Use special characters, such as &, within PMQL searches when getting Request, Task, or Collection data while calling a ProcessMaker API endpoint. To do so, special characters used in API calls must be Uniform Resource Identifier (URI) compliant.
For example, the following API call that gets Collection records from Collection ID 2 that contain tables & chairs in their names does not work because after the property collection data.name there are specials characters such as the =, ", space, and & .
pm_server_name represents the name of your ProcessMaker 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 API call:
  1. 1.
    Ensure that your ProcessMaker Administrator has created client authentication for your user account. If not, contact your ProcessMaker Administrator.
  2. 2.
    Visit a Website that converts special characters to be URI-compliant, such as OnlineWebToolKit.
  3. 3.
    Copy the special character(s) in your ProcessMaker 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.name from the API endpoint URL to encode it. The encoding tool converts the characters ="tables & chairs" to %3D%22tables%20%26%20chairs%22.
  4. 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 API endpoint URL with %3D%22tables%20%26%20chairs%22 as follows: https://pm_server_name/api/1.0/collections/collection/2/records?pmql=data.Name%3D%22tables%20%26%20chairs%22
  5. 5.
    Call the ProcessMaker API endpoint that now includes the URI-encoded special character(s).

Related Topics

Previous
Collection Data Type PMQL Properties
Next - Use ProcessMaker
Saved Searches
Last modified 13d ago
Export as PDF
Copy link
Edit on GitHub
Outline
Special Characters in API Call PMQL Searches
Related Topics