POST api/reportserver/v3/documents

Creates a new document and starts generating it.

Request Information

URI Parameters

None.

Body Parameters

CreateDocumentData

Name	Description	Type	Additional information
ReportId	Specifies the ID of the report which should be rendered.	string	Required
Format	Specifies the document format in which the report should be rendered.	string	Required
DeviceInfo	Specifies the device information settings.	Dictionary of string [key] and Object [value]	None.
ParameterValues	Specifies the actual values of the report parameters that will be used during the report rendering.	Dictionary of string [key] and Object [value]	None.

Request body formats

application/json, text/json, application/*+json

json

{
  "ReportId": "12df583b071",
  "Format": "Pdf",
  "DeviceInfo": {
    "Device Info 755": "North America",
    "Device Info 757": true
  },
  "ParameterValues": {
    "OrderDate": "2024-01-15",
    "Region": "North America"
  }
}

Response Information

Resource Description

DocumentProcessingStatus

Name	Description	Type	Additional information
Id	Gets or sets the document ID.	string	None.
Status	Gets or sets the processing status, e.g. "processing".	string	None.

Response Formats

application/json

json

{
  "Id": "fb1e3b6f526",
  "Status": "Status 775"
}