ProReport - Get report group list

API Url

Use it to get report group list.

GET

http://localhost:16010/ProMarkREST/web/ProReport/reports/{id}/groups

Permissions: user

Request headers

Field	Type	Description
Accept-Language`optional`	String	=en-GB Language use for localization.
X-Client`optional`	String	=Client type. Allowed values:`"Portal""Mobile""Admin"`
X-Role`optional`	Number	ProMark role (1: Employee, 2: User). Allowed values:`{12}`
X-WebPart-Id`optional`	Number	Unique web-part identifier.

Path parameters

Field	Type	Description
id	String	Report id/parent id.

Success 200

Field	Type	Description
response	Object	Main object containing the response data.
data	Object[]
groups	Object[]
description	Object	Group description.
textId	string	Text id from systext.
textType	String	Text type from systext.
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": {
           "groups": [
               {
                   "textId": "ttAbsIntv.DeptId,ttAbsIntv.DeptDescription",
                   "textType": "Other",
                   "description": "Current department ID,Current department description"
               },
               {
                   "textId": "AGE",
                   "textType": "SortEmp",
                   "description": "Age"
               },
               {
                   "textId": "APPROVAL GROUP",
                   "textType": "SortEmp",
                   "description": "Approval Group"
               },
               {
                   "textId": "ATTENDANCE PROFILE",
                   "textType": "SortEmp",
                   "description": "Attendance profile"
               },
               {
                   "textId": "CATEGORY",
                   "textType": "SortEmp",
                   "description": "Category"
               },
               {
                   "textId": "CURRENT DEPARTMENT",
                   "textType": "SortEmp",
                   "description": "Current Department"
               },
               {
                   "textId": "CURRENT GROUP",
                   "textType": "SortEmp",
                   "description": "Current Group"
               },
               {
                   "textId": "DIVISION",
                   "textType": "SortEmp",
                   "description": "Division"
               },
               {
                   "textId": "EDUCATION",
                   "textType": "SortEmp",
                   "description": "Education"
               }
           ]
       }
   }
}

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.