searchPageByModel - OpenMeta 中文版

请求参数

Query 参数

modelName

string

必需

Model name

Body 参数application/json

aggFunctions

object (AggFunctions)

可选

支持多个聚合查询条件:

[]

["SUM", "amount"]

[["SUM", "amount"], ["COUNT", "id"]]

示例值:

["SUM","amount"]

effectiveDate

string <date>

可选

Effective date, default is Today.

fields

array[string]

可选

Fields to get, empty means all fields.

示例值:

["id","name"]

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"]

groupBy

array[string]

可选

Fields to group by, empty means no grouping.

示例值:

[]

orders

object (Orders)

可选

支持多个排序条件：

[]

["name", "ASC"]

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

or string format: "name ASC, sequence DESC"

示例值:

["name","ASC"]

pageNumber

integer <int32>

可选

Page number, start from 1, default 1.

示例值:

1

pageSize

integer <int32>

可选

Page size, or limit size for searchList, default 50.

示例值:

50

splitBy

array[string]

可选

Pivot split field list.

示例值:

[]

subQueries

object

可选

Sub queries for relational fields: {fieldName: SubQuery}

示例值:

{}

额外字段

object (SubQuery)

可选

基于关系型字段的子查询条件，结构如: {fieldName: SubQuery}

示例值:

{}

summary

boolean

可选

Whether to return the summary result of numeric fields, default no summary.

示例

{
    "aggFunctions": [
        "SUM",
        "amount"
    ],
    "effectiveDate": "2019-08-24",
    "fields": [
        "id",
        "name"
    ],
    "filters": [
        "name",
        "=",
        "PM"
    ],
    "groupBy": [],
    "orders": [
        "name",
        "ASC"
    ],
    "pageNumber": 1,
    "pageSize": 50,
    "splitBy": [],
    "subQueries": {},
    "summary": true
}

示例代码

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/ChangeLog/searchPageByModel?modelName' \
--header 'Content-Type: application/json' \
--data-raw '{
    "aggFunctions": [
        "SUM",
        "amount"
    ],
    "effectiveDate": "2019-08-24",
    "fields": [
        "id",
        "name"
    ],
    "filters": [
        "name",
        "=",
        "PM"
    ],
    "groupBy": [],
    "orders": [
        "name",
        "ASC"
    ],
    "pageNumber": 1,
    "pageSize": 50,
    "splitBy": [],
    "subQueries": {},
    "summary": true
}'

返回响应

🟢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"
}