ProReport - Download report

API Url

Used for downloading a report in the specified format.

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

Permissions: user

Request headers

FieldTypeDescription
Accept-LanguageoptionalString

=en-GB Language use for localization.

X-ClientoptionalString

=Client type.

Allowed values:"Portal""Mobile""Admin"
X-RoleoptionalNumber

ProMark role (1: Employee, 2: User).

Allowed values:{12}
X-WebPart-IdoptionalNumber

Unique web-part identifier.

Path parameters

FieldTypeDescription
formatString

The report format. For now it's only "CSV".

Allowed values:"CSV"
idString

Unique identifier of the report instance.

Error 4xx

FieldTypeDescription
responseObject

Main object containing the response data.

  dataObject

Object containing the requested data (empty).

  errorCodeNumber

Error code.

  errorMessageString

Error description.

Error example:

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