New to Telerik Report Server? Start a free 30-day trial

POST api/reportserver/v2/scheduledtasks

Creates a new scheduled task.

Request Information

URI Parameters

None.

Body Parameters

Scheduled task model.

Name	Description	Type	Additional information
Name	Gets or sets the scheduled task name.	string	Required
Enabled	Gets or sets whether the scheduled task is either enabled or disabled.	boolean	None.
Reports	Gets or sets the reports which are rendered by the scheduled task.	Collection of ScheduledTaskReport	Required
StartDate	Obsolete since R2 2020. Use StartDateUtc property instead. Gets or sets the start date of the scheduled task in the author local time zone.	date	None.
StartDateUtc	Gets or sets the start date of the scheduled task in UTC.	date	None.
BaseUtcOffset	Gets or sets the UTC offset to the local timezone of the scheduled task author. Used for the mail templates date time type tokens.	decimal number	None.
RecurrenceRule	Gets or sets recurrence rule for the scheduled task.	RecurrenceRule	None.
LocalUsersMailTemplate	Gets or sets the mail template for local users. Set to null to use the default template.	TaskMailTemplateModel	None.
ExternalUsersMailTemplate	Gets or sets the mail template for external users. Set to null to use the default template.	TaskMailTemplateModel	None.
ExternalEmails	Gets or sets the emails of the external users to whom the report document should be sent.	Collection of string	None.
SubscriberIds	Provides a list of IDs of the users subscribed to the data alert.	Collection of string	None.

Request body formats

application/json, text/json

json

{
  "Name": "HR Reports",
  "Enabled": true,
  "Reports": [
    {
      "ReportId": "266821c71d4",
      "DocumentFormat": "Pdf",
      "Parameters": {
        "IsActive": true,
        "OrderDate": "2024-01-15"
      }
    },
    {
      "ReportId": "61c72434948",
      "DocumentFormat": "Pdf",
      "Parameters": {
        "IsActive": true,
        "OrderDate": "2024-01-15"
      }
    }
  ],
  "StartDate": "2026-08-12T14:15:53.3427051+00:00",
  "StartDateUtc": "2026-08-12T14:15:53.3427051Z",
  "BaseUtcOffset": 1854.1,
  "RecurrenceRule": null,
  "LocalUsersMailTemplate": {
    "Subject": "Your scheduled report is ready",
    "Body": "The report you subscribed to has been generated and is attached to this email."
  },
  "ExternalUsersMailTemplate": {
    "Subject": "Your scheduled report is ready",
    "Body": "The report you subscribed to has been generated and is attached to this email."
  },
  "ExternalEmails": [
    "john.smith@example.com",
    "maria.garcia@example.com"
  ],
  "SubscriberIds": [
    "741dfd0b85d04764a8c6e826b5c09e80",
    "2af391b9e556456b94689013caf41dba"
  ]
}

Response Information

Resource Description

ScheduledTask

Name	Description	Type	Additional information
Id	Provides the scheduled task identifier.	string	Required
UserId	Specifies the ID of the user who has created the scheduled task.	string	None.
Name	Gets or sets the scheduled task name.	string	Required
Enabled	Gets or sets whether the scheduled task is either enabled or disabled.	boolean	None.
Reports	Gets or sets the reports which are rendered by the scheduled task.	Collection of ScheduledTaskReport	Required
StartDate	Obsolete since R2 2020. Use StartDateUtc property instead. Gets or sets the start date of the scheduled task in the author local time zone.	date	None.
StartDateUtc	Gets or sets the start date of the scheduled task in UTC.	date	None.
BaseUtcOffset	Gets or sets the UTC offset to the local timezone of the scheduled task author. Used for the mail templates date time type tokens.	decimal number	None.
RecurrenceRule	Gets or sets recurrence rule for the scheduled task.	RecurrenceRule	None.
LocalUsersMailTemplate	Gets or sets the mail template for local users. Set to null to use the default template.	TaskMailTemplateModel	None.
ExternalUsersMailTemplate	Gets or sets the mail template for external users. Set to null to use the default template.	TaskMailTemplateModel	None.
ExternalEmails	Gets or sets the emails of the external users to whom the report document should be sent.	Collection of string	None.
SubscriberIds	Provides a list of IDs of the users subscribed to the data alert.	Collection of string	None.

Response Formats

application/json, text/json

json

{
  "Id": "c6df9fa39a5",
  "UserId": "50b3d67c1ee94e79bb7bf47d6d421aaf",
  "Name": "HR Reports",
  "Enabled": true,
  "Reports": [
    {
      "ReportId": "266821c71d4",
      "DocumentFormat": "Pdf",
      "Parameters": {
        "IsActive": true,
        "OrderDate": "2024-01-15"
      }
    },
    {
      "ReportId": "61c72434948",
      "DocumentFormat": "Pdf",
      "Parameters": {
        "IsActive": true,
        "OrderDate": "2024-01-15"
      }
    }
  ],
  "StartDate": "2026-08-12T14:15:53.3427051+00:00",
  "StartDateUtc": "2026-08-12T14:15:53.3427051Z",
  "BaseUtcOffset": 1854.1,
  "RecurrenceRule": null,
  "LocalUsersMailTemplate": {
    "Subject": "Your scheduled report is ready",
    "Body": "The report you subscribed to has been generated and is attached to this email."
  },
  "ExternalUsersMailTemplate": {
    "Subject": "Your scheduled report is ready",
    "Body": "The report you subscribed to has been generated and is attached to this email."
  },
  "ExternalEmails": [
    "john.smith@example.com",
    "maria.garcia@example.com"
  ],
  "SubscriberIds": [
    "741dfd0b85d04764a8c6e826b5c09e80",
    "2af391b9e556456b94689013caf41dba"
  ]
}