Query Template Parameter¶

To query the parameters of a report template by specifying organization ID, report template original ID, etc.

Request Format¶

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

Request Parameters (URI)¶

Name	Location (Path/Query)	Mandatory/Optional	Data Type	Description
orgId	Query	Mandatory	String	The ID of the organization which the report templates belong to. How to get orgID>>
reportId	Query	Optional	String	The unique ID of each version of the report template, generated when you create or update the report template. How to get reportId>>
reportKey	Query	Optional	String	The custom ID of the report template, specified by the caller. How to get reportKey>>
originalId	Query	Optional	String	The original ID of the report template, generated when you create the template. The value of originalId remains unchanged regardless of modifications to the template. How to get originalId>>

Note

reportId, reportKey, and originalId are all optional, but you must use at least one of the parameters in the request.
If you use multiple parameters, EnOS Reporting Tool processes your request according to the following priority order:
originalId (highest) > reportId > reportKey (lowest).

响应参数¶

Name	Data Type	Description
name	String	Parameter name.
required	String	Indicates whether the parameter is required. `true` means the parameter is required, `false` means non-required.
dataType	String	Data type. The value can be string//boolean/dateTime/date/integer/float/decimal.
defaultValue	String	The default value of the parameter.
allowMultiple	String	Indicates whether multiple selection is allowed. `true` means multiple selection is supported. `false` means only single selection is allowed.
selectionList	SelectionItem Struct	A list of selectable items.

SelectionItem Struct¶

Name	Data Type	Description
selectionDisplayText	String	The display text of the item.
selectionValue	String/integer/…	The enumeration value. Its data type is defined by the associated parameter.

Response Content Type¶

application/json

Response Codes¶

See Reporting Tool API Response Codes.

Samples¶

Request Sample¶

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

Response Sample¶

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