Table of Contents
...
Column Name | Type | Description |
---|---|---|
ParameterId | string | This id each entry. |
ReportTemplateId | int | The id of the Report Template where this parameter belongs. |
ParameterOrdinal | int | The order of this parameter in the generated form. |
ParameterLabel | string | The user-friendly label that should be displayed in the UI when the template's parameters form is displayed. |
ParameterName | string | The name of the parameter (this parameter is not currently being used). |
ParameterType | ENUM | Possible values: ['text', 'number', 'date', 'label', 'datetime-local', 'organization-combobox', 'facility-combobox', 'workspace-combobox'] |
ParameterURL | string | The identifier of this parameter in Spago BI. |
Nullable | boolean | Indicates whether this parameter is nullable or not. |
The supported parameter types are basically the same as in SurveyQuestions.AnswerType (From the Surveys API) with the addition of:
- organization-combobox: this type will generate a combobox widget with all the Organizations where the User has LIST_PATIENTS_* permissions.
- facility-combobox: this type will generate a combobox widget with all the Facilities where the User has LIST_PATIENTS_* permissions. If a parameter of this type is specified, then a parameter with type organization-combobox must be also configured. The generated widget will filter the available Facilities according to the Organization selected in the Organization's combobox.
- workspace-combobox: this type will generate a combobox widget with all the Workspaces where the User has LIST_PATIENTS_* permissions. If a parameter of this type is specified, then a parameter with type facility-combobox must be also configured. The generated widget will filter the available Workspaces according to the Facility selected in the Facilities' combobox.
API
List Report Templates
Current Implementation
...
Name | Type | Mandatory | Description |
---|---|---|---|
token | String | Yes | Security Token obtained before. |
userId | String | Yes | The id of the logged in user. |
reportTemplateId | String | Yes | The Id of the Report Template to be executed. |
<report-specific-parameters> | N/A | No | Each specific Report Template has a set of parameters (mandatory or not) that must be present in the request. |
...