DESCRIPTION
This endpoint edits an existing report. To understand the data parameter further, try creating a report in the UI first and then use the report settings route to retrive the "data" settings.
URL STRUCTURE
https://[hostname]/report/edit/{reportId}METHOD
POST
HEADERS
**Authorization:** string Base64 [email]:[key]
ARGUMENTS
| Name | Type | Description |
|---|---|---|
| reportId | int | Report ID to return |
PARAMETERS
| Name | Type | Description |
|---|---|---|
| name | string | Name for the report. |
| data | array | JSON array of report details.{
"columns": [
"tm.mattercode",
"tm.country",
"tmstat.description",
"tcc.country",
"tmh1.date",
"tmh1.country",
"tmh1.code",
"tmh2.date"
],
"filters": [{
"values": [
["allopen"]
],
"firstcol": [
"tmstat.description"
],
"operator": [
"="
]
}],
"options":[],
"groups":[],
"orders":{
"column": [
"tm.mattercode",
"tmstat.description"
],
"direction": [
"ASC",
"ASC"
]
},
"as": [
"Case Code",
"Country Code",
"Status",
"Category",
"Sub Category",
"Country Name",
"Priority Date",
"Priority Country",
"Priority Number",
"Filing Date"
]
} |
| description | string | Short description of report. |
| canBeSaved | bool (1 or 0) | Should the save button show for the report in the UI (defaults to 1). |
| editable | bool (1 or 0) | Can the report be edited in the UI (defaults to 1). |
| usedForWidgets | bool (1 or 0) | Should the report be exclusive to widgets (defaults to 0). |
| user | int | Internal ID of user the report will be saved against (defaults to current user). |
RETURNS
Returns the new report ID.
[ "reportId": 123 ]
A 405 error will be returned if "editable" is set to false on the report.