post https://{host}/api_gateway/cortex/v1/search
You can use this API and search for a transaction data.
Notes
- Make sure that you have appropriate access control configured. For more information, see access group documentation.
- By default, this search (cortex search) is not enbabled for all the orgs. Raise a Jira ticket to the sustenance team to activate.
API endpoint
{host}/api_gateway/cortex/v1/search/{id}
Body parameters
Parameter | Type | Description |
---|---|---|
searchCondition | array | An array containing the search conditions. |
searchCondition.fieldId | string | The ID of the standard, extended, or custom field that you want to search. (e.g., "destination" or "origin"). |
searchCondition.operator | string | The operator to be used for the condition. Only EQUALS is supported now. |
searchCondition.values | array | An array containing the values for the condition. Eg, from a specific origin to a destination. |
searchCondition.values | string | The specific value for the condition (e.g., "AUH" or "DAC"). |
Response parameters
Parameter | Description |
---|---|
data | An object containing the data related to the organization and entity details. |
data.orgId | The ID of the organization (e.g., 2064). |
data.entityType | The type of entity (e.g., "TRANSACTION"). |
data.entityDetails | An array containing the details of the entities. |
data.entityDetails.entityReference | The reference or category of the entity (e.g., "NOT_INTERESTED"). |
data.entityDetails.entityId | The ID of the entity (e.g., "80981216"). |
errors | An array containing any error messages. |