Queries the fine 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]/second-ranks 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 110157886

The ID of the version.

Response parameters

Parameter Type Example Description
requestId String 0A6EB64B-B4C8-CF02-810F-E660812972FF

The ID of the request.
result Array of result

The information about each fine sort expression.

For more information, see SecondRank.

active Boolean false

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.
id String 890473

The ID of the expression. This parameter appears only in the response.
isDefault String false

Indicates whether the expression is the default one. This parameter appears only in the response. Valid values:

  • true
  • false
isSys String true

Indicates whether the expression is a system expression. This parameter appears only in the response. Valid values:

  • true
  • false
meta String random()+now()

The content of the fine sort expression.

You can define an expression that consists of fields, feature functions, and mathematical functions to implement complex sort logic.

name String tests

The name of the expression.
updated Integer 1587052801

The time when the expression was last updated.
totalCount Integer 1

The total number of entries returned.

Examples

Sample requests

GET /v4/openapi/app-groups/os_function_test_v1/apps/110157886/second-ranks

Sample success responses

XML format 

<requestId>0A6EB64B-B4C8-CF02-810F-E660812972FF</requestId>
<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>

JSON format 

{
    "requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",
    "result": [
        {
            "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
        }
    ]
}

Error codes

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