GET api/reportserver/scheduledtasks/{scheduledTaskId}

Returns a scheduled task by ID.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
scheduledTaskId

Scheduled task ID.

string

Required

Body Parameters

None.

Response Information

Resource Description

ScheduledTaskV1
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

Specifies the scheduled task name.

string

Required

Enabled

Specifies whether the scheduled task is either enabled or disabled.

boolean

None.

ReportId

Obsolete from R3 2018. Use Reports instead.

string

Required

DocumentFormat

Obsolete from R3 2018. Use Reports instead.

string

Required

Parameters

Obsolete from R3 2018. Use Reports instead.

Dictionary of string [key] and Object [value]

None.

StartDate

Specifies the start date of the scheduled task.

date

None.

RecurrenceRule

Specifies recurrence rule for the scheduled task.

RecurrenceRule

None.

MailSubject

Specifies the mail template subject.

string

None.

MailBody

Specifies the mail template body.

string

None.

ExternalEmails

Specifies 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,
  "ReportId": "sample string 5",
  "DocumentFormat": "sample string 6",
  "Parameters": {
    "sample string 1": {},
    "sample string 3": {}
  },
  "StartDate": "2021-07-16T13:21:48.9120657+03:00",
  "RecurrenceRule": null,
  "MailSubject": "sample string 8",
  "MailBody": "sample string 9",
  "ExternalEmails": [
    "sample string 1",
    "sample string 2"
  ],
  "SubscriberIds": [
    "sample string 1",
    "sample string 2"
  ]
}
In this article
Not finding the help you need?