Scheduled Reports data models
getScheduledReports — 200 response
Successfully retrieved the scheduled reports.
| Property | Type | Required | Constraints | Description |
|---|
data | array<object> | Yes | | |
Properties of data| Property | Type | Required | Constraints | Description |
|---|
answerEngine | object | Yes | | | Properties of answerEngine| Property | Type | Required | Constraints | Description |
|---|
assistantId | integer | Yes | | ID of the assistant to use for generating answers | maxConcurrentCalls | integer | No | default: 4 | Maximum number of concurrent calls to the assistant | | contents | string | Yes | | YAML configuration for report sections | creationTime | string | No | format: date-time | When the report was created | description | string | No | | Description of the scheduled report | directDestination | array<object> | No | | Direct rooms to send the report to | Properties of directDestination| Property | Type | Required | Constraints | Description |
|---|
id | string | Yes | | Direct room ID | name | string | No | | Direct room name | | enabled | boolean | No | | Whether the scheduled report is enabled | id | integer | Yes | | Unique identifier for the scheduled report | projectId | integer | Yes | | ID of the project this report belongs to | reportSchedule | object | Yes | | | Properties of reportSchedule| Property | Type | Required | Constraints | Description |
|---|
expression | string | Yes | | Schedule expression (e.g., cron expression) | timeZone | string | No | | Timezone for the schedule | type | string | Yes | | Type of schedule (e.g., cron) | | slackDestination | array<object> | No | | Slack channels to send the report to | Properties of slackDestination| Property | Type | Required | Constraints | Description |
|---|
id | string | Yes | | Slack channel ID | name | string | No | | Slack channel name | | teamsDestination | array<object> | No | | MS Teams channels to send the report to | Properties of teamsDestination| Property | Type | Required | Constraints | Description |
|---|
id | string | Yes | | MS Teams channel ID | name | string | No | | MS Teams channel name | | title | string | Yes | | Title of the scheduled report | updateTime | string | No | format: date-time | When the report was last updated | |
metadata | object | Yes | | |
Properties of metadata| Property | Type | Required | Constraints | Description |
|---|
count | integer | No | | Number of items returned | limit | integer | No | | Maximum number of items requested | skip | integer | No | | Number of items skipped | totalCount | integer | No | | Total number of items available | |
getScheduledReports — 401 response
Authorization is required to access this resource.
| Property | Type | Required | Constraints | Description |
|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
getScheduledReports — 403 response
Request failed because of denied permission.
| Property | Type | Required | Constraints | Description |
|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
getScheduledReports — 429 response
Request failed because of rate limit.
| Property | Type | Required | Constraints | Description |
|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
getScheduledReports — 500 response
An unexpected error has occurred.
| Property | Type | Required | Constraints | Description |
|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
getScheduledReports — 503 response
The service is temporarily unavailable.
| Property | Type | Required | Constraints | Description |
|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
createScheduledReport — request
Request body for Create scheduled report.
| Property | Type | Required | Constraints | Description |
|---|
answerEngine | object | Yes | | |
Properties of answerEngine| Property | Type | Required | Constraints | Description |
|---|
assistantId | integer | Yes | | ID of the assistant to use for generating answers | maxConcurrentCalls | integer | No | default: 4 | Maximum number of concurrent calls to the assistant | |
contents | string | Yes | | YAML configuration for report sections including entities and queries |
description | string | No | | Description of the scheduled report |
directDestination | array<object> | No | | Direct rooms to send the report to (required for Direct assistants) |
Properties of directDestination| Property | Type | Required | Constraints | Description |
|---|
id | string | Yes | | Direct room ID | |
enabled | boolean | No | default: true | Whether the scheduled report is enabled |
projectId | integer | Yes | | ID of the project this report belongs to |
reportSchedule | object | Yes | | |
Properties of reportSchedule| Property | Type | Required | Constraints | Description |
|---|
expression | string | Yes | | Schedule expression (e.g., cron expression) | timeZone | string | No | | Timezone for the schedule | type | string | Yes | | Type of schedule (e.g., cron) | |
slackDestination | array<object> | No | | Slack channels to send the report to (required for Slack assistants) |
Properties of slackDestination| Property | Type | Required | Constraints | Description |
|---|
id | string | Yes | | Slack channel ID | |
teamsDestination | array<object> | No | | MS Teams channels to send the report to (required for MS Teams assistants) |
Properties of teamsDestination| Property | Type | Required | Constraints | Description |
|---|
id | string | Yes | | MS Teams channel ID | |
title | string | Yes | | Title of the scheduled report |
createScheduledReport — 201 response
New scheduled report successfully created.
| Property | Type | Required | Constraints | Description |
|---|
answerEngine | object | Yes | | |
Properties of answerEngine| Property | Type | Required | Constraints | Description |
|---|
assistantId | integer | Yes | | ID of the assistant to use for generating answers | maxConcurrentCalls | integer | No | default: 4 | Maximum number of concurrent calls to the assistant | |
contents | string | Yes | | YAML configuration for report sections |
creationTime | string | No | format: date-time | When the report was created |
description | string | No | | Description of the scheduled report |
directDestination | array<object> | No | | Direct rooms to send the report to |
Properties of directDestination| Property | Type | Required | Constraints | Description |
|---|
id | string | Yes | | Direct room ID | name | string | No | | Direct room name | |
enabled | boolean | No | | Whether the scheduled report is enabled |
id | integer | Yes | | Unique identifier for the scheduled report |
projectId | integer | Yes | | ID of the project this report belongs to |
reportSchedule | object | Yes | | |
Properties of reportSchedule| Property | Type | Required | Constraints | Description |
|---|
expression | string | Yes | | Schedule expression (e.g., cron expression) | timeZone | string | No | | Timezone for the schedule | type | string | Yes | | Type of schedule (e.g., cron) | |
slackDestination | array<object> | No | | Slack channels to send the report to |
Properties of slackDestination| Property | Type | Required | Constraints | Description |
|---|
id | string | Yes | | Slack channel ID | name | string | No | | Slack channel name | |
teamsDestination | array<object> | No | | MS Teams channels to send the report to |
Properties of teamsDestination| Property | Type | Required | Constraints | Description |
|---|
id | string | Yes | | MS Teams channel ID | name | string | No | | MS Teams channel name | |
title | string | Yes | | Title of the scheduled report |
updateTime | string | No | format: date-time | When the report was last updated |
createScheduledReport — 401 response
Authorization is required to access this resource.
| Property | Type | Required | Constraints | Description |
|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
createScheduledReport — 403 response
Request failed because of invalid data or denied permission.
| Property | Type | Required | Constraints | Description |
|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
createScheduledReport — 429 response
Request failed because of rate limit.
| Property | Type | Required | Constraints | Description |
|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
createScheduledReport — 500 response
An unexpected error has occurred.
| Property | Type | Required | Constraints | Description |
|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
createScheduledReport — 503 response
The service is temporarily unavailable.
| Property | Type | Required | Constraints | Description |
|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
deleteScheduledReport — 401 response
Authorization is required to access this resource.
| Property | Type | Required | Constraints | Description |
|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
deleteScheduledReport — 403 response
Request failed because of invalid data or denied permission.
| Property | Type | Required | Constraints | Description |
|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
deleteScheduledReport — 409 response
The scheduledReport cannot be deleted because it is being used by another part of the system.
| Property | Type | Required | Constraints | Description |
|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
deleteScheduledReport — 429 response
Request failed because of rate limit.
| Property | Type | Required | Constraints | Description |
|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
deleteScheduledReport — 500 response
An unexpected error has occurred.
| Property | Type | Required | Constraints | Description |
|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
deleteScheduledReport — 503 response
The service is temporarily unavailable.
| Property | Type | Required | Constraints | Description |
|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
getScheduledReport — 200 response
Successfully retrieved the specified scheduled report.
| Property | Type | Required | Constraints | Description |
|---|
answerEngine | object | Yes | | |
Properties of answerEngine| Property | Type | Required | Constraints | Description |
|---|
assistantId | integer | Yes | | ID of the assistant to use for generating answers | maxConcurrentCalls | integer | No | default: 4 | Maximum number of concurrent calls to the assistant | |
contents | string | Yes | | YAML configuration for report sections |
creationTime | string | No | format: date-time | When the report was created |
description | string | No | | Description of the scheduled report |
directDestination | array<object> | No | | Direct rooms to send the report to |
Properties of directDestination| Property | Type | Required | Constraints | Description |
|---|
id | string | Yes | | Direct room ID | name | string | No | | Direct room name | |
enabled | boolean | No | | Whether the scheduled report is enabled |
id | integer | Yes | | Unique identifier for the scheduled report |
projectId | integer | Yes | | ID of the project this report belongs to |
reportSchedule | object | Yes | | |
Properties of reportSchedule| Property | Type | Required | Constraints | Description |
|---|
expression | string | Yes | | Schedule expression (e.g., cron expression) | timeZone | string | No | | Timezone for the schedule | type | string | Yes | | Type of schedule (e.g., cron) | |
slackDestination | array<object> | No | | Slack channels to send the report to |
Properties of slackDestination| Property | Type | Required | Constraints | Description |
|---|
id | string | Yes | | Slack channel ID | name | string | No | | Slack channel name | |
teamsDestination | array<object> | No | | MS Teams channels to send the report to |
Properties of teamsDestination| Property | Type | Required | Constraints | Description |
|---|
id | string | Yes | | MS Teams channel ID | name | string | No | | MS Teams channel name | |
title | string | Yes | | Title of the scheduled report |
updateTime | string | No | format: date-time | When the report was last updated |
getScheduledReport — 401 response
Authorization is required to access this resource.
| Property | Type | Required | Constraints | Description |
|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
getScheduledReport — 403 response
Request failed because of denied permission.
| Property | Type | Required | Constraints | Description |
|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
getScheduledReport — 429 response
Request failed because of rate limit.
| Property | Type | Required | Constraints | Description |
|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
getScheduledReport — 500 response
An unexpected error has occurred.
| Property | Type | Required | Constraints | Description |
|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
getScheduledReport — 503 response
The service is temporarily unavailable.
| Property | Type | Required | Constraints | Description |
|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
updateScheduledReport — request
Request body for Update a scheduled report.
| Property | Type | Required | Constraints | Description |
|---|
contents | string | No | | YAML configuration for report sections including entities and queries |
description | string | No | | Description of the scheduled report |
directDestination | array<object> | No | | Direct rooms to send the report to |
Properties of directDestination| Property | Type | Required | Constraints | Description |
|---|
id | string | Yes | | Direct room ID | |
enabled | boolean | No | | Whether the scheduled report is enabled |
reportSchedule | object | No | | |
Properties of reportSchedule| Property | Type | Required | Constraints | Description |
|---|
expression | string | No | | Schedule expression (e.g., cron expression) | timeZone | string | No | | Timezone for the schedule | type | string | No | | Type of schedule (e.g., cron) | |
slackDestination | array<object> | No | | Slack channels to send the report to |
Properties of slackDestination| Property | Type | Required | Constraints | Description |
|---|
id | string | Yes | | Slack channel ID | |
teamsDestination | array<object> | No | | MS Teams channels to send the report to |
Properties of teamsDestination| Property | Type | Required | Constraints | Description |
|---|
id | string | Yes | | MS Teams channel ID | |
title | string | No | | Title of the scheduled report |
updateScheduledReport — 401 response
Authorization is required to access this resource.
| Property | Type | Required | Constraints | Description |
|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
updateScheduledReport — 429 response
Request failed because of rate limit.
| Property | Type | Required | Constraints | Description |
|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
updateScheduledReport — 500 response
An unexpected error has occurred.
| Property | Type | Required | Constraints | Description |
|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
updateScheduledReport — 503 response
The service is temporarily unavailable.
| Property | Type | Required | Constraints | Description |
|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |