ProReport - Download report

API Url

Used for downloading a report in the specified format.

GET

http://localhost:16010/ProMarkREST/rest/ProReport/repository/{id}/formats/{format}

Permissions: user

Path parameters

Field	Type	Description
format	String	The report format. For now it's only "CSV". Allowed values:`"CSV"`
id	String	Unique identifier of the report instance.

Success 200

Field	Type	Description
response	Object	Main object containing the response data.
fileContent	String	The report content.
fileName	String	Name of the downloaded file.
message`optional`	Object	Object containing response messages.
code	Number	Message code.
text	String	Message text.
type	String	Type of message. Allowed values:`"warning""info"`

Error 4xx

Field	Type	Description
response	Object	Main object containing the response data.
data	Object	Object containing the requested data (empty).
errorCode	Number	Error code.
errorMessage	String	Error description.

Error example:

HTTP/1.1 404 Not found
{
   "response": {
      "fileName": "",
      "fileContent: "",
      "errorCode": 285,
      "errorMessage": "The report could not be found. Maybe it was deleted by another user."
   }
}