ProReport - Get report

API Url

Used for loading a specific report that can be executed.

GET

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

Permissions: user

Path parameters

Field	Type	Description
id	String	Report unique identifier.

Success 200

Field	Type	Description
response	Object	Main object containing the response data.
data	Object	Object containing the requested data.
reports	Object[]	Collection of reports.
categoryId	String	The id of the report category. Used to group reports together.
favorite	Boolean	true=This is a favorite report.
id	String	Report unique identifier.
name	String	Name of the report.
parentId	String	Unique identifier of the parent report that was used for creating this custom report. Only when standard = false.
standard	Boolean	true=Standard report, false=Custom report.
type	Number	Report type (0=Classic report, 1=Excel report, 3=Host report). Size range: `0-3`
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": {
         "reports": [
            {
               "id": "Absence01",
               "name": "Absence rules on totals 120 days",
               "categoryId": "1",
               "type": 0,
               "favorite": false,
               "standard": true,
               "parentId": ""
            }
         ]
      },
      "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.