ProReport - Get export options

API Url

Used to get export options.

GET
http://localhost:16010/ProMarkREST/rest/ProReport/repository/{id}/export

Permissions: user

Path parameters

FieldTypeDescription
idString

Unique identifier of the report instance.

Parameter

FieldTypeDescription
requestObject

Main object containing the request data.

  dataObject

Object containg data to be uploaded.

Success 200

FieldTypeDescription
responseObject

Main object containing the response data.

    exportObject[]

Collection of export.

      formatString

Export document format (0=None, 14=Word, 31=PDF, 901=CSV).

      saveToString

Location on disk where export file can be saved. This needs to be accessible to the reporting server! Only when 'format' > 0.

      sendToString

List of e-mails to send report to. Only when 'format' > 0.

  messageoptionalObject

Object containing response messages.

    codeNumber

Message code.

    textString

Message text.

    typeString

Type of message.

Allowed values:"warning""info"

Error 4xx

FieldTypeDescription
responseObject

Main object containing the response data.

  errorCodeNumber

Error code.

  errorMessageString

Error description.

Error example:

HTTP/1.1 200 OK
{
"response": {
"data": {
"export": [
{
"format": 14,
"sendTo": "amt@mark-info.com",
"saveTo": ""
}
]
},
"errorCode": 0,
"errorMessage": ""
}
}