ProReport - Get report instance

API Url

Use it for loading a specific report instances that were saved in the repository.

GET

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

Permissions: user

Path parameters

Field	Type	Description
id	String	Unique identifier of the report instance.

Success 200

Field	Type	Description
response	Object	Main object containing the response data.
data	Object	Object containing the requested data.
savedReports	Object[]	Object with all saved report instances.
canEdit	Boolean	True = Logged in user can change the report.
canRender	Boolean	Indicates whether the report can be rendered. This value is always false for Excel export and Predefined host transaction report types. For standard reports, it is false if the report exceeds the size limit.
desc	String	Description of the report instance.
expiry	Date	Date when report will stop being available in the repository.
fileId	String	Unique identifier of the report files. Needed when opening reports.
id	String	Unique identifier of the report instance.
owner	String	Report creator's user id.
parentId	String	Unique identifier of the report used when running this instance.
private	Boolean	Report's security status.
recurrent	Boolean	true=Report is part of a recurrence series.
reportType	String	Report type (0=Classic report, 1=Excel report, 2=Host report).
runTime	Datetime	Date and time when report was executed. If 'null', the report was not yet executed (delayed execution).
sharedWith`optional`	String	Available only for owner. A list of users ids of users that have access to the report.
message`optional`	Object	Object containing response messages.
code	Number	Message code.
text	String	Message text.
type	String	Type of message. Allowed values:`"warning""info"`

Success example:

HTTP/1.1 200 OK
{
   "response": {
      "data": {
         "savedReports": [
            {
               "id": "Rep10000",
               "desc": "Absence rules on totals 120 days",
               "runTime": null,
               "expiry": "2016-11-30",
               "fileId": "",
               "recurrent": true,
               "parentId": "Absence01",
               "reportType": 0,
               "owner": "MGR",
               "canEdit": true,
               "private": true
            }
         ]
      },
      "errorCode": 0,
      "errorMessage": ""
   }
}

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": {
      "errorCode": 285,
      "errorMessage": "The report was not found. Maybe it was deleted by another user."
   }
}