searchName Copy - OpenMeta 中文版

请求参数

Body 参数application/json

additionalFields

array[string]

可选

Additional fields to fetch, in addition to displayName.

示例值:

["type"]

effectiveDate

string <date>

可选

Effective date, default is Today.

filters

object (Filters)

可选

支持嵌套筛选条件, 形如 [a OR b] AND [c OR d OR [e AND f] OR g] 结构，示例如下：

[]

["name", "=", "Tom"]

[["name", "=", "Tom"], ["version", "=", "6"]]

[["name", "=", "Tom"], "OR", ["code", "=", "A010"], "OR", ["version", "=", "2"]]

[["name", "=", "Tom"], "OR", ["code", "=", "A010"]], "AND", ["version", "=", "2"]]

示例值:

["name","=","PM"]

limit

integer <int32>

可选

Limit size for search, default 10.

示例值:

10

matchField

string

可选

Optionally specify the matching field. Default is searchName field configured in the model.

示例值:

searchName

operator

enum<string>

可选

The operator to use for the search. Default is CONTAINS.

枚举值:

=!=>>=<<=CONTAINSNOT CONTAINSSTART WITHNOT START WITHINNOT INBETWEENNOT BETWEENIS SETIS NOT SETPARENT OFCHILD OF

示例值:

CONTAINS

orders

object (Orders)

可选

支持多个排序条件：

[]

["name", "ASC"]

[["name", "ASC"], ["sequence", "DESC"]]

or string format: "name ASC, sequence DESC"

示例值:

["name","ASC"]

value

string

可选

The value to match using CONTAINS.

示例值:

Tom

示例

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

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://demo.openmeta.info/api/demo/rpc/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"
}'

返回响应

🟢200成功

*/*

OK

Body

code

integer <int32>

响应状态码

可选

data

object (FileInfo)

结果数据

可选

checksum

string

Checksum

可选

fileId

string

File ID

可选

fileName

string

File Name

可选

fileType

enum<string>

File Type

可选

枚举值:

JPGPNGWEBPBMPTIFSVGGIFICOCSVTXTDOCDOCXPPTPPTXXLSXLSXPDFJSONXMLYAMLZIPGZIPTARRARGZMP3WAVAACOGGFLACMP4AVIMOVWMVFLV

size

integer <int32>

可选

File Size (KB)

url

string

可选

Temporary Download URL

message

string

普通消息

可选

示例

{
  "code": 0,
  "data": {
    "checksum": "string",
    "fileId": "string",
    "fileName": "string",
    "fileType": "JPG",
    "size": 0,
    "url": "string"
  },
  "message": "string"
}