processmaker.com Knowledge Center ProcessMaker University

Data Connectors

PreviousAdministrative APIs NextCollections

Last updated 2 months ago

Was this helpful?

Returns all Data Connectors categories that the user has access to

Display a listing of the Data Connector Categories.

get

/data_source_categories

Authorizations

Query parameters

filterstring

Filter results by string. Searches Name, Description, and Status. Status must match exactly. Others can be a substring.

order_bystring

Field to order results by

order_directionstring · enum · default: asc

Options: asc, desc

per_pageinteger · default: 10

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/1.0/data_source_categories'

200

{
  "data": [
    {
      "name": "text",
      "status": "ACTIVE",
      "id": "text",
      "created_at": "2025-02-20T19:15:36.304Z",
      "updated_at": "2025-02-20T19:15:36.304Z"
    }
  ],
  "meta": {
    "filter": "text",
    "sort_by": "text",
    "count": 1,
    "total_pages": 1,
    "current_page": 1,
    "form": 1,
    "last_page": 1,
    "path": "text",
    "per_page": 1,
    "to": 1,
    "total": 1,
    "sort_order": "asc"
  }
}

list of Data Connectors categories

Save a new Data Connector Category

Store a newly created Data Connector Category in storage

post

/data_source_categories

Authorizations

Body

namestring

Represents a business data Source category definition.

statusstring · enum

Options: ACTIVE, INACTIVE

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/1.0/data_source_categories' \
  --header 'Content-Type: application/json' \
  --data '{"status":"ACTIVE"}'

201

{
  "name": "text",
  "status": "ACTIVE",
  "id": "text",
  "created_at": "2025-02-20T19:15:36.304Z",
  "updated_at": "2025-02-20T19:15:36.304Z"
}

success

Get single Data Connector category by ID

Display the specified data Source category.

get

/data_source_categories/{data_source_category_id}

Authorizations

Path parameters

data_source_category_idstringrequired

ID of Data Connector category to return

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/1.0/data_source_categories/{data_source_category_id}'

200

{
  "name": "text",
  "status": "ACTIVE",
  "id": "text",
  "created_at": "2025-02-20T19:15:36.304Z",
  "updated_at": "2025-02-20T19:15:36.304Z"
}

Successfully found the Data Connector

Update a Data Connector Category

Updates the current element

put

/data_source_categories/{data_source_category_id}

Authorizations

Path parameters

data_source_category_idstringrequired

ID of Data Connector category to return

Body

namestring

Represents a business data Source category definition.

statusstring · enum

Options: ACTIVE, INACTIVE

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/1.0/data_source_categories/{data_source_category_id}' \
  --header 'Content-Type: application/json' \
  --data '{"status":"ACTIVE"}'

200

{
  "name": "text",
  "status": "ACTIVE",
  "id": "text",
  "created_at": "2025-02-20T19:15:36.304Z",
  "updated_at": "2025-02-20T19:15:36.304Z"
}

success

Delete a Data Connector category

Remove the specified resource from storage.

delete

/data_source_categories/{data_source_category_id}

Authorizations

Path parameters

data_source_category_idstringrequired

ID of Data Connector category to return

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/api/1.0/data_source_categories/{data_source_category_id}'

204

No body

success

Returns all Data Connectors that the user has access to

Get the list of records of a Data Connector

get

/data_sources

Authorizations

Query parameters

filterstring

Filter results by string. Searches Name, Description, and Status. Status must match exactly. Others can be a substring.

order_bystring

Field to order results by

order_directionstring · enum · default: asc

Options: asc, desc

per_pageinteger · default: 10

includestring

Include data from related models in payload. Comma separated list.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/1.0/data_sources'

200

{
  "data": [
    {
      "id": "text",
      "name": "text",
      "description": "text",
      "endpoints": "text",
      "mappings": "text",
      "authtype": "text",
      "credentials": "text",
      "status": "text",
      "data_source_category_id": "text",
      "created_at": "2025-02-20T19:15:36.304Z",
      "updated_at": "2025-02-20T19:15:36.304Z"
    }
  ],
  "meta": {
    "filter": "text",
    "sort_by": "text",
    "count": 1,
    "total_pages": 1,
    "current_page": 1,
    "form": 1,
    "last_page": 1,
    "path": "text",
    "per_page": 1,
    "to": 1,
    "total": 1,
    "sort_order": "asc"
  }
}

list of Data Connectors

Save a new Data Connector

Create a new Data Connector.

post

/data_sources

Authorizations

Body

idstring · id

Class DataSource

namestring

descriptionstring

endpointsstring

mappingsstring

authtypestring

credentialsstring

statusstring

