Data Connectors
Display a listing of the Data Connector Categories.
Filter results by string. Searches Name, Description, and Status. Status must match exactly. Others can be a substring.
Field to order results by
asc
Possible values: 10
GET /api/1.0/data_source_categories HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
list of Data Connectors categories
{
"data": [
{
"name": "text",
"status": "ACTIVE",
"id": "text",
"created_at": "2025-07-05T03:19:37.300Z",
"updated_at": "2025-07-05T03:19:37.300Z"
}
],
"meta": {
"filter": "text",
"sort_by": "text",
"sort_order": "asc",
"count": 1,
"total_pages": 1,
"current_page": 1,
"form": 1,
"last_page": 1,
"path": "text",
"per_page": 1,
"to": 1,
"total": 1
}
}
Store a newly created Data Connector Category in storage
Represents a business data Source category definition.
POST /api/1.0/data_source_categories HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 33
{
"name": "text",
"status": "ACTIVE"
}
success
{
"name": "text",
"status": "ACTIVE",
"id": "text",
"created_at": "2025-07-05T03:19:37.300Z",
"updated_at": "2025-07-05T03:19:37.300Z"
}
Display the specified data Source category.
ID of Data Connector category to return
GET /api/1.0/data_source_categories/{data_source_category_id} HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
Successfully found the Data Connector
{
"name": "text",
"status": "ACTIVE",
"id": "text",
"created_at": "2025-07-05T03:19:37.300Z",
"updated_at": "2025-07-05T03:19:37.300Z"
}
Updates the current element
ID of Data Connector category to return
Represents a business data Source category definition.
PUT /api/1.0/data_source_categories/{data_source_category_id} HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 33
{
"name": "text",
"status": "ACTIVE"
}
success
{
"name": "text",
"status": "ACTIVE",
"id": "text",
"created_at": "2025-07-05T03:19:37.300Z",
"updated_at": "2025-07-05T03:19:37.300Z"
}
Remove the specified resource from storage.
ID of Data Connector category to return
DELETE /api/1.0/data_source_categories/{data_source_category_id} HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
success
No content
Get the list of records of a Data Connector
Filter results by string. Searches Name, Description, and Status. Status must match exactly. Others can be a substring.
Field to order results by
asc
Possible values: 10
Include data from related models in payload. Comma separated list.
""
GET /api/1.0/data_sources HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
list of Data Connectors
{
"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-07-05T03:19:37.300Z",
"updated_at": "2025-07-05T03:19:37.300Z"
}
],
"meta": {
"filter": "text",
"sort_by": "text",
"sort_order": "asc",
"count": 1,
"total_pages": 1,
"current_page": 1,
"form": 1,
"last_page": 1,
"path": "text",
"per_page": 1,
"to": 1,
"total": 1
}
}
Create a new Data Connector.
Class DataSource
POST /api/1.0/data_sources HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 173
{
"id": "text",
"name": "text",
"description": "text",
"endpoints": "text",
"mappings": "text",
"authtype": "text",
"credentials": "text",
"status": "text",
"data_source_category_id": "text"
}
success
{
"id": "text",
"name": "text",
"description": "text",
"endpoints": "text",
"mappings": "text",
"authtype": "text",
"credentials": "text",
"status": "text",
"data_source_category_id": "text",
"created_at": "2025-07-05T03:19:37.300Z",
"updated_at": "2025-07-05T03:19:37.300Z"
}
Get a single Data Connector.
ID of Data Connector to return
GET /api/1.0/data_sources/data_source_id HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
Successfully found the Data Connector
{
"id": "text",
"name": "text",
"description": "text",
"endpoints": "text",
"mappings": "text",
"authtype": "text",
"credentials": "text",
"status": "text",
"data_source_category_id": "text",
"created_at": "2025-07-05T03:19:37.300Z",
"updated_at": "2025-07-05T03:19:37.300Z"
}
Update a Data Connector.
ID of Data Connector to return
Class DataSource
PUT /api/1.0/data_sources/data_source_id HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 173
{
"id": "text",
"name": "text",
"description": "text",
"endpoints": "text",
"mappings": "text",
"authtype": "text",
"credentials": "text",
"status": "text",
"data_source_category_id": "text"
}
success
{
"id": "text",
"name": "text",
"description": "text",
"endpoints": "text",
"mappings": "text",
"authtype": "text",
"credentials": "text",
"status": "text",
"data_source_category_id": "text",
"created_at": "2025-07-05T03:19:37.300Z",
"updated_at": "2025-07-05T03:19:37.300Z"
}
Delete a Data Connector.
ID of Data Connector to return
DELETE /api/1.0/data_sources/data_source_id HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
success
{
"id": "text",
"name": "text",
"description": "text",
"endpoints": "text",
"mappings": "text",
"authtype": "text",
"credentials": "text",
"status": "text",
"data_source_category_id": "text",
"created_at": "2025-07-05T03:19:37.300Z",
"updated_at": "2025-07-05T03:19:37.300Z"
}
Send a Data Connector request.
ID of Data Connector to return
Class DataSource
POST /api/1.0/data_sources/data_source_id/test HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 173
{
"id": "text",
"name": "text",
"description": "text",
"endpoints": "text",
"mappings": "text",
"authtype": "text",
"credentials": "text",
"status": "text",
"data_source_category_id": "text"
}
success
{
"id": "text",
"name": "text",
"description": "text",
"endpoints": "text",
"mappings": "text",
"authtype": "text",
"credentials": "text",
"status": "text",
"data_source_category_id": "text",
"created_at": "2025-07-05T03:19:37.300Z",
"updated_at": "2025-07-05T03:19:37.300Z"
}
Execute a data Source endpoint
ID of the request in whose context the datasource will be executed
ID of DataSource to be run
POST /api/1.0/requests/{request_id}/data_sources/{data_source_id} HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 125
{
"config": {
"endpoint": "text",
"dataMapping": [
{
"key": "text",
"value": "text"
}
],
"outboundConfig": [
{
"key": "text",
"value": "text"
}
]
}
}
success
{
"status": 1,
"response": {}
}
ID of DataSource to be run
POST /api/1.0/requests/data_sources/{data_source_id} HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 135
{
"config": {
"endpoint": "text",
"dataMapping": [
{
"key": "text",
"value": "text"
}
],
"outboundConfig": [
{
"key": "text",
"value": "text"
}
]
},
"data": {}
}
success
{
"status": 1,
"response": {}
}
ID of DataSource to be run
Endpoint of the data source
POST /api/1.0/requests/data_sources/{data_source_id}/resources/{endpoint}/data HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
success
{
"status": 1,
"response": {}
}
Last updated