Query Template Parameter¶
Query the parameters of a report template by specifying template ID, template key, organization ID, etc.
Request Format¶
GET https://{api-gateway}/report-design-service/v1.0/report-file/arguments?action=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>> |
Request Parameters (Body)¶
Note
reportId, reportKey, and originalId are all optional, but you must use at least one of the parameters in the request.
The priority of the parameters to designate a report template is as below: reportId (highest) > reportKey > originalId (lowest).
Name |
Mandatory/Optional |
Data Type |
Description |
|---|---|---|---|
reportId |
Optional |
String |
The ID of the report template. How to get reportId>> |
reportKey |
Optional |
String |
The unique key of the new report template. How to get reportKey>> A report template key must meet these requirements:
|
originalId |
Optional |
String |
The root ID of the report template. How to get originalId>> |
Response Content Type¶
application/json
Response Codes¶
Samples¶
Request Sample¶
#requestURI:
GET https://{api-gateway}/report-design-service/v1.0/report-file/arguments/query?reportId=yourReportId&reportKey=yourReportKey&originalId=yourOriginalId&orgId=yourOrgId
Response Sample¶
{
"msg": "Success",
"code": 0,
"data": {[
{
"name": "token",
"hidden": "false",
"parameterType": "simple",
"controlType": "text",
"required": "true",
"allowNull": "false",
"allowMultiple": "false",
"dataType": "string",
"conceal": "false"
},
{
"name": "type",
"hidden": "false",
"parameterType": "simple",
"controlType": "text",
"required": "true",
"allowNull": "false",
"allowMultiple": "false",
"dataType": "string",
"conceal": "false"
},
{
"name": "booleanParameter",
"defaultValue": "False",
"hidden": "false",
"parameterType": "simple",
"controlType": "checkbox",
"required": "true",
"allowNull": "false",
"allowMultiple": "false",
"dataType": "boolean",
"conceal": "false"
},
{
"name": "startDate",
"hidden": "false",
"parameterType": "simple",
"controlType": "text",
"required": "true",
"allowNull": "false",
"allowMultiple": "false",
"dataType": "dateTime",
"conceal": "false"
},
{
"name": "endDate",
"displayFormat": "EndDate",
"hidden": "false",
"parameterType": "simple",
"controlType": "text",
"required": "false",
"allowNull": "true",
"allowMultiple": "false",
"dataType": "date",
"conceal": "false"
},
{
"name": "siteTree",
"displayFormat": "SingleSite",
"hidden": "false",
"parameterType": "simple",
"controlType": "text",
"required": "false",
"allowNull": "true",
"allowMultiple": "false",
"dataType": "string",
"conceal": "false"
},
{
"name": "multiSiteTree",
"promptText": "{\"defaultValue\":\"site list\",\"i18nValue\":{\"en_US\":\"site list en_US\",\"zh_CN\":\"场站列表\",\"es_ES\":\"site list es_ES\",\"ja_JP\":\"site list ja_jP\"}}",
"helpText": "{\"defaultValue\":\"site list\",\"i18nValue\":{\"en_US\":\"site list en_US\",\"zh_CN\":\"场站列表\",\"es_ES\":\"site list es_ES\",\"ja_JP\":\"site list ja_jP\"}}",
"displayFormat": "MultiSite",
"hidden": "false",
"parameterType": "simple",
"controlType": "text",
"required": "false",
"allowNull": "true",
"allowMultiple": "false",
"dataType": "string",
"conceal": "false"
},
{
"name": "decimalParameter",
"hidden": "false",
"parameterType": "simple",
"controlType": "text",
"required": "false",
"allowNull": "true",
"allowMultiple": "false",
"dataType": "decimal",
"conceal": "false"
},
{
"name": "floatParameter",
"hidden": "false",
"parameterType": "simple",
"controlType": "text",
"required": "false",
"allowNull": "true",
"allowMultiple": "false",
"dataType": "float",
"conceal": "false"
},
{
"name": "integerParameter",
"hidden": "false",
"parameterType": "simple",
"controlType": "text",
"required": "false",
"allowNull": "true",
"allowMultiple": "false",
"dataType": "integer",
"conceal": "false"
},
{
"name": "listBoxParameter",
"hidden": "false",
"parameterType": "simple",
"controlType": "select",
"required": "false",
"allowNull": "true",
"allowMultiple": "true",
"dataType": "string",
"conceal": "false",
"selectionList": [
{
"selectionValue": "1",
"selectionDisplayText": "listbox1"
},
{
"selectionValue": "2",
"selectionDisplayText": "listbox2"
}
]
},
{
"name": "radioGroupParameter",
"hidden": "false",
"parameterType": "simple",
"controlType": "radio",
"required": "false",
"allowNull": "true",
"allowMultiple": "false",
"dataType": "string",
"conceal": "false",
"selectionList": [
{
"selectionValue": "1",
"selectionDisplayText": "radio1"
},
{
"selectionValue": "2",
"selectionDisplayText": "radio2"
}
]
},
{
"name": "SelectionListDefault",
"defaultValue": "123",
"hidden": "false",
"parameterType": "simple",
"controlType": "select",
"required": "true",
"allowNull": "false",
"allowMultiple": "false",
"dataType": "string",
"conceal": "false",
"selectionList": [
{
"selectionValue": "123",
"selectionDisplayText": "zh",
},
{
"selectionValue": "456",
"selectionDisplayText": "en"
}
]
},
{
"name": "MultiParameters",
"defaultValue": "12|||34",
"hidden": "false",
"parameterType": "simple",
"controlType": "select",
"required": "true",
"allowNull": "false",
"allowMultiple": "true",
"dataType": "string",
"conceal": "false",
"selectionList": [
{
"selectionValue": "12",
"selectionDisplayText": "z"
},
{
"selectionValue": "34",
"selectionDisplayText": "h"
},
{
"selectionValue": "56",
"selectionDisplayText": "c"
}
]
}，
{
"name": "DefaultParameter",
"defaultValue": "test default",
"hidden": "false",
"parameterType": "simple",
"controlType": "text",
"required": "false",
"allowNull": "true",
"allowMultiple": "false",
"dataType": "string",
"conceal": "false"
}
]},
"success": true
}