ProReport - Edit report specification

API Url

Use it to edit a report specification

POST

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

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.

Parameter

Field	Type	Description
request	Object	Main object containing the request data.
data	Object	Object containg data to be uploaded.
reports	Object[]
attributes`optional`	Object[]	Report dynamic attributes.
description`optional`	string	Attribute description
id	string	Attribute Id
type	Number	attribute type
value	string	Attribute Value
definition	Object	Report definition.
description`optional`	string	Report specification description.
name	string	Report specification name. name.
pageName`optional`	string	Report page name.
pageText`optional`	string	Report page text.
reportName`optional`	string	Report name.
reportText`optional`	string	Report text.
transactionId`optional`	string	Report transaction Id.
type	Number	Report type.
groups	Object[]	Report groups.
calculation	string	Group calculation.
description`optional`	string	Group description.
display	boolean	true - group is visible, false - group is not cisible.
id	Number	Group number.
textId	string	System text id.
textType	string	System text type.
id	string	The id of the report.
layout	Object	Report layout.
col1	string	Col1 label
col2	string	Col2 label
columns	Object[]	Columns object
format	string	Column format
formula	string	Column formula
id	Number	Column id
text	string	Column header
displayDetails	Boolean	TRUE=Show detail lines
footerCalculation	string	footer calculation
onlyShowCalc	String	Comma separated list of columns that will display data only for the group calculation
onlyShowDetails	String	Comma separated list of columns that will display data only for the details section
showLogo	Boolean	TRUE=Show logo on page header
showPageNumber	Boolean	TRUE=Show page number on footer
showPhDate	Boolean	TRUE=Show report execution date
showSignatureSection	Boolean	TRUE=Show section for signature on report footer
parentId	String	The parent id of the report.

Request example:

{
    "request": {
        "data": {
            "reports": {
                "id": "Absence01-01",
                "parentId": "Absence01",
                "definition": {
                    "name": "Absence rules on totals 120 days amttest",
                    "description": "Shows absence where the total days in the period is 120 or more amttest",
                    "pageName": "Absence rules on totals 120 days amttest",
                    "pageText": "Shows absence where the total days in the period is 120 or more amt test",
                    "reportName": "",
                    "reportText": "",
                    "transactionId": "",
                    "type": 0
                },
                "groups": [
                    {
                        "id": 1,
                        "description": "Current department ID,Current department description",
                        "textId": "ttAbsIntv.DeptId,ttAbsIntv.DeptDescription",
                        "textType": "Other",
                        "calculation": "SUM",
                        "display": true
                    },
                    {
                        "id": 2,
                        "description": "Age",
                        "textId": "AGE",
                        "textType": "SortEmp",
                        "calculation": "SUM",
                        "display": true
                    }
                ],
                "layout": {
                    "columns": [
                        {
                            "id": 1,
                            "text": "No. of dayss",
                            "format": "202",
                            "formula": "$"
                        }
                    ],
                    "onlyShowCalc": "",
                    "onlyShowDetails": "",
                    "displayDetails": true,
                    "showSignatureSection": 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": "3",
                        "readOnly": true,
                        "type": 4,
                        "options": [
                            {
                                "value": 1,
                                "description": "<"
                            },
                            {
                                "value": 2,
                                "description": "="
                            },
                            {
                                "value": 3,
                                "description": ">"
                            }
                        ]
                    },
                    {
                        "id": "DayLimit",
                        "description": "Day count limit",
                        "value": "121",
                        "readOnly": true,
                        "type": 2
                    },
                    {
                        "id": "OnlyOpenEndedPer",
                        "description": "Only open ended period",
                        "value": "true",
                        "readOnly": true,
                        "type": 1
                    },
                    {
                        "id": "InclOffDays",
                        "description": "Include off-days",
                        "value": "true",
                        "readOnly": true,
                        "type": 1
                    },
                    {
                        "id": "SepAbsIntv",
                        "description": "Check individual intervals",
                        "value": "true",
                        "readOnly": true,
                        "type": 1
                    },
                    {
                        "id": "ExtAbsIntvBefore",
                        "description": "Extend interval back in time",
                        "value": "true",
                        "readOnly": true,
                        "type": 1
                    },
                    {
                        "id": "ExtAbsIntvAfter",
                        "description": "Extend interval forward in time",
                        "value": "true",
                        "readOnly": true,
                        "type": 1
                    }
                ]
            }
        }
    }
}

Success 200

Field	Type	Description
response	Object	Main object containing the response data.
message`optional`	Object	Object containing response messages.
code	Number	Message code.
text	String	Message text.
type	String	Type of message. Allowed values:`"warning""info"`

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.