跳转到主要内容
PUT
Error

授权

x-cdata-authtoken
string
header
必填

路径参数

Name
string
必填

The key Name

请求体

application/json

The reports entity to update.

Name
string
必填

The name of the report.

Type
string

The type of report.

CreatedBy
string

The user who created this report.

CreatedTime
string<date-time>

The time when the report was created

ModifiedTime
string<date-time>

The last modified time of the report.

TimePeriod
string

The time period that the report should pull data from. In days.

Columns
string

The columns in the report.

GroupRows
string

The rows to group by in the report.

Filters
string

Any filters that should be used for the report. e.g. ConnectorType=SFTP,FTP;ConnectorId=SFTP1,SFTP2,FTP1,FTP2

Summary
string

Any summary information that should be provided in the generated report.

Schedule
string

The cron schedule to control when the report should run.

StartDate
string<date-time>

The start date.

EndDate
string<date-time>

The end date.

Format
string

The report format.

EmailReport
boolean

Whether or not to send the report via email.

EmailSubject
string

The email subject.

EmailRecipients
string

The email recipients.

TimePeriodStart
string<date-time>

The custom TimePeriod start time.

TimePeriodEnd
string<date-time>

The custom TimePeriod end time.

NextRunTime
string<date-time>

The next scheduled time.

IsRunning
string

Whether the reports is running.

响应

EntitySet reports

Name
string
必填

The name of the report.

Type
string

The type of report.

CreatedBy
string

The user who created this report.

CreatedTime
string<date-time>

The time when the report was created

ModifiedTime
string<date-time>

The last modified time of the report.

TimePeriod
string

The time period that the report should pull data from. In days.

Columns
string

The columns in the report.

GroupRows
string

The rows to group by in the report.

Filters
string

Any filters that should be used for the report. e.g. ConnectorType=SFTP,FTP;ConnectorId=SFTP1,SFTP2,FTP1,FTP2

Summary
string

Any summary information that should be provided in the generated report.

Schedule
string

The cron schedule to control when the report should run.

StartDate
string<date-time>

The start date.

EndDate
string<date-time>

The end date.

Format
string

The report format.

EmailReport
boolean

Whether or not to send the report via email.

EmailSubject
string

The email subject.

EmailRecipients
string

The email recipients.

TimePeriodStart
string<date-time>

The custom TimePeriod start time.

TimePeriodEnd
string<date-time>

The custom TimePeriod end time.

NextRunTime
string<date-time>

The next scheduled time.

IsRunning
string

Whether the reports is running.