Sign in

v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Create Data Field

This API allows you to define specific data fields that you want to include in the entity search at organisation level.

post/api_gateway/cortex/v1/dataFields

Response

200

OR

Example response

{
  "data": {
    "id": "67e6a8bfdd6a186b5555ba98",
    "orgId": 100737,
    "searchStrategyType": "PREFIX",
    "entityType": "CUSTOMER",
    "dataFieldDefinitions": [
      {
        "fieldId": "firstName",
        "fieldAlias": "firstName",
        "fieldType": "DATA",
        "dataSourceDetails": {
          "fieldReference": "firstName"
        },
        "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
    }
  }
}