searchName

POST

/{modelName}/searchName

Query the displayNames based on the match field, filters, orders, limitSize. Default limit to 10.

Request

Path Params

Body Params application/json

Example

{
    "additionalFields": [
        "type"
    ],
    "effectiveDate": "2019-08-24",
    "filters": [
        "name",
        "=",
        "PM"
    ],
    "limit": 10,
    "matchField": "searchName",
    "operator": "=",
    "orders": [
        "name",
        "ASC"
    ],
    "value": "Tom"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '//searchName' \
--header 'Content-Type: application/json' \
--data-raw '{
    "additionalFields": [
        "type"
    ],
    "effectiveDate": "2019-08-24",
    "filters": [
        "name",
        "=",
        "PM"
    ],
    "limit": 10,
    "matchField": "searchName",
    "operator": "=",
    "orders": [
        "name",
        "ASC"
    ],
    "value": "Tom"
}'

Responses

🟢200OK

*/*

Body

Example

{
    "code": 0,
    "data": true,
    "message": "string",
    "success": true
}

Modified at 2026-03-02 03:08:55

searchList

searchPage