POST api/reportserver/v2/scheduledtasks

Creates a new scheduled task.

Request Information

URI Parameters

None.

Body Parameters

Scheduled task model.

ScheduledTaskCreateData
NameDescriptionTypeAdditional 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

Sample:
{
  "Name": "sample string 1",
  "Enabled": true,
  "Reports": [
    {
      "ReportId": "sample string 1",
      "DocumentFormat": "sample string 2",
      "Parameters": {
        "sample string 1": {},
        "sample string 3": {}
      }
    },
    {
      "ReportId": "sample string 1",
      "DocumentFormat": "sample string 2",
      "Parameters": {
        "sample string 1": {},
        "sample string 3": {}
      }
    }
  ],
  "StartDate": "2024-03-20T10:06:33.7765727+00:00",
  "StartDateUtc": "2024-03-20T10:06:33.7765727+00:00",
  "BaseUtcOffset": 5.1,
  "RecurrenceRule": null,
  "LocalUsersMailTemplate": {
    "Subject": "sample string 1",
    "Body": "sample string 2"
  },
  "ExternalUsersMailTemplate": {
    "Subject": "sample string 1",
    "Body": "sample string 2"
  },
  "ExternalEmails": [
    "sample string 1",
    "sample string 2"
  ],
  "SubscriberIds": [
    "sample string 1",
    "sample string 2"
  ]
}

Response Information

Resource Description

ScheduledTask
NameDescriptionTypeAdditional 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

Sample:
{
  "Id": "sample string 1",
  "UserId": "sample string 2",
  "Name": "sample string 3",
  "Enabled": true,
  "Reports": [
    {
      "ReportId": "sample string 1",
      "DocumentFormat": "sample string 2",
      "Parameters": {
        "sample string 1": {},
        "sample string 3": {}
      }
    },
    {
      "ReportId": "sample string 1",
      "DocumentFormat": "sample string 2",
      "Parameters": {
        "sample string 1": {},
        "sample string 3": {}
      }
    }
  ],
  "StartDate": "2024-03-20T10:06:33.7765727+00:00",
  "StartDateUtc": "2024-03-20T10:06:33.7765727+00:00",
  "BaseUtcOffset": 7.1,
  "RecurrenceRule": null,
  "LocalUsersMailTemplate": {
    "Subject": "sample string 1",
    "Body": "sample string 2"
  },
  "ExternalUsersMailTemplate": {
    "Subject": "sample string 1",
    "Body": "sample string 2"
  },
  "ExternalEmails": [
    "sample string 1",
    "sample string 2"
  ],
  "SubscriberIds": [
    "sample string 1",
    "sample string 2"
  ]
}
In this article
Not finding the help you need?