Perform 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

ParameterTypeDescription
searchConditionarrayAn array containing the search conditions.
searchCondition.fieldIdstringThe ID of the standard, extended, or custom field that you want to search. (e.g., "destination" or "origin").
searchCondition.operatorstringThe operator to be used for the condition. Only EQUALS is supported now.
searchCondition.valuesarrayAn array containing the values for the condition. Eg, from a specific origin to a destination.
searchCondition.valuesstringThe specific value for the condition (e.g., "AUH" or "DAC").

Response parameters

ParameterDescription
dataAn object containing the data related to the organization and entity details.
data.orgIdThe ID of the organization (e.g., 2064).
data.entityTypeThe type of entity (e.g., "TRANSACTION").
data.entityDetailsAn array containing the details of the entities.
data.entityDetails.entityReferenceThe reference or category of the entity (e.g., "NOT_INTERESTED").
data.entityDetails.entityIdThe ID of the entity (e.g., "80981216").
errorsAn array containing any error messages.
Language
Authorization
Basic
base64
:
URL
Click Try It! to start a request and see the response here!