GET api/reportserver/executions/dataalerts/documents/{documentId}

Returns a data alert document by ID.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
documentId

Scheduled document ID.

string

Required

Body Parameters

None.

Response Information

Resource Description

ScheduledDocument
NameDescriptionTypeAdditional information
Id

Scheduled document ID.

string

None.

TaskId

Scheduled task or data alert ID.

string

None.

DocumentName

Document name.

string

None.

DocumentFormat

Document format.

string

None.

Data

Document binary data.

Collection of byte

None.

MimeType

File type.

string

None.

DateCreated

Obsolete since R2 2020. Use DateCreatedUtc property instead. The DateTime created value in the server local timezone.

date

None.

DateCreatedUtc

The DateTime created value in the UTC.

date

None.

ReportId

Report ID.

string

None.

Error

Contains any errors which might occur during document creation.

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Id": "sample string 1",
  "TaskId": "sample string 2",
  "DocumentName": "sample string 3",
  "DocumentFormat": "sample string 4",
  "Data": "QEA=",
  "MimeType": "sample string 5",
  "DateCreated": "2024-09-25T15:11:30.9951583+00:00",
  "DateCreatedUtc": "2024-09-25T15:11:30.9951583+00:00",
  "ReportId": "sample string 8",
  "Error": "sample string 9"
}
In this article
Not finding the help you need?