data_source_category_idstring

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/1.0/data_sources' \
  --header 'Content-Type: application/json'

201

{
  "id": "text",
  "name": "text",
  "description": "text",
  "endpoints": "text",
  "mappings": "text",
  "authtype": "text",
  "credentials": "text",
  "status": "text",
  "data_source_category_id": "text",
  "created_at": "2025-02-20T19:15:36.304Z",
  "updated_at": "2025-02-20T19:15:36.304Z"
}

success

Get single Data Connector by ID

Get a single Data Connector.

get

/data_sources/data_source_id

Authorizations

Path parameters

data_source_idstringrequired

ID of Data Connector to return

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/1.0/data_sources/data_source_id'

200

{
  "id": "text",
  "name": "text",
  "description": "text",
  "endpoints": "text",
  "mappings": "text",
  "authtype": "text",
  "credentials": "text",
  "status": "text",
  "data_source_category_id": "text",
  "created_at": "2025-02-20T19:15:36.304Z",
  "updated_at": "2025-02-20T19:15:36.304Z"
}

Successfully found the Data Connector

Update a Data Connector

Update a Data Connector.

put

/data_sources/data_source_id

Authorizations

Path parameters

data_source_idstringrequired

ID of Data Connector to return

Body

idstring · id

Class DataSource

namestring

descriptionstring

endpointsstring

mappingsstring

authtypestring

credentialsstring

statusstring

data_source_category_idstring

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/1.0/data_sources/data_source_id' \
  --header 'Content-Type: application/json'

204

{
  "id": "text",
  "name": "text",
  "description": "text",
  "endpoints": "text",
  "mappings": "text",
  "authtype": "text",
  "credentials": "text",
  "status": "text",
  "data_source_category_id": "text",
  "created_at": "2025-02-20T19:15:36.304Z",
  "updated_at": "2025-02-20T19:15:36.304Z"
}

success

Delete a Data Connector

Delete a Data Connector.

delete

/data_sources/data_source_id

Authorizations

Path parameters

data_source_idstringrequired

ID of Data Connector to return

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/api/1.0/data_sources/data_source_id'

204

{
  "id": "text",
  "name": "text",
  "description": "text",
  "endpoints": "text",
  "mappings": "text",
  "authtype": "text",
  "credentials": "text",
  "status": "text",
  "data_source_category_id": "text",
  "created_at": "2025-02-20T19:15:36.304Z",
  "updated_at": "2025-02-20T19:15:36.304Z"
}

success

Send a Data Connector request

Send a Data Connector request.

post

/data_sources/data_source_id/test

Authorizations

Path parameters

data_source_idstringrequired

ID of Data Connector to return

Body

idstring · id

Class DataSource

namestring

descriptionstring

endpointsstring

mappingsstring

authtypestring

credentialsstring

statusstring

data_source_category_idstring

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/1.0/data_sources/data_source_id/test' \
  --header 'Content-Type: application/json'

204

{
  "id": "text",
  "name": "text",
  "description": "text",
  "endpoints": "text",
  "mappings": "text",
  "authtype": "text",
  "credentials": "text",
  "status": "text",
  "data_source_category_id": "text",
  "created_at": "2025-02-20T19:15:36.304Z",
  "updated_at": "2025-02-20T19:15:36.304Z"
}

success

execute Data Source

Execute a data Source endpoint

post

/requests/{request_id}/data_sources/{data_source_id}

Authorizations

Path parameters

request_idstringrequired

ID of the request in whose context the datasource will be executed

data_source_idstringrequired

ID of DataSource to be run

Body

configobject

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/1.0/requests/{request_id}/data_sources/{data_source_id}' \
  --header 'Content-Type: application/json' \
  --data '{"config":{"dataMapping":[{}],"outboundConfig":[{}]}}'

200

{
  "status": 1,
  "response": {}
}

success

execute Data Source

post

/requests/data_sources/{data_source_id}

Authorizations

Path parameters

data_source_idstringrequired

ID of DataSource to be run

Body

configobject

dataobject

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/1.0/requests/data_sources/{data_source_id}' \
  --header 'Content-Type: application/json' \
  --data '{"config":{"dataMapping":[{}],"outboundConfig":[{}]},"data":{}}'

200

{
  "status": 1,
  "response": {}
}

success

Get Data from Data Source

post

/requests/data_sources/{data_source_id}/resources/{endpoint}/data

Authorizations

Path parameters

data_source_idstringrequired

ID of DataSource to be run

endpointstringrequired

Endpoint of the data source

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/1.0/requests/data_sources/{data_source_id}/resources/{endpoint}/data'

200

{
  "status": 1,
  "response": {}
}

success