Query Template Parameter¶

通过指定组织 ID、报表模板 ID 等参数来查询报表模板中的参数。

请求格式¶

GET https://{api-gateway}/report-design-service/v1.0/report-file/arguments/query

请求参数 (URI)¶

名称	位置 (Path/Query)	必需/可选	数据类型	描述
orgId	Query	必需	String	报表模板所属组织的 ID。如何获取 orgID>>
reportId	Query	可选	String	各版本报表模板的唯一 ID，新建或更新报表模板时由接口返回。该参数值随报表模板的变更而更新。如何获取 reportId>>
reportKey	Query	可选	String	报表模板的自定义 ID，由用户指定。如何获取 reportKey>>
originalId	Query	可选	String	报表模板的初始 ID，新建报表模板时由接口返回。该参数值不随模板的更新而改变。如何获取 originalId>>

备注

reportId、reportKey 和 originalId 均为可选参数，但在一次请求中必须使用至少其中一个参数。
如请求中使用了多个指定报表模板的参数，系统按照如下优先级来查询：
originalId （最高）> reportId > reportKey （最低）。

响应参数¶

名称	数据类型	描述
name	String	参数名称。
required	String	是否为必需参数。 `true` 表示必需， `false` 表示非必需。
dataType	String	数据类型，参数值可以是 String/ boolean/ dateTime/ date/ integer/ float/ decimal 等。
defaultValue	String	参数的默认值。
allowMultiple	String	当有可选项时，是否可以多选。`true` 表示可以多选，`false` 表示不可多选。
selectionList	SelectionItem 结构体	可选的枚举项。

SelectionItem 结构体¶

参数名称	数据类型	描述
selectionDisplayText	String	可选项的展示名称。
selectionValue	String/integer/…	可选项的枚举值，基于参数名称而定数据类型。

返回内容类型¶

application/json

返回码¶

参见报表工具 API 返回码。

示例¶

请求示例¶

#requestURL:
GET https://{api-gateway}/report-design-service/v1.0/report-file/arguments/query?orgId=yourOrgId&reportId=ddaa91a6723c9d111758c1cf52b14d8f&originalId=ddaa91a6723c9d111758c1cf52b14d8f&reportKey=yourReportKey

返回示例¶

{
"msg": "Success",
    "code": 0,
    "data": [
        {
            "name": "booleanParameter",
            "defaultValue": "False",
            "controlType": "checkbox",
            "required": "true",
            "dataType": "boolean"
        },
        {
            "name": "startDate",
            "controlType": "text",
            "required": "true",
            "dataType": "dateTime"
        },
        {
            "name": "endDate",
            "controlType": "text",
            "required": "false",
            "dataType": "date"
        },
        {
            "name": "decimalParameter",
            "required": "false",
            "controlType": "text",
            "dataType": "decimal"
        },
        {
            "name": "floatParameter",
            "required": "false",
            "controlType": "text",
            "dataType": "float"
        },
        {
            "name": "listBoxParameter",
            "controlType": "select",
            "required": "false",
            "allowMultiple": "true",
            "dataType": "string",
            "selectionList": [
                {
                    "selectionValue": "1",
                    "selectionDisplayText": "listbox1"
                },
                {
                    "selectionValue": "2",
                    "selectionDisplayText": "listbox2"
                }
            ]
        },
        {
            "name": "radioGroupParameter",
            "controlType": "radio",
            "required": "false",
            "dataType": "string",
            "selectionList": [
                {
                    "selectionValue": "1",
                    "selectionDisplayText": "radio1"
                },
                {
                    "selectionValue": "2",
                    "selectionDisplayText": "radio2"
                }
            ]
        },
        {
            "name": "MultiParameters",
            "defaultValue": "12|||34",
            "controlType": "select",
            "required": "true",
            "allowMultiple": "true",
            "dataType": "string",
            "selectionList": [
                {
                    "selectionValue": "12",
                    "selectionDisplayText": "z"
                },
                {
                    "selectionValue": "34",
                    "selectionDisplayText": "h"
                },
                {
                    "selectionValue": "56",
                    "selectionDisplayText": "c"
                }
            ]
        }
    ],
    "success": true
}