Details
-
Type:
Sub-task
-
Status: Done
-
Priority:
L3 - Default
-
Resolution: Done
-
Affects Version/s: None
-
Fix Version/s: 3.1.0-alpha2, 3.1.0
-
Component/s: None
-
Labels:
-
Effort:Not defined
Description
An endpoint exists that returns the values of a given variable name/type combination across the report IDs specified. API proposal below.
ATs:
- a new endpoint returns the values for a given variable name/type combination across the report IDs specified
- API documentation updated
POST /api/variables/reports/values
Request Payload:
{
"reportIds": ["reportId1", "reportId2", ...], // (required)
"name": "variableName", // (required)
"type": "variableType", // (required)
"valueFilter": "val", // returns only those string values that contain the given value. Applies only for type 'string'. Filter is case insensitive.
"resultOffset": 20,
"numResults": 20,
}
Response:
[ 'value 1', // sorted alphabetically 'value 2', ... ]