Trigger Report Schedule¶
触发报表调度任务。
请求格式¶
POST https://{api-gateway}/s-reportds/v1.0/subscription/execution
请求参数 (URI)¶
名称 |
位置 (Path/Query) |
必需/可选 |
数据类型 |
描述 |
---|---|---|---|---|
orgId |
Query |
必需 |
String |
报表调度任务所属组织的 ID。如何获取 orgID>> |
accesskey |
Query |
必需 |
String |
触发报表调度任务的应用的密钥(access key)。如何获取 accesskey>> |
请求参数 (Body)¶
名称 |
必需/可选 |
数据类型 |
描述 |
---|---|---|---|
scheduleId |
必需 |
String |
报表调度任务的 ID。 |
parameters.argKey |
可选 |
String |
动态参数的键(key)。 |
parameters.argValue |
可选 |
String |
动态参数的值(value)。 |
返回内容类型¶
application/json
返回码¶
参见 报表工具 API 返回码。
示例¶
请求示例¶
#requestURI:
POST https://{api-gateway}/s-reportds/v1.0/subscription/execution?accessKey=yourAppAccessKey&orgId=yourOrgId
#requestBody:
{
"scheduleId":"yourScheduleId",
"parameters": [
{
"argKey": "pointList",
"argValue": "SITE.RadiationACC,SITE.ActiveProduction,SITE.FullHour,SITE.TBA_TotalTime"
},
{
"argKey": "orgId",
"argValue": "yourOrgId"
},
{
"argKey": "mdmIds",
"argValue": "yourMdmId"
},
{
"argKey": "startTime",
"argValue": "2020-01-01"
},
{
"argKey": "endTime",
"argValue": "2020-12-31"
},
{
"argKey": "token",
"argValue": "Bearer APP_PORTAL_S_1234567890987654321"
},
{
"argKey": "timeGroup",
"argValue": "M"
}
]
}
返回示例¶
{
"msg": "Success",
"code": 0,
"data": {sampleData},
"success": true
}