Queries the sort expressions that are configured for a version of an OpenSearch application.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request headers

This operation uses only common request headers. For more information, see Common request parameters.

Request syntax

GET /v4/openapi/app-groups/[appGroupIdentity]/apps/[appId]/sort-expressions HTTP/1.1

Request parameters

Parameter Type Position Required Example Description
appGroupIdentity String Path Yes my_app_group_name

The name of the application.

appId Integer Path Yes 110116134

The ID of the version.

Paging parameters

Parameter

Type

Required

Example

Description

pageNumber

Integer

No

1

The number of the page to return. Default value: 1.

pageSize

Integer

No

10

The number of entries to return on each page. Default value: 10.

Response parameters

Parameter Type Example Description
requestId String D77D0DAF-790D-F5F5-A9C0-133738165014

The ID of the request.

result Array of firstRankItem

The information about the rough sort or fine sort expressions that were returned.

For more information, see FirstRank and SecondRank.

active Boolean true

Indicates whether the expression is the default one.

created Integer 0

The time when the expression was created.

description String ""

The description of the expression.

name String default

The name of the expression.

updated Integer 0

The time when the expression was last updated.

Examples

Sample requests

GET /v4/openapi/app-groups/os_function_test_v1/apps/110157886/sort-expressions

Sample success responses

XML format

<requestId>D77D0DAF-790D-F5F5-A9C0-133738165014</requestId>
<result>
    <name>default</name>
    <description/>
    <active>true</active>
    <meta>
        <attribute>static_bm25()</attribute>
        <arg/>
        <weight>1</weight>
    </meta>
    <created>0</created>
    <updated>0</updated>
</result>
<result>
    <name>default</name>
    <meta/>
    <active>false</active>
    <description/>
    <created>0</created>
    <updated>0</updated>
    <isDefault>false</isDefault>
    <isSys>true</isSys>
</result>
<result>
    <name>tests</name>
    <meta>random()+now()</meta>
    <active>true</active>
    <description/>
    <created>1587052801</created>
    <updated>1587052801</updated>
    <isDefault>true</isDefault>
    <isSys>false</isSys>
</result>
<result>
    <name>test</name>
    <meta>query_term_count()</meta>
    <active>false</active>
    <description/>
    <created>1587052801</created>
    <updated>1587052801</updated>
    <isDefault>false</isDefault>
    <isSys>false</isSys>
</result>
<totalCount>4</totalCount>

JSON format

{
    "requestId": "D77D0DAF-790D-F5F5-A9C0-133738165014",
    "result": [
        {
            "name": "default",
            "description": "",
            "active": true,
            "meta": {
                "attribute": "static_bm25()",
                "arg": "",
                "weight": 1
            },
            "created": 0,
            "updated": 0
        },
        {
            "name": "default",
            "meta": "",
            "active": false,
            "description": "",
            "created": 0,
            "updated": 0,
            "isDefault": false,
            "isSys": true
        },
        {
            "name": "tests",
            "meta": "random()+now()",
            "active": true,
            "description": "",
            "created": 1587052801,
            "updated": 1587052801,
            "isDefault": true,
            "isSys": false
        },
        {
            "name": "test",
            "meta": "query_term_count()",
            "active": false,
            "description": "",
            "created": 1587052801,
            "updated": 1587052801,
            "isDefault": false,
            "isSys": false
        }
    ],
    "totalCount": 4
}

Error codes

For a list of error codes, visit the API Error Center.