ProcessMaker 4.1
ProcessMaker API Documentation
ProcessMaker Examples
Powered By GitBook
What is a Resource?
Understand what a Resource is and how Resources are used in Data Connectors to interact with their data sources.

What is a Resource?

A Data Connector uses Resources to interact with the data source to which it is configured. In this context, a Resource is an action the Data Connector uses to interact with the data source. Similar to Application Program Interface (API) endpoints, Resources in a Data Connector call the data source to interact with it.

What is an Endpoint, and How is it Different than a Resource?

When the data source is a third-party API, it expects an interaction from a Data Connector to one of its components which the data source may reference as an endpoint. An API endpoint expects a specific manner in which a Data Connector's Resource interacts with it, which is called a method.

What is a Method?

How a Data Connector's Resource interacts with a data source endpoint is called a method. When a Data Connector interacts with a third-party API's endpoint, that endpoint expects a method from which the Data Connector's Resource interacts with that endpoint. A Data Connector may use any of the following methods to interact with an API endpoint:
    GET: The GET method retrieves a resource from the data source.
    POST: The POST method creates a resource in the data source.
    PUT: The PUT method does one of the following:
      Update: The PUT method may update data an existing resource in the data source.
      Create: The PUT method may create a resource in the data source.
    PATCH: The PATCH method partially modifies an existing resource.
    DELETE: The DELETE method removes an existing resource from the data source.
A third-party API's endpoint may also expect specific parameters from the Data Connector's Resource to properly interact with that endpoint. Those parameters and their settings ideally are documented in that third-party API's documentation so you understand what an endpoint expects in the interaction. Parameters are added at the end of the base URL used to connect with that data source's endpoint and ideally would also be documented in that third-party API's documentation. How to configure parameter settings to interact with an endpoint/method is outside the scope of this documentation.
View this ProcessMaker API documentation to quickly view how to use our RESTful API without testing API endpoints.
Collections also have Resources with which a Data Connector interacts with records in that Collection.

Resources for Collections

A Collection automatically creates a Data Connector when it is created. Data Connectors created from a Collection by default have the same name as the Collection that it references.
Data Connectors created from Collections have the following Resources to interact with that Collection.
Resource
Purpose
Method
ListAll
Get a list of all records in that Collection.
GET
GetRecord
Get a record in that Collection by its record id.
GET
CreateRecord
Create a new record in that Collection.
POST
DeleteRecord
Delete a record from that Collection by its record id.
DELETE
UpdateRecord
Update a record in that Collection by its record id.
PUT

Related Topics

Last modified 1mo ago