第 56 章 报告配置服务
56.1. 报告配置服务 复制链接链接已复制到粘贴板!
56.1.1. CountReportConfigurations 复制链接链接已复制到粘贴板!
GET /v1/report-configurations-count
CountReportConfigurations 返回报告配置的数量。
56.1.1.1. 描述 复制链接链接已复制到粘贴板!
56.1.1.2. 参数 复制链接链接已复制到粘贴板!
56.1.1.2.1. 查询参数 复制链接链接已复制到粘贴板!
| Name | 描述 | 必填 | default | pattern |
|---|---|---|---|---|
| query | - | null | ||
| pagination.limit | - | null | ||
| pagination.offset | - | null | ||
| pagination.sortOption.field | - | null | ||
| pagination.sortOption.reversed | - | null | ||
| pagination.sortOption.aggregateBy.aggrFunc | - | UNSET | ||
| pagination.sortOption.aggregateBy.distinct | - | null |
56.1.1.3. 返回类型 复制链接链接已复制到粘贴板!
56.1.1.4. 内容类型 复制链接链接已复制到粘贴板!
- application/json
56.1.1.5. 响应 复制链接链接已复制到粘贴板!
| 代码 | 消息 | datatype |
|---|---|---|
| 200 | 成功响应。 | |
| 0 | 意外错误响应。 |
56.1.1.6. Samples 复制链接链接已复制到粘贴板!
56.1.2. DeleteReportConfiguration 复制链接链接已复制到粘贴板!
DELETE /v1/report/configurations/{id}
DeleteReportConfiguration 删除给定 id 的报告配置
56.1.2.1. 描述 复制链接链接已复制到粘贴板!
56.1.2.2. 参数 复制链接链接已复制到粘贴板!
56.1.2.2.1. 路径参数 复制链接链接已复制到粘贴板!
| Name | 描述 | 必填 | default | pattern |
|---|---|---|---|---|
| id | X | null |
56.1.2.3. 返回类型 复制链接链接已复制到粘贴板!
对象
56.1.2.4. 内容类型 复制链接链接已复制到粘贴板!
- application/json
56.1.2.5. 响应 复制链接链接已复制到粘贴板!
| 代码 | 消息 | datatype |
|---|---|---|
| 200 | 成功响应。 |
|
| 0 | 意外错误响应。 |
56.1.2.6. Samples 复制链接链接已复制到粘贴板!
56.1.3. GetReportConfiguration 复制链接链接已复制到粘贴板!
GET /v1/report/configurations/{id}
56.1.3.1. 描述 复制链接链接已复制到粘贴板!
56.1.3.2. 参数 复制链接链接已复制到粘贴板!
56.1.3.2.1. 路径参数 复制链接链接已复制到粘贴板!
| Name | 描述 | 必填 | default | pattern |
|---|---|---|---|---|
| id | X | null |
56.1.3.3. 返回类型 复制链接链接已复制到粘贴板!
56.1.3.4. 内容类型 复制链接链接已复制到粘贴板!
- application/json
56.1.3.5. 响应 复制链接链接已复制到粘贴板!
| 代码 | 消息 | datatype |
|---|---|---|
| 200 | 成功响应。 | |
| 0 | 意外错误响应。 |
56.1.3.6. Samples 复制链接链接已复制到粘贴板!
56.1.4. GetReportConfigurations 复制链接链接已复制到粘贴板!
GET /v1/report/configurations
56.1.4.1. 描述 复制链接链接已复制到粘贴板!
56.1.4.2. 参数 复制链接链接已复制到粘贴板!
56.1.4.2.1. 查询参数 复制链接链接已复制到粘贴板!
| Name | 描述 | 必填 | default | pattern |
|---|---|---|---|---|
| query | - | null | ||
| pagination.limit | - | null | ||
| pagination.offset | - | null | ||
| pagination.sortOption.field | - | null | ||
| pagination.sortOption.reversed | - | null | ||
| pagination.sortOption.aggregateBy.aggrFunc | - | UNSET | ||
| pagination.sortOption.aggregateBy.distinct | - | null |
56.1.4.3. 返回类型 复制链接链接已复制到粘贴板!
56.1.4.4. 内容类型 复制链接链接已复制到粘贴板!
- application/json
56.1.4.5. 响应 复制链接链接已复制到粘贴板!
| 代码 | 消息 | datatype |
|---|---|---|
| 200 | 成功响应。 | |
| 0 | 意外错误响应。 |
56.1.4.6. Samples 复制链接链接已复制到粘贴板!
56.1.5. PostReportConfiguration 复制链接链接已复制到粘贴板!
POST /v1/report/configurations
PostReportConfiguration 创建报告配置
56.1.5.1. 描述 复制链接链接已复制到粘贴板!
56.1.5.2. 参数 复制链接链接已复制到粘贴板!
56.1.5.2.1. 正文参数 复制链接链接已复制到粘贴板!
| Name | 描述 | 必填 | default | pattern |
|---|---|---|---|---|
| 正文(body) | X |
56.1.5.3. 返回类型 复制链接链接已复制到粘贴板!
56.1.5.4. 内容类型 复制链接链接已复制到粘贴板!
- application/json
56.1.5.5. 响应 复制链接链接已复制到粘贴板!
| 代码 | 消息 | datatype |
|---|---|---|
| 200 | 成功响应。 | |
| 0 | 意外错误响应。 |
56.1.5.6. Samples 复制链接链接已复制到粘贴板!
56.1.6. UpdateReportConfiguration 复制链接链接已复制到粘贴板!
PUT /v1/report/configurations/{id}
UpdateReportConfiguration 更新报告配置
56.1.6.1. 描述 复制链接链接已复制到粘贴板!
56.1.6.2. 参数 复制链接链接已复制到粘贴板!
56.1.6.2.1. 路径参数 复制链接链接已复制到粘贴板!
| Name | 描述 | 必填 | default | pattern |
|---|---|---|---|---|
| id | X | null |
56.1.6.2.2. 正文参数 复制链接链接已复制到粘贴板!
| Name | 描述 | 必填 | default | pattern |
|---|---|---|---|---|
| 正文(body) | X |
56.1.6.3. 返回类型 复制链接链接已复制到粘贴板!
对象
56.1.6.4. 内容类型 复制链接链接已复制到粘贴板!
- application/json
56.1.6.5. 响应 复制链接链接已复制到粘贴板!
| 代码 | 消息 | datatype |
|---|---|---|
| 200 | 成功响应。 |
|
| 0 | 意外错误响应。 |