DESCRIPTION
This endpoint returns the settings that make up a report. This will be useful to learn how to create new reports via the API by studing the output of this endpoint for existing reports.
URL STRUCTURE
https://[hostname]/report/settings/{reportId}METHOD
GET
HEADERS
**Authorization:** string Base64 [email]:[key]
ARGUMENTS
| Name | Type | Description |
|---|---|---|
| reportId | int | Report ID to return |
RETURNS
| Code | Message | Status |
| 200 | Report settings as json (example below) | Success |
| 400 | Non numeric id | Failure |
| 404 | Report not found | Failure |
| 500 | Error message | Failure |
Example report settings:
{
"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"
]
}