API
processmaker.comAPI ReferenceKnowledge CenterProcessMaker University

Data Connectors

Returns all Data Connectors categories that the user has access to

Display a listing of the Data Connector Categories.

GET/api/1.0/data_source_categories
Query parameters
Response

list of Data Connectors categories

Body
dataarray of DataSourceCategory (object)
metaobject
Request
const response = await fetch('/api/1.0/data_source_categories', {
    method: 'GET',
    headers: {},
});
const data = await response.json();
Response
{
  "data": [
    {
      "name": "text",
      "status": "ACTIVE",
      "id": "text",
      "created_at": "2024-10-16T10:30:03.981Z",
      "updated_at": "2024-10-16T10:30:03.981Z"
    }
  ],
  "meta": {
    "filter": "text",
    "sort_by": "text",
    "sort_order": "asc",
    "path": "text"
  }
}

Save a new Data Connector Category

Store a newly created Data Connector Category in storage

POST/api/1.0/data_source_categories
Body
namestring

Represents a business data Source category definition.

statusenum
ACTIVEINACTIVE
Response

success

Body
namestring

Represents a business data Source category definition.

statusenum
ACTIVEINACTIVE
idstring (id)
created_atstring (date-time)
updated_atstring (date-time)
Request
const response = await fetch('/api/1.0/data_source_categories', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();
Response
{
  "name": "text",
  "status": "ACTIVE",
  "id": "text",
  "created_at": "2024-10-16T10:30:03.981Z",
  "updated_at": "2024-10-16T10:30:03.981Z"
}

Get single Data Connector category by ID

Display the specified data Source category.

GET/api/1.0/data_source_categories/{data_source_category_id}
Path parameters
data_source_category_id*string

ID of Data Connector category to return

Response

Successfully found the Data Connector

Body
namestring

Represents a business data Source category definition.

statusenum
ACTIVEINACTIVE
idstring (id)
created_atstring (date-time)
updated_atstring (date-time)
Request
const response = await fetch('/api/1.0/data_source_categories/{data_source_category_id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();
Response
{
  "name": "text",
  "status": "ACTIVE",
  "id": "text",
  "created_at": "2024-10-16T10:30:03.981Z",
  "updated_at": "2024-10-16T10:30:03.981Z"
}

Update a Data Connector Category

Updates the current element

PUT/api/1.0/data_source_categories/{data_source_category_id}
Path parameters
data_source_category_id*string

ID of Data Connector category to return

Body
namestring

Represents a business data Source category definition.

statusenum
ACTIVEINACTIVE
Response

success

Body
namestring

Represents a business data Source category definition.

statusenum
ACTIVEINACTIVE
idstring (id)
created_atstring (date-time)
updated_atstring (date-time)
Request
const response = await fetch('/api/1.0/data_source_categories/{data_source_category_id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();
Response
{
  "name": "text",
  "status": "ACTIVE",
  "id": "text",
  "created_at": "2024-10-16T10:30:03.981Z",
  "updated_at": "2024-10-16T10:30:03.981Z"
}

Delete a Data Connector category

Remove the specified resource from storage.

DELETE/api/1.0/data_source_categories/{data_source_category_id}
Path parameters
data_source_category_id*string

ID of Data Connector category to return

Response

success

Request
const response = await fetch('/api/1.0/data_source_categories/{data_source_category_id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Returns all Data Connectors that the user has access to

Get the list of records of a Data Connector

GET/api/1.0/data_sources
Query parameters
Response

list of Data Connectors

Body
dataarray of dataSource (object)
metaobject
Request
const response = await fetch('/api/1.0/data_sources', {
    method: 'GET',
    headers: {},
});
const data = await response.json();
Response
{
  "data": [
    {
      "id": "text",
      "name": "text",
      "description": "text",
      "endpoints": "text",
      "mappings": "text",
      "authtype": "text",
      "credentials": "text",
      "status": "text",
      "data_source_category_id": "text",
      "created_at": "2024-10-16T10:30:03.981Z",
      "updated_at": "2024-10-16T10:30:03.981Z"
    }
  ],
  "meta": {
    "filter": "text",
    "sort_by": "text",
    "sort_order": "asc",
    "path": "text"
  }
}

Save a new Data Connector

Create a new Data Connector.

POST/api/1.0/data_sources
Body
idstring (id)

Class DataSource

namestring
descriptionstring
endpointsstring
mappingsstring
authtypestring
credentialsstring
statusstring
data_source_category_idstring
Response

success

Body
idstring (id)

Class DataSource

namestring
descriptionstring
endpointsstring
mappingsstring
authtypestring
credentialsstring
statusstring
data_source_category_idstring
created_atstring (date-time)
updated_atstring (date-time)
Request
const response = await fetch('/api/1.0/data_sources', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();
Response
{
  "id": "text",
  "name": "text",
  "description": "text",
  "endpoints": "text",
  "mappings": "text",
  "authtype": "text",
  "credentials": "text",
  "status": "text",
  "data_source_category_id": "text",
  "created_at": "2024-10-16T10:30:03.981Z",
  "updated_at": "2024-10-16T10:30:03.981Z"
}

Get single Data Connector by ID

Get a single Data Connector.

GET/api/1.0/data_sources/data_source_id
Path parameters
data_source_id*string

ID of Data Connector to return

Response

Successfully found the Data Connector

Body
idstring (id)

Class DataSource

namestring
descriptionstring
endpointsstring
mappingsstring
authtypestring
credentialsstring
statusstring
data_source_category_idstring
created_atstring (date-time)
updated_atstring (date-time)
Request
const response = await fetch('/api/1.0/data_sources/data_source_id', {
    method: 'GET',
    headers: {},
});
const data = await response.json();
Response
{
  "id": "text",
  "name": "text",
  "description": "text",
  "endpoints": "text",
  "mappings": "text",
  "authtype": "text",
  "credentials": "text",
  "status": "text",
  "data_source_category_id": "text",
  "created_at": "2024-10-16T10:30:03.981Z",
  "updated_at": "2024-10-16T10:30:03.981Z"
}

Update a Data Connector

Update a Data Connector.

PUT/api/1.0/data_sources/data_source_id
Path parameters
data_source_id*string

ID of Data Connector to return

Body
idstring (id)

Class DataSource

namestring
descriptionstring
endpointsstring
mappingsstring
authtypestring
credentialsstring
statusstring
data_source_category_idstring
Response

success

Body
idstring (id)

Class DataSource

namestring
descriptionstring
endpointsstring
mappingsstring
authtypestring
credentialsstring
statusstring
data_source_category_idstring
created_atstring (date-time)
updated_atstring (date-time)
Request
const response = await fetch('/api/1.0/data_sources/data_source_id', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();
Response
{
  "id": "text",
  "name": "text",
  "description": "text",
  "endpoints": "text",
  "mappings": "text",
  "authtype": "text",
  "credentials": "text",
  "status": "text",
  "data_source_category_id": "text",
  "created_at": "2024-10-16T10:30:03.981Z",
  "updated_at": "2024-10-16T10:30:03.981Z"
}

Delete a Data Connector

Delete a Data Connector.

DELETE/api/1.0/data_sources/data_source_id
Path parameters
data_source_id*string

ID of Data Connector to return

Response

success

Body
idstring (id)

Class DataSource

namestring
descriptionstring
endpointsstring
mappingsstring
authtypestring
credentialsstring
statusstring
data_source_category_idstring
created_atstring (date-time)
updated_atstring (date-time)
Request
const response = await fetch('/api/1.0/data_sources/data_source_id', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();
Response
{
  "id": "text",
  "name": "text",
  "description": "text",
  "endpoints": "text",
  "mappings": "text",
  "authtype": "text",
  "credentials": "text",
  "status": "text",
  "data_source_category_id": "text",
  "created_at": "2024-10-16T10:30:03.981Z",
  "updated_at": "2024-10-16T10:30:03.981Z"
}

Send a Data Connector request

Send a Data Connector request.

POST/api/1.0/data_sources/data_source_id/test
Path parameters
data_source_id*string

ID of Data Connector to return

Body
idstring (id)

Class DataSource

namestring
descriptionstring
endpointsstring
mappingsstring
authtypestring
credentialsstring
statusstring
data_source_category_idstring
Response

success

Body
idstring (id)

Class DataSource

namestring
descriptionstring
endpointsstring
mappingsstring
authtypestring
credentialsstring
statusstring
data_source_category_idstring
created_atstring (date-time)
updated_atstring (date-time)
Request
const response = await fetch('/api/1.0/data_sources/data_source_id/test', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();
Response
{
  "id": "text",
  "name": "text",
  "description": "text",
  "endpoints": "text",
  "mappings": "text",
  "authtype": "text",
  "credentials": "text",
  "status": "text",
  "data_source_category_id": "text",
  "created_at": "2024-10-16T10:30:03.981Z",
  "updated_at": "2024-10-16T10:30:03.981Z"
}

execute Data Source

Execute a data Source endpoint

POST/api/1.0/requests/{request_id}/data_sources/{data_source_id}
Path parameters
request_id*string

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

data_source_id*string

ID of DataSource to be run

Body
configDataSourceCallParameters (object)
Response

success

Body
statusinteger
responseobject
Request
const response = await fetch('/api/1.0/requests/{request_id}/data_sources/{data_source_id}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();
Response
{}

execute Data Source

POST/api/1.0/requests/data_sources/{data_source_id}
Path parameters
data_source_id*string

ID of DataSource to be run

Body
configDataSourceCallParameters (object)
dataobject
Response

success

Body
statusinteger
responseobject
Request
const response = await fetch('/api/1.0/requests/data_sources/{data_source_id}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();
Response
{}

Get Data from Data Source

POST/api/1.0/requests/data_sources/{data_source_id}/resources/{endpoint}/data
Path parameters
data_source_id*string

ID of DataSource to be run

endpoint*string

Endpoint of the data source

Response

success

Body
statusinteger
responseobject
Request
const response = await fetch('/api/1.0/requests/data_sources/{data_source_id}/resources/{endpoint}/data', {
    method: 'POST',
    headers: {},
});
const data = await response.json();
Response
{}
PreviousAdministrative APIsNextCollections

Last updated

Logo

© 2024 ProcessMaker, Inc. All Rights Reserved. Except as otherwise permitted by ProcessMaker, this publication, or parts thereof, may not be reproduced in any form, by any method, for any purpose.