ProReport - Get report specification

API Url

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

Permissions: user

Request headers

Path parameters

Success 200

Success example:

HTTP/1.1 200 OK
 {
    "response": {
        "data": {
            "reports": {
                "id": "Absence01",
                "parentId": "",
                "definition": {
                    "name": "Absence rules on totals 120 days",
                    "description": "Shows absence where the total days in the period is 120 or more",
                    "pageName": "Absence rules on totals 120 days",
                    "pageText": "Shows absence where the total days in the period is 120 or more",
                    "reportName": "",
                    "reportText": "",
                    "transactionId": "",
                    "type": 0
                },
                "groups": [
                    {
                        "id": 1,
                        "description": "Current department ID,Current department description",
                        "textId": "ttAbsIntv.DeptId,ttAbsIntv.DeptDescription",
                        "textType": "DB",
                        "calculation": "SUM",
                        "display": true
                    },
                    {
                        "id": 2,
                        "description": "Employee number",
                        "textId": "EMPLOYEE NUMBER",
                        "textType": "SortEmp",
                        "calculation": "SUM",
                        "display": true
                    }
                ],
                "maxGroups": 5,
                "layout": {
                    "columns": [
                        {
                            "id": 1,
                            "text": "No. of days",
                            "format": "202",
                            "formula": "$"
                        }
                    ],
                    "onlyShowCalc": "",
                    "onlyShowDetails": "",
                    "displayDetails": true,
                    "showCertifLine": false,
                    "showLogo": true,
                    "showPageNumber": true,
                    "showPhDate": true,
                    "col1": "Period start",
                    "col2": "Period end",
                    "footerCalculation": "SUM"
                },
                "attributes": [
                    {
                        "id": "DayLimitMethod",
                        "description": "Specify day count limit check",
                        "value": ">",
                        "readOnly": true,
                        "type": 4,
                        "options": [
                            {
                                "value": 1,
                                "description": "<"
                            },
                            {
                                "value": 2,
                                "description": "="
                            },
                            {
                                "value": 3,
                                "description": ">"
                            }
                        ]
                    },
                    {
                        "id": "DayLimit",
                        "description": "Day count limit",
                        "value": "119",
                        "readOnly": true,
                        "type": 2
                    },
                    {
                        "id": "OnlyOpenEndedPer",
                        "description": "Only open ended period",
                        "value": "false",
                        "readOnly": true,
                        "type": 1
                    },
                    {
                        "id": "InclOffDays",
                        "description": "Include off-days",
                        "value": "true",
                        "readOnly": true,
                        "type": 1
                    },
                    {
                        "id": "SepAbsIntv",
                        "description": "Check individual intervals",
                        "value": "FALSE",
                        "readOnly": true,
                        "type": 1
                    },
                    {
                        "id": "ExtAbsIntvBefore",
                        "description": "Extend interval back in time",
                        "value": "FALSE",
                        "readOnly": true,
                        "type": 1
                    },
                    {
                        "id": "ExtAbsIntvAfter",
                        "description": "Extend interval forward in time",
                        "value": "FALSE",
                        "readOnly": true,
                        "type": 1
                    }
                ]
            }
        }
    }
}

Error 4xx