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)
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
Reference Magic Variables in ProcessMaker Assets
Environment Variable Management
Signal Management
Data Connector Management
Vocabularies Management
Process Modeling
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
Example: Use Request and Collection Data as Query Parameters in a ProcessMaker API Call
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
Example: Use Request and Collection Data as Query Parameters in a ProcessMaker API Call
Learn how to reference Request data and Collection record data as parameters when calling a ProcessMaker API endpoint.

Overview

Intended audience: Process designers, Web designers, graphic designers, software developers, coding engineers
Tags: Collections; PMQL; Request Variable
In the example below, reference Request data and data from a specified Colletion record in the URL query to a ProcessMaker API endpoint. Determine dynamically the specific Collection record by including a PMQL query within a ProcessMaker API call. The PMQL query uses a Request variable's value using mustache syntax for the Request variable's value in the URL to the API call.
Consider the following use case. Reference Collection data from Collection 5 for records created based on Requests started on a specific date. Determine the date dynamically by referencing a date in Request data stored in a Request variable date. The date that each Request starts is stored in another Request variable date_work_start.
  1. 1.
    ​Log on to ProcessMaker.
  2. 2.
    Open a new Web browser tab or window.
  3. 3.
    Connect to the ProcessMaker API for your ProcessMaker instance, such ashttps://MyOrganization.processmaker.net/api/1.0. See Access ProcessMaker RESTful API Documentation for more information.
  4. 4.
    Append to your URL the Collections syntax as desired such as https://MyOrganization.processmaker.net/api/1.0/collections/5/records.
    In the URL above, collections/5/records calls for the records in Collection 5.
  5. 5.
    Perform PMQL syntax as desired such as https://MyOrganization.processmaker.net/api/1.0/collections/5/records?pmql=data.date_work_start. Where data is calling the information of the collection records which specifically call information in the variable date_work_start.
  6. 6.
    Add a Request variable to your PMQL such ashttps://MyOrganization.processmaker.net/api/1.0/collections/5/records?pmql=data.date_work_start="{{date}}", where the {{date}} is a comparison value that requires quotations marks.
  7. 7.
    Optionally, test your URL using a Data Connector Endpoint.

Related Topics

Previous
Collections Examples
Next
Data Connector Examples
Last modified 3mo ago
Export as PDF
Copy link
Edit on GitHub
Contents
Overview
Related Topics