get https://{host}/api_gateway/cortex/v1/dataFields
This API allows you to retrieve the data field definitions for the specified entity (Customer or Transaction)
Note:
For detailed information about the APIs and for hands-on testing, refer to the API overview documentation and the step-by-step guide on making your first API call.
Prerequisites
- Authentication: Basic/OAuth authentication
- Default access group
Resource information
| URI | api_gateway/cortex/v1/dataFields |
| HTTP method | GET |
| Pagination | NA |
| Rate limit | Default |
| Batch support | NA |
API Endpoint Example
[{host}/api_gateway/cortex/v1/dataFields](https://eu.api.capillarytech.com/api_gateway/cortex/v1/dataFields)
Request Body
curl --location 'https://eu.api.capillarytech.com/api_gateway/cortex/v1/dataFields' \
--header 'Authorization: Basic cHJlcmFuYV9zaaDoyZmFhZmZjNjY5ZDRjMTc5Y2NlMzNhYzc5OTBjMTQ1Ng==' \
--header 'Content-Type: application/json' \
--header 'Cookie: _cfuvid=257QQtZKKeLsnIKUrPVpHcKPHvi2s4LSYFlH8VLHtc0-1743065149089-0.0.1.1-604800000; _cfuvid=cryFX5AeUyWVtFaBgq_5BT7fv.XNzDRf_OtNgx6a9oA-1743493240591-0.0.1.1-604800000'
curl --location 'eu.api.capillarytech.com/api_gateway/cortex/v1/dataFields' \
--header 'Authorization: Basic bmVlcmFqLmRvYzpiNGFmODDA5Y2IwMzZhNGNjZGMzMzQzMWVmOWFjOQ==' \
--header 'Content-Type: application/json' \
--header 'Cookie: _cfuvid=NIG4hPIouTlCOXgwODX50uFuouza2nwDNThbawZibQM-1743137683215-0.0.1.1-604800000' \
--data '{
"searchStrategyType" : "COMBINATION",
"entityType" : "TRANSACTION",
"dataFieldDefinitions" :
[
{
"fieldId" : "billNumber",
"fieldAlias" : "billNumber",
"fieldType" : "DATA",
"dataSourceDetails" :
{
"fieldReference" : "billNumber"
},
"dataType" : "STRING"
},
{
"fieldId" : "billDate",
"fieldAlias" : "billDate",
"fieldType" : "DATA",
"dataSourceDetails" : {
"fieldReference" : "billDate"
},
"dataType" : "DATE"
},
{
"fieldId" : "storename",
"fieldAlias" : "storename",
"fieldType" : "DATA",
"dataSourceDetails" : {
"fieldReference" : "additionalFields.storename"
},
"dataType" : "STRING"
},
{
"fieldId" : "storecode",
"fieldAlias" : "storecode",
"fieldType" : "DATA",
"dataSourceDetails" : {
"fieldReference" : "additionalFields.storecode"
},
"dataType" : "STRING"
}
]
}'
Response Body Parameters
| Parameter | Data Type | Description |
|---|---|---|
| id | String | Unique Identifier of the data field definition |
| orgId | Integer | The ID of the organization |
| searchStrategyType | Enum | Defines the search strategy type (`COMBINATION, PREFIX ) |
| entityType | Enum | Type of entity being searched (TRANSACTION , CUSTOMER) |
| dataFieldDefinitions | Array | List of field definitions |
| - fieldId | String | Unique identifier for the field. |
| - fieldAlias | String | The alias or display name of the search field. |
| - fieldType | Enum | Type of field (e.g., INDEXED, FILTERABLE). |
| - dataSourceDetails | Object | Contains details about the data source. |
| -- fieldReference | String | The reference to the search field in the data source. |
| - dataType | String | Data type of the field |
| auditInfo | Object | An object containing audit information about the criteria. |
| - createdOn | String | The timestamp indicating when the criteria was created. |
| - createdBy | Integer | The ID of the user who created the criteria. |
| - lastUpdatedOn | String | The timestamp indicating when the search criteria was last updated. |
| - lastUpdatedBy | Integer | The ID of the user who last updated the criteria. |
{
"data": [
{
"id": "67e6a8bfdd6a186b5555ba98",
"orgId": 100737,
"searchStrategyType": "PREFIX",
"entityType": "CUSTOMER",
"dataFieldDefinitions": [
{
"fieldId": "firstName",
"fieldAlias": "firstName",
"fieldType": "DATA",
"dataSourceDetails": {
"fieldReference": "firstName"
},
"dataType": "STRING"
},
{
"fieldId": "lastName",
"fieldAlias": "lastName",
"fieldType": "DATA",
"dataSourceDetails": {
"fieldReference": "lastName"
},
"dataType": "STRING"
},
{
"fieldId": "mobile",
"fieldAlias": "mobile",
"fieldType": "DATA",
"dataSourceDetails": {
"fieldReference": "mobile"
},
"dataType": "STRING"
},
{
"fieldId": "email",
"fieldAlias": "email",
"fieldType": "DATA",
"dataSourceDetails": {
"fieldReference": "email"
},
"dataType": "STRING"
},
{
"fieldId": "externalId",
"fieldAlias": "externalId",
"fieldType": "DATA",
"dataSourceDetails": {
"fieldReference": "externalId"
},
"dataType": "STRING"
}
],
"auditInfo": {
"createdOn": "2025-03-28T13:48:47.665+00:00",
"createdBy": 75155282,
"lastUpdatedOn": "2025-03-28T13:48:47.665+00:00",
"lastUpdatedBy": 75155282
}
}
],
"errors": []
}
{
"data": {
"id": "67ebcbe9730aa850fc504145",
"orgId": 100737,
"searchStrategyType": "COMBINATION",
"entityType": "TRANSACTION",
"dataFieldDefinitions": [
{
"fieldId": "billNumber",
"fieldAlias": "billNumber",
"fieldType": "DATA",
"dataSourceDetails": {
"fieldReference": "billNumber"
},
"dataType": "STRING"
},
{
"fieldId": "billDate",
"fieldAlias": "billDate",
"fieldType": "DATA",
"dataSourceDetails": {
"fieldReference": "billDate"
},
"dataType": "DATE"
},
{
"fieldId": "storename",
"fieldAlias": "storename",
"fieldType": "DATA",
"dataSourceDetails": {
"fieldReference": "additionalFields.storename"
},
"dataType": "STRING"
},
{
"fieldId": "storecode",
"fieldAlias": "storecode",
"fieldType": "DATA",
"dataSourceDetails": {
"fieldReference": "additionalFields.storecode"
},
"dataType": "STRING"
}
],
"auditInfo": {
"createdOn": "2025-04-01T11:20:09.793+00:00",
"createdBy": 75155282,
"lastUpdatedOn": "2025-04-01T11:20:09.793+00:00",
"lastUpdatedBy": 75155282
}
},
"errors": []
}