searchList - OpenMeta

Request

Path Params

modelName

string

required

Body Params application/json

aggFunctions

object (AggFunctions)

optional

Support multiple aggregation queries:

[]

["SUM", "amount"]

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

Example:

["SUM","amount"]

effectiveDate

string <date>

optional

Effective date, default is Today.

fields

array[string]

optional

Fields list to get, empty means all fields of the model.

Example:

["id","name"]

filters

object (Filters)

optional

Support nested filters, such as [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"]]

Example:

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

groupBy

array[string]

optional

Fields to group by, empty means no grouping.

Example:

[]

limit

integer <int32>

optional

Limit size for searchList, default 50.

Example:

50

orders

object (Orders)

optional

Support multiple order conditions:

[]

["name", "ASC"]

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

or string format: "name ASC, sequence DESC"

Example:

["name","ASC"]

splitBy

array[string]

optional

Pivot split field list.

Example:

[]

subQueries

object

optional

Sub queries for relational fields: {fieldName: SubQuery}

Example:

{}

Additional properties

object (SubQuery)

optional

Sub queries for relational fields: {fieldName: SubQuery}

Example:

{}

Example

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

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST '//searchList' \
--header 'Content-Type: application/json' \
--data-raw '{
    "aggFunctions": [
        "SUM",
        "amount"
    ],
    "effectiveDate": "2019-08-24",
    "fields": [
        "id",
        "name"
    ],
    "filters": [
        "name",
        "=",
        "PM"
    ],
    "groupBy": [],
    "limit": 50,
    "orders": [
        "name",
        "ASC"
    ],
    "splitBy": [],
    "subQueries": {}
}'

Responses

🟢200OK

*/*

OK

Body

code

integer <int32>

optional

Status Code

data

object (FileInfo)

optional

Result Data

checksum

string

optional

Checksum

fileId

string

optional

File ID

fileName

string

optional

File Name

fileType

enum<string>

optional

File Type

Allowed values:

JPGPNGWEBPBMPTIFSVGGIFICOCSVTXTDOCDOCXPPTPPTXXLSXLSXPDFJSONXMLYAMLZIPGZIPTARRARGZMP3WAVAACOGGFLACMP4AVIMOVWMVFLV

size

integer <int32>

optional

File Size (KB)

url

string

optional

Temporary Download URL

message

string

optional

Common Message

Example

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