List Report Templates

Current Implementation

Reports are assigned to User's roles. This operation returns the list of Report Templates (and their parameters) that are available to the user that is invoking it.

Parameters

Base URL: /listReportTemplates

Parameters:

Name	Type	Mandatory	Description
token	String	Yes	Security Token obtained before.
userId	String	Yes	The id of the logged in user.

API Sample

http://localhost:8080/PresentationServices/listReportTemplates?token=8ea54194-b1c6-42af-adab-2de7f315e52b&userId=sigal

...

language	js
title	Result
linenumbers	true
collapse	true

...

Design and Configuration

The Report capabilities of Presentation Services is currently using SpagoBI as reporting service. The code was designed having multiple reporting services in mind, but it is still coupled to Spago.

The generic interface to communicate with an external Reporting Server is org.socraticgrid.report.api.ReportServiceIFace. The concrete implementation being used in runtime can be configured using spring in the file kmrReports.xml located in PresentationService's configuration directory.
Currently, there is only 1 implementation of this interface called com.cognitivemedicine.report.service.ReportServiceImpl. This implementation is not part of PresentationServices code.

The configuration of the available reports is done using 3 different tables: ReportTemplates, ReportParameters and ReportRoles.

ReportTemplates Table

This table contains the list of all available reports in the system. This table is still tightly-coupled to Spago.

Column Name	Type	Description
ReportTemplateId	integer	This id the auto-generated id of each entry.
Name	string	The user-friendly name of the report.
SpagoId	string	The id of the report template in Spago server.
SpagoName	string	The id of the report template in Spago server.
CreatedBy	string	Name of the creator of the report. (This field is not related in any way to Users table. Its value is only descriptive)
Type	string	The type of the report as stated by Spago specifications.
DatasetId	integer	The id of the dataset of this report in Spago.
EngineId	integer	The Engine id of the report as stated by Spago specifications.

ReportParameters Table

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

Reports are assigned to User's roles. This operation returns the list of Report Templates (and their parameters) that are available to the user that is invoking it.

Parameters

Base URL: /listReportTemplates

Parameters:

Name	Type	Mandatory	Description
token	String	Yes	Security Token obtained before.
userId	String	Yes	The id of the logged in user.

API Sample

http://localhost:8080/PresentationServices/listReportTemplates?token=8ea54194-b1c6-42af-adab-2de7f315e52b&userId=sigal

Code Block

language	js
title	Result
linenumbers	true
collapse	true

{ "data" : [ { "name" : "All Patients",
"parametersForm" : { "canSaveDraft" : false,
"chartId" : null,
"createDate" : null,
"dirty" : false,
"exitOnEmpty" : false,
"groupName" : null,
"hasDetails" : false,
"interactive" : false,
"language" : null,
"name" : null,
"patientId" : null,
"patientSurveyId" : null,
"position" : null,
"surveyClass" : null,
"surveyId" : "1",
"surveyQuestions" : [ { "answerType" : "date",
"currentAnswer" : null,
"displayWhen" : null,
"groupAnswers" : null,
"itemId" : "p1",
"oid" : 0,
"position" : 0,
"possibleAnswers" : [ ],
"preLabel" : "From",
"query" : null,
"questionName" : "startDate",
"required" : false,
"splitDisplay" : null,
"style" : null,
"suggestedControl" : "text",
"surveyId" : 0,
"updateBy" : null,
"updateDate" : null,
"updateWith" : null,
"validation" : null
},
{ "answerType" : "text",
"currentAnswer" : "UNC",
"displayWhen" : null,
"groupAnswers" : null,
"itemId" : "organizationid",
"oid" : 0,
"position" : -3,
"possibleAnswers" : [ { "action" : null,
"itemId" : "organizationid",
"label" : "UNC",
"oid" : 0,
"position" : 0,
"surveyId" : 0,
"value" : "UNC"
} ],
"preLabel" : "Organization",
"query" : null,
"patientIdquestionName" : null"organizationid",
"patientSurveyIdrequired" : nullfalse,
"positionsplitDisplay" : null,
"surveyClassstyle" : null,
"surveyIdsuggestedControl" : "1combobox",
"surveyQuestionssurveyId" : [ {0,
"answerTypeupdateBy" : "date"null,
"currentAnswerupdateDate" : null,
"displayWhenupdateWith" : null,
"groupAnswersvalidation" : null
},
{ "itemIdanswerType" : "p1text",
"oidcurrentAnswer" : 0null,
"positiondisplayWhen" : 0null,
"possibleAnswersgroupAnswers" : [ ]null,
"preLabelitemId" : "Fromfacilityid",
"queryoid" : null0,
"questionNameposition" : "startDate"-2,
"requiredpossibleAnswers" : [ false,{ "splitDisplayaction" : null,
"styleitemId" : null"facilityid",
"suggestedControllabel" : "textNorth Eastern",
"surveyIdoid" : 0,
"updateByposition" : null0,
"updateDatesurveyId" : null0,
"updateWithvalue" : null, "validation" : null[UNC]NorthEastern"
},
{ "answerTypeaction" : "text"null,
"currentAnsweritemId" : "UNCfacilityid",
"displayWhenlabel" : null, "groupAnswersUNC" : null,
"itemIdoid" : "organizationid"0,
"oidposition" : 01,
"positionsurveyId" : -30,
"possibleAnswersvalue" : "[UNC]UNC"
},
{ "action" : null,
"itemId" : "organizationidfacilityid",
"label" : "UNCVidant",
"oid" : 0,
"position" : 02,
"surveyId" : 0,
"value" : "[UNC]Vidant"
}
],
"preLabel" : "OrganizationFacility",
"query" : null"organizationid",
"questionName" : "organizationidfacilityid",
"required" : false,
"splitDisplay" : null,
"style" : null,
"suggestedControl" : "custom_linked_combobox",
"surveyId" : 0,
"updateBy" : null,
"updateDate" : null,
"updateWith" : null,
"validation" : null
},
{ "answerType" : "text",
"currentAnswer" : null,
"updateBydisplayWhen" : null,
"updateDategroupAnswers" : null,
"updateWithitemId" : null"workspaceid",
"validationoid" : null
}0,
{
"answerTypeposition" : "text"-1,
"currentAnswerpossibleAnswers" : [ null,{ "displayWhenaction" : null,
"groupAnswersitemId" : null"workspaceid",
"itemIdlabel" : "facilityidAdults",
"oid" : 0,
"position" : 0,
"surveyId" : -20,
"possibleAnswersvalue" : "[NorthEastern]ne_adult"
},
{ "action" : null,
"itemId" : "facilityidworkspaceid",
"label" : "North EasternNursery",
"oid" : 0,
"position" : 01,
"surveyId" : 0,
"value" : "[UNCNorthEastern]NorthEasternne_nursery"
},
{ "action" : null,
"itemId" : "facilityidworkspaceid",
"label" : "UNCAdults",
"oid" : 0,
"position" : 10,
"surveyId" : 0,
"value" : "[UNC]UNCunc_adult"
},
{ "action" : null,
"itemId" : "facilityidworkspaceid",
"label" : "VidantNursery",
"oid" : 0,
"position" : 21,
"surveyId" : 0,
"value" : "[UNC]Vidantunc_nursery"
}
],
"preLabel" :{ "Facility",
"query"action" : "organizationid"null,
"questionNameitemId" : "facilityidworkspaceid",
"requiredlabel" : false,
"splitDisplayAdults" : null,
"styleoid" : null0,
"suggestedControlposition" : "custom_linked_combobox"0,
"surveyId" : 0,
"updateByvalue" : null, "updateDate[Vidant]vidant_adult"
: null},
"updateWith" : null,{ "validationaction" : null
},
{
"answerTypeitemId" : "textworkspaceid",
"currentAnswerlabel" : null"Nursery",
"displayWhenoid" : null0,
"groupAnswersposition" : null1,
"itemIdsurveyId" : "workspaceid"0,
"oidvalue" : 0, "position[Vidant]vidant_nursery"
:}
-1],
"possibleAnswerspreLabel" : [ { "action"Workspace",
"query" : null"facilityid",
"itemIdquestionName" : "workspaceid",
"labelrequired" : false,
"AdultssplitDisplay" : null,
"oidstyle" : 0null,
"positionsuggestedControl" : 0"custom_linked_combobox",
"surveyId" : 0,
"valueupdateBy" : null,
"[NorthEastern]ne_adultupdateDate" }: null,
{
"actionupdateWith" : null,
"itemIdvalidation" : "workspaceid" null
}
],
"labelupdateDate" : "Nursery"null,
"oidupdateWith" : null
0},
"positionreportTemplateId" : 1
},
{ "surveyIdname" : 0"Facility",
"valueparametersForm" : { "[NorthEastern]ne_nursery"
},
{ "actioncanSaveDraft" : false,
"chartId" : null,
"itemIdcreateDate" : "workspaceid"null,
"labeldirty" : "Adults"false,
"oidexitOnEmpty" : 0false,
"positiongroupName" : 0null,
"surveyIdhasDetails" : 0false,
"valueinteractive" : "[UNC]unc_adult"
},
{ "actionfalse,
"language" : null,
"name" : null,
"itemIdpatientId" : "workspaceid"null,
"labelpatientSurveyId" : "Nursery"null,
"oidposition" : 0null,
"positionsurveyClass" : 1null,
"surveyId" : 0"2",
"valuesurveyQuestions" : "[UNC]unc_nursery" },
{ "actionanswerType" : null"text",
"itemIdcurrentAnswer" : "workspaceidUNC",
"labeldisplayWhen" : null,
"AdultsgroupAnswers" : null,
"oiditemId" : 0"organizationid",
"positionoid" : 0,
"surveyIdposition" : 0-3,
"valuepossibleAnswers" : "[Vidant]vidant_adult"
}, { "action" : null,
"itemId" : "workspaceidorganizationid",
"label" : "NurseryUNC",
"oid" : 0,
"position" : 10,
"surveyId" : 0,
"value" : "[Vidant]vidant_nurseryUNC"
} ],
"preLabel" : "WorkspaceOrganization",
"query" : "facilityid"null,
"questionName" : "workspaceidorganizationid",
"required" : false,
"splitDisplay" : null,
"style" : null,
"suggestedControl" : "custom_linked_combobox",
"surveyId" : 0,
"updateBy" : null,
"updateDate" : null,
"updateWith" : null,
"validation" : null
}
],
"updateDate" : null,
"updateWith" : null
},
"reportTemplateId" : 1
},
{ "nameanswerType" : "Facilitytext",
"parametersFormcurrentAnswer" : { "canSaveDraft" : falsenull,
"chartIddisplayWhen" : null,
"createDategroupAnswers" : null,
"dirtyitemId" : false, "exitOnEmptyfacilityid" : false,
"groupName" : null,
"hasDetailsoid" : false0,
"interactiveposition" : false-2,
"languagepossibleAnswers" : [ null,{ "nameaction" : null,
"patientIditemId" : null"facilityid",
"patientSurveyIdlabel" : null"North Eastern",
"positionoid" : null0,
"surveyClassposition" : null0,
"surveyId" : "2"0,
"surveyQuestionsvalue" : "[UNC]NorthEastern"
},
{ "answerTypeaction" : "text"null,
"currentAnsweritemId" : "UNCfacilityid",
"displayWhenlabel" : null"UNC",
"groupAnswersoid" : null0,
"itemIdposition" : "organizationid"1,
"oidsurveyId" : 0,
"positionvalue" : -3,
"possibleAnswers" : ["[UNC]UNC"
},
{ "action" : null,
"itemId" : "organizationidfacilityid",
"label" : "UNCVidant",
"oid" : 0,
"position" : 02,
"surveyId" : 0,
"value" : "[UNC]Vidant"
}
],
"preLabel" : "OrganizationFacility",
"query" : null"organizationid",
"questionName" : "organizationidfacilityid",
"required" : false,
"splitDisplay" : null,
"style" : null,
"suggestedControl" : "custom_linked_combobox",
"surveyId" : 0,
"updateBy" : null,
"updateDate" : null,
"updateWith" : null,
"validation" : null
},
{ "answerType" : "text",
"currentAnswer" : null,
"displayWhen" : null,
"groupAnswers" : null,
"itemId" : "facilityid",
"oid" : 0,
"position" : -2,
"possibleAnswers" : [ { "action" : null,
"itemId" : "facilityid",
"label" : "North Eastern" null,
"oiditemId" : 0"workspaceid",
"positionoid" : 0,
"surveyIdposition" : 0-1,
"valuepossibleAnswers" : "[UNC]NorthEastern" },
{ "action" : null,
"itemId" : "facilityidworkspaceid",
"label" : "UNCAdults",
"oid" : 0,
"position" : 10,
"surveyId" : 0,
"value" : "[UNCNorthEastern]UNCne_adult"
},
{ "action" : null,
"itemId" : "facilityidworkspaceid",
"label" : "VidantNursery",
"oid" : 0,
"position" : 21,
"surveyId" : 0,
"value" : "[UNC]Vidant"
}
],
"preLabel" : "Facility",
"query" : "organizationid",
"questionName" : "facilityid",
"required" : false,
"splitDisplayNorthEastern]ne_nursery"
},
{ "action" : null,
"styleitemId" : null"workspaceid",
"suggestedControllabel" : "custom_linked_comboboxAdults",
"surveyIdoid" : 0,
"updateByposition" : null0,
"updateDatesurveyId" : null0,
"updateWithvalue" : null,
"validation" : null"[UNC]unc_adult"
},
{ "answerTypeaction" : "text"null,
"currentAnsweritemId" : null"workspaceid",
"displayWhenlabel" : null"Nursery",
"groupAnswersoid" : null0,
"itemIdposition" : "workspaceid"1,
"oidsurveyId" : 0,
"positionvalue" : -1, "possibleAnswers[UNC]unc_nursery"
: [},
{ "action" : null,
"itemId" : "workspaceid",
"label" : "Adults",
"oid" : 0,
"position" : 0,
"surveyId" : 0,
"value" : "[NorthEasternVidant]nevidant_adult"
},
{ "action" : null,
"itemId" : "workspaceid",
"label" : "Nursery",
"oid" : 0,
"position" : 1,
"surveyId" : 0,
"value" : "[NorthEasternVidant]nevidant_nursery"
}
],
{
"actionpreLabel" : null"Workspace",
"itemIdquery" : "workspaceidfacilityid",
"labelquestionName" : "Adultsworkspaceid",
"oidrequired" : 0false,
"positionsplitDisplay" : 0null,
"surveyIdstyle" : 0null,
"valuesuggestedControl" : "[UNC]unc_adult"
},
{ "actioncustom_linked_combobox",
"surveyId" : null0,
"itemIdupdateBy" : "workspaceid"null,
"labelupdateDate" : "Nursery"null,
"oidupdateWith" : 0null,
"positionvalidation" : null
}
1],
"surveyIdupdateDate" : 0null,
"valueupdateWith" : "[UNC]unc_nursery"null
},
{
"actionreportTemplateId" : 2
null},
{ "itemIdname" : "workspaceidOrganization",
"labelparametersForm" : { "AdultscanSaveDraft" : false,
"oidchartId" : 0null,
"positioncreateDate" : 0null,
"surveyIddirty" : 0false,
"valueexitOnEmpty" : "[Vidant]vidant_adult"
},
{ "actionfalse,
"groupName" : null,
"hasDetails" : nullfalse,
"itemIdinteractive" : "workspaceid"false,
"labellanguage" : "Nursery"null,
"oidname" : 0null,
"positionpatientId" : 1null,
"surveyIdpatientSurveyId" : 0null,
"valueposition" : "[Vidant]vidant_nurserynull,
"surveyClass" }: ]null,
"preLabelsurveyId" : "Workspace3",
"querysurveyQuestions" : "facilityid", [ { "questionNameanswerType" : "workspaceidtext",
"requiredcurrentAnswer" : false"UNC",
"splitDisplaydisplayWhen" : null,
"stylegroupAnswers" : null,
"suggestedControlitemId" : "custom_linked_comboboxorganizationid",
"surveyIdoid" : 0,
"updateByposition" : null,-3,
"possibleAnswers" : [ { "updateDateaction" : null,
"updateWithitemId" : null"organizationid",
"validationlabel" : null
}
]"UNC",
"oid" : 0,
"updateDateposition" : null0,
"updateWithsurveyId" : null
}0,
"reportTemplateIdvalue" : 2"UNC"
} ],
{
"namepreLabel" : "Organization",
"parametersFormquery" : {null,
"canSaveDraftquestionName" : false"organizationid",
"chartIdrequired" : nullfalse,
"createDatesplitDisplay" : null,
"dirtystyle" : falsenull,
"exitOnEmptysuggestedControl" : false"combobox",
"groupNamesurveyId" : null0,
"hasDetailsupdateBy" : falsenull,
"interactiveupdateDate" : falsenull,
"languageupdateWith" : null,
"namevalidation" : null
},
{ "patientIdanswerType" : null"text",
"patientSurveyIdcurrentAnswer" : null,
"positiondisplayWhen" : null,
"surveyClassgroupAnswers" : null,
"surveyIditemId" : "3facilityid",
"surveyQuestionsoid" : [ {0,
"answerTypeposition" : "text"-2,
"currentAnswerpossibleAnswers" : "UNC",[ { "displayWhenaction" : null,
"groupAnswersitemId" : null"facilityid",
"itemIdlabel" : "organizationidNorth Eastern",
"oid" : 0,
"position" : -3 0,
"surveyId" : 0,
"possibleAnswersvalue" : "[UNC]NorthEastern"
},
{ "action" : null,
"itemId" : "organizationidfacilityid",
"label" : "UNC",
"oid" : 0,
"position" : 01,
"surveyId" : 0,
"value" : "[UNC]UNC"
} ],
"preLabel" :{ "Organization",
"queryaction" : null,
"questionNameitemId" : "organizationidfacilityid",
"requiredlabel" : false, "splitDisplayVidant" : null,
"styleoid" : null0,
"suggestedControlposition" : "combobox"2,
"surveyId" : 0,
"updateByvalue" : null,
"updateDate"[UNC]Vidant"
:}
null],
"updateWithpreLabel" : null"Facility",
"validationquery" : null
},
{"organizationid",
"answerTypequestionName" : "textfacilityid",
"currentAnswerrequired" : nullfalse,
"displayWhensplitDisplay" : null,
"groupAnswersstyle" : null,
"itemIdsuggestedControl" : "facilityidcustom_linked_combobox",
"oidsurveyId" : 0,
"positionupdateBy" : -2null,
"possibleAnswers" : [ { "actionupdateDate" : null,
"itemIdupdateWith" : "facilityid"null,
"labelvalidation" : "Northnull
Eastern"},
"oid" : 0,
"position{ "answerType" : 0, "surveyIdtext" : 0,
"valuecurrentAnswer" : "[UNC]NorthEastern"
},
{null,
"actiondisplayWhen" : null,
"itemIdgroupAnswers" : "facilityid"null,
"labelitemId" : "UNCworkspaceid",
"oid" : 0,
"position" : -1,
"surveyIdpossibleAnswers" : 0,
"value" : "[UNC]UNC" },
{ "action" : null,
"itemId" : "facilityidworkspaceid",
"label" : "VidantAdults",
"oid" : 0,
"position" : 20,
"surveyId" : 0,
"value" : "[UNC]Vidant"
}
],
"preLabel" : "Facility",
"query" : "organizationid",
"questionName" : "facilityid",
"required" : false,
"splitDisplayNorthEastern]ne_adult"
},
{ "action" : null,
"styleitemId" : null"workspaceid",
"suggestedControllabel" : "custom_linked_comboboxNursery",
"surveyIdoid" : 0,
"updateByposition" : null1,
"updateDatesurveyId" : null0,
"updateWithvalue" : null,
"validation" : null"[NorthEastern]ne_nursery"
},
{ "answerTypeaction" : "text"null,
"currentAnsweritemId" : null"workspaceid",
"displayWhenlabel" : null"Adults",
"groupAnswersoid" : null0,
"itemIdposition" : "workspaceid"0,
"oidsurveyId" : 0,
"positionvalue" : -1,
"possibleAnswers" : ["[UNC]unc_adult"
},
{ "action" : null,
"itemId" : "workspaceid",
"label" : "AdultsNursery",
"oid" : 0,
"position" : 01,
"surveyId" : 0,
"value" : "[NorthEasternUNC]neunc_adultnursery"
},
{ "action" : null,
"itemId" : "workspaceid",
"label" : "NurseryAdults",
"oid" : 0,
"position" : 10,
"surveyId" : 0,
"value" : "[NorthEasternVidant]nevidant_nurseryadult"
},
{ "action" : null,
"itemId" : "workspaceid",
"label" : "AdultsNursery",
"oid" : 0,
"position" : 01,
"surveyId" : 0,
"value" : "[UNCVidant]uncvidant_adultnursery"
}
],
{
"preLabel" : "Workspace",
"actionquery" : null"facilityid",
"itemIdquestionName" : "workspaceid",
"required" : false,
"labelsplitDisplay" : null,
"style" : null,
"suggestedControl" : "Nurserycustom_linked_combobox",
"oidsurveyId" : 0,
"positionupdateBy" : 1null,
"surveyIdupdateDate" : 0null,
"valueupdateWith" : null,
"[UNC]unc_nurseryvalidation" : null
}
],
{
"actionupdateDate" : null,
"itemIdupdateWith" : "workspaceid"null
},
"labelreportTemplateId" : "Adults",3
},
{ "oidname" : 0"Workspace",
"positionparametersForm" : 0,{ "surveyIdcanSaveDraft" : 0false,
"valuechartId" : "[Vidant]vidant_adult"
},
{null,
"actioncreateDate" : null,
"itemIddirty" : "workspaceid"false,
"labelexitOnEmpty" : "Nursery"false,
"oidgroupName" : 0null,
"positionhasDetails" : 1false,
"surveyIdinteractive" : 0false,
"valuelanguage" : null,
"[Vidant]vidant_nurseryname" }: ]null,
"preLabelpatientId" : "Workspace"null,
"querypatientSurveyId" : "facilityid"null,
"questionNameposition" : "workspaceid"null,
"requiredsurveyClass" : falsenull,
"splitDisplaysurveyId" : null"4",
"stylesurveyQuestions" : [ null,{ "suggestedControlanswerType" : "custom_linked_comboboxtext",
"surveyIdcurrentAnswer" : 0"UNC",
"updateBydisplayWhen" : null,
"updateDategroupAnswers" : null,
"updateWithitemId" : null"organizationid",
"validationoid" : null
} ]0,
"updateDateposition" : null-3,
"updateWithpossibleAnswers" : null[ },{ "reportTemplateIdaction" : 3
}null,
{
"nameitemId" : "Workspaceorganizationid",
"parametersFormlabel" : {"UNC",
"canSaveDraftoid" : false0,
"chartIdposition" : null0,
"createDatesurveyId" : null0,
"dirtyvalue" : false "UNC"
} ],
"exitOnEmptypreLabel" : false"Organization",
"groupNamequery" : null,
"hasDetailsquestionName" : false"organizationid",
"interactiverequired" : false,
"languagesplitDisplay" : null,
"namestyle" : null,
"patientIdsuggestedControl" : null"combobox",
"patientSurveyIdsurveyId" : null0,
"positionupdateBy" : null,
"surveyClassupdateDate" : null,
"surveyIdupdateWith" : "4"null,
"surveyQuestionsvalidation" : null
[},
{ "answerType" : "text",
"currentAnswer" : "UNC"null,
"displayWhen" : null,
"groupAnswers" : null,
"itemId" : "organizationidfacilityid",
"oid" : 0,
"position" : -32,
"possibleAnswers" : [ { "action" : null,
"itemId" : "organizationidfacilityid",
"label" : "UNCNorth Eastern",
"oid" : 0,
"position" : 0,
"surveyId" : 0,
"value" : "[UNC]NorthEastern"
} ],
{ "action" : null,
"preLabelitemId" : "Organizationfacilityid",
"querylabel" : null"UNC",
"questionNameoid" : 0,
"organizationidposition" : 1,
"requiredsurveyId" : false0,
"splitDisplayvalue" : null, "[UNC]UNC"
},
{ "styleaction" : null,
"suggestedControlitemId" : "comboboxfacilityid",
"surveyIdlabel" : 0"Vidant",
"updateByoid" : null0,
"updateDateposition" : null2,
"updateWithsurveyId" : null0,
"validationvalue" : null"[UNC]Vidant"
}
],
{
"answerTypepreLabel" : "textFacility",
"currentAnswerquery" : null"organizationid",
"displayWhenquestionName" : null"facilityid",
"groupAnswersrequired" : nullfalse,
"itemIdsplitDisplay" : "facilityid"null,
"oidstyle" : 0null,
"positionsuggestedControl" : -2"custom_linked_combobox",
"possibleAnswerssurveyId" : [ {0,
"actionupdateBy" : null,
"itemIdupdateDate" : "facilityid"null,
"labelupdateWith" : "North Eastern"null,
"oidvalidation" : 0,
"position" : 0,
"surveyIdnull
},
{ "answerType" : 0"text",
"valuecurrentAnswer" : "[UNC]NorthEastern"
},
{null,
"actiondisplayWhen" : null,
"itemIdgroupAnswers" : "facilityid"null,
"labelitemId" : "UNCworkspaceid",
"oid" : 0,
"position" : -1,
"surveyIdpossibleAnswers" : 0,
"value" : "[UNC]UNC"
}, { "action" : null,
"itemId" : "facilityidworkspaceid",
"label" : "VidantAdults",
"oid" : 0,
"position" : 20,
"surveyId" : 0,
"value" : "[UNCNorthEastern]Vidantne_adult"
}
],
{ "action" : null,
"preLabelitemId" : "Facilityworkspaceid",
"querylabel" : "organizationid"Nursery",
"oid" : 0,
"questionNameposition" : "facilityid"1,
"requiredsurveyId" : false0,
"splitDisplayvalue" : null "[NorthEastern]ne_nursery"
},
{ "styleaction" : null,
"suggestedControlitemId" : "custom_linked_comboboxworkspaceid",
"surveyIdlabel" : 0"Adults",
"updateByoid" : null0,
"updateDateposition" : null0,
"updateWithsurveyId" : null0,
"validationvalue" : null"[UNC]unc_adult"
},
{ "answerTypeaction" : "text"null,
"currentAnsweritemId" : null"workspaceid",
"displayWhenlabel" : null, "groupAnswersNursery" : null,
"itemIdoid" : "workspaceid"0,
"oidposition" : 01,
"positionsurveyId" : -10,
"possibleAnswersvalue" : "[UNC]unc_nursery"
},
{ "action" : null,
"itemId" : "workspaceid",
"label" : "Adults",
"oid" : 0,
"position" : 0,
"surveyId" : 0,
"value" : "[NorthEasternVidant]nevidant_adult"
},
{ "action" : null,
"itemId" : "workspaceid",
"label" : "Nursery",
"oid" : 0,
"position" : 1,
"surveyId" : 0,
"value" : "[NorthEasternVidant]nevidant_nursery"
},
{ "action" : null
],
"itemIdpreLabel" : "workspaceidWorkspace",
"labelquery" : "Adultsfacilityid",
"oidquestionName" : 0, "positionworkspaceid" : 0,
"surveyIdrequired" : 0false,
"valuesplitDisplay" : "[UNC]unc_adult"
},
{null,
"actionstyle" : null,
"itemIdsuggestedControl" : "workspaceidcustom_linked_combobox",
"labelsurveyId" : "Nursery"0,
"oidupdateBy" : 0null,
"positionupdateDate" : 1null,
"surveyIdupdateWith" : 0null,
"valuevalidation" : "[UNC]unc_nursery"null
}
],
{
"actionupdateDate" : null,
"itemIdupdateWith" : null
"workspaceid"},
"labelreportTemplateId" : 4
"Adults"},
{ "oidname" : "Human 0Milk",
"positionparametersForm" : 0,{ "surveyIdcanSaveDraft" : 0false,
"valuechartId" : "[Vidant]vidant_adult"
},
{null,
"actioncreateDate" : null,
"itemIddirty" : "workspaceid"false,
"labelexitOnEmpty" : "Nursery"false,
"oidgroupName" : 0null,
"positionhasDetails" : 1false,
"surveyIdinteractive" : 0false,
"valuelanguage" : null,
"[Vidant]vidant_nurseryname" }: ]null,
"preLabelpatientId" : "Workspace"null,
"querypatientSurveyId" : "facilityid"null,
"questionNameposition" : "workspaceid"null,
"requiredsurveyClass" : falsenull,
"splitDisplaysurveyId" : null"5",
"stylesurveyQuestions" : [ null,{ "suggestedControlanswerType" : "custom_linked_comboboxtext",
"surveyIdcurrentAnswer" : 0"UNC",
"updateBydisplayWhen" : null,
"updateDategroupAnswers" : null,
"updateWithitemId" : null"organizationid",
"validationoid" : null
}
]0,
"updateDateposition" : null-3,
"updateWithpossibleAnswers" : null[ },{ "reportTemplateIdaction" : 4
}null,
{
"nameitemId" : "Human Milkorganizationid",
"parametersFormlabel" : {"UNC",
"canSaveDraftoid" : false0,
"chartIdposition" : null0,
"createDatesurveyId" : null0,
"dirtyvalue" : false "UNC"
} ],
"exitOnEmptypreLabel" : false"Organization",
"groupNamequery" : null,
"hasDetailsquestionName" : false"organizationid",
"interactiverequired" : false,
"languagesplitDisplay" : null,
"namestyle" : null,
"patientIdsuggestedControl" : null"combobox",
"patientSurveyIdsurveyId" : null0,
"positionupdateBy" : null,
"surveyClassupdateDate" : null,
"surveyIdupdateWith" : "5"null,
"surveyQuestionsvalidation" : null
[},
{ "answerType" : "text",
"currentAnswer" : "UNC"null,
"displayWhen" : null,
"groupAnswers" : null,
"itemId" : "organizationidfacilityid",
"oid" : 0,
"position" : -32,
"possibleAnswers" : [ { "action" : null,
"itemId" : "organizationidfacilityid",
"label" : "UNCNorth Eastern",
"oid" : 0,
"position" : 0,
"surveyId" : 0,
"value" : "[UNC]NorthEastern"
} ],
{ "action" : null,
"preLabelitemId" : "Organizationfacilityid",
"querylabel" : null"UNC",
"questionNameoid" : 0,
"organizationidposition" : 1,
"requiredsurveyId" : false0,
"splitDisplayvalue" : null, "[UNC]UNC"
},
{ "styleaction" : null,
"suggestedControlitemId" : "comboboxfacilityid",
"surveyIdlabel" : 0"Vidant",
"updateByoid" : null0,
"updateDateposition" : null2,
"updateWithsurveyId" : null0,
"validationvalue" : null"[UNC]Vidant"
}
],
{
"answerTypepreLabel" : "textFacility",
"currentAnswerquery" : null"organizationid",
"displayWhenquestionName" : null"facilityid",
"groupAnswersrequired" : nullfalse,
"itemIdsplitDisplay" : "facilityid"null,
"oidstyle" : 0null,
"positionsuggestedControl" : -2"custom_linked_combobox",
"possibleAnswerssurveyId" : [ {0,
"actionupdateBy" : null,
"itemIdupdateDate" : "facilityid"null,
"labelupdateWith" : "North Eastern"null,
"oidvalidation" : 0,
"position" : 0,
"surveyIdnull
},
{ "answerType" : 0"text",
"valuecurrentAnswer" : "[UNC]NorthEastern"
},
{null,
"actiondisplayWhen" : null,
"itemIdgroupAnswers" : "facilityid"null,
"labelitemId" : "UNCworkspaceid",
"oid" : 0,
"position" : -1,
"surveyIdpossibleAnswers" : 0,
"value" : "[UNC]UNC"
}, { "action" : null,
"itemId" : "facilityidworkspaceid",
"label" : "VidantAdults",
"oid" : 0,
"position" : 20,
"surveyId" : 0,
"value" : "[UNCNorthEastern]Vidantne_adult"
}
],
{ "action" : null,
"preLabelitemId" : "Facilityworkspaceid",
"querylabel" : "organizationidNursery",
"questionNameoid" : "facilityid"0,
"position" : 1,
"requiredsurveyId" : false0,
"splitDisplayvalue" : null,
"style "[NorthEastern]ne_nursery"
},
{ "action" : null,
"suggestedControlitemId" : "custom_linked_comboboxworkspaceid",
"surveyIdlabel" : 0"Adults",
"updateByoid" : null0,
"updateDateposition" : null0,
"updateWithsurveyId" : null0,
"validationvalue" : null"[UNC]unc_adult"
},
{ "answerTypeaction" : "text"null,
"currentAnsweritemId" : null"workspaceid",
"displayWhenlabel" : null, "groupAnswersNursery" : null,
"itemIdoid" : "workspaceid"0,
"oidposition" : 01,
"positionsurveyId" : -10,
"possibleAnswersvalue" : "[UNC]unc_nursery"
},
{ "action" : null,
"itemId" : "workspaceid",
"label" : "Adults",
"oid" : 0,
"position" : 0,
"surveyId" : 0,
"value" : "[NorthEasternVidant]nevidant_adult"
},
{ "action" : null,
"itemId" : "workspaceid",
"label" : "Nursery",
"oid" : 0,
"position" : 1,
"surveyId" : 0,
"value" : "[NorthEasternVidant]nevidant_nursery"
},
{ "action" : null
],
"itemIdpreLabel" : "workspaceidWorkspace",
"labelquery" : "Adultsfacilityid",
"oidquestionName" : 0, "positionworkspaceid" : 0,
"surveyIdrequired" : 0false,
"valuesplitDisplay" : "[UNC]unc_adult"
},
{null,
"actionstyle" : null,
"itemIdsuggestedControl" : "workspaceidcustom_linked_combobox",
"labelsurveyId" : "Nursery"0,
"oidupdateBy" : 0null,
"positionupdateDate" : 1null,
"surveyIdupdateWith" : 0null,
"valuevalidation" : "[UNC]unc_nursery"null
}
],
{
"actionupdateDate" : null,
"itemIdupdateWith" : null
"workspaceid"},
"labelreportTemplateId" : "Adults"5
}
],
"oidstatusFact" : 0,{ "position" : 0,
"surveyId" : 0,
"value" : "[Vidant]vidant_adult"
},
{ "action" : null,
"itemId" : "workspaceid",
"label" : "Nursery",
"oid" : 0,
"position" : 1,
"surveyId" : 0,
"value" : "[Vidant]vidant_nursery"
}
],
"preLabel" : "Workspace",
"query" : "facilityid",
"questionName" : "workspaceid",
"required" : false,
"splitDisplay" : null,
"style" : null,
"suggestedControl" : "custom_linked_combobox",
"surveyId" : 0,
"updateBy" : null,
"updateDate" : null,
"updateWith" : null,
"validation" : null
}
],
"updateDate" : null,
"updateWith" : null
},
"reportTemplateId" : 5
}
],
"statusFact" : { "success" : true }
}

Get Report

Current Implementation

This operation executes a specific Report Template and returns it as a binary. The current implementation ALWAYS returns the Report as PDF.

Parameters

Base URL: /listReportTemplates

Parameters:

Name	Type	Mandatory	Description
token	String	Yes	Security Token obtained before.
userId	String	Yes	The id of the logged in user.

API Sample

...

success" : true }
}

Get Report

Current Implementation

This operation executes a specific Report Template and returns it as a binary. The current implementation ALWAYS returns the Report as PDF.

Info
This is a POST operation!

Parameters

Base URL: /listReportTemplates

Parameters:

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.

API Sample

Happy Path

curl 'http://localhost:8080/PresentationServices/getReport' -H 'Accept: text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,*/*;q=0.8' -H 'Referer: ' -H 'Origin: null' -H 'X-DevTools-Emulate-Network-Conditions-Client-Id: E0A956BA-D475-1E03-7349-4A852B5BB7CA' -H 'User-Agent: Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/38.0.2125.111 Safari/537.36' -H 'Content-Type: application/x-www-form-urlencoded' --data 'userId=sigal&token=8ea54194-b1c6-42af-adab-2de7f315e52b&reportTemplateId=3&organizationid=UNC&facilityid=' --compressed

Error Path

curl 'http://localhost:8080/PresentationServices/getReport' -H 'Accept: text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,*/*;q=0.8' -H 'Referer: ' -H 'Origin: null' -H 'X-DevTools-Emulate-Network-Conditions-Client-Id: E0A956BA-D475-1E03-7349-4A852B5BB7CA' -H 'User-Agent: Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/38.0.2125.111 Safari/537.36' -H 'Content-Type: application/x-www-form-urlencoded' --data 'userId=sigal&token=8ea54194-b1c6-42af-adab-2de7f315e52b&userId=sigalreportTemplateId=3&organizationid=&facilityid=' --compressed

Code Block

language	js
title	Response
linenumbers	true
collapse	true

"statusFact": { "success": false, "failMessage": "Exception executing Report: Error executing Report 3" }

Versions Compared

Old Version 1

New Version Current

Key

List Report Templates

Current Implementation

Parameters

API Sample

Table of Contents

Design and Configuration

ReportTemplates Table

ReportParameters Table

API

List Report Templates

Current Implementation

Parameters

API Sample

Get Report

Current Implementation

Parameters

API Sample

Get Report

Current Implementation

Parameters

API Sample

Happy Path

Error Path

Page Comparison

Versions Compared

Old Version 1

New Version Current

Key

List Report Templates

Current Implementation

Parameters

API Sample

<span class="diff-html-added" data-a11y-before="Start of added content" data-a11y-after="End of added content" id="added-diff-0">[data-colorid=b3l1suof90]{color:#222222} html[data-color-mode=dark] [data-colorid=b3l1suof90]{color:#dddddd}</span>Table of Contents

Design and Configuration

ReportTemplates Table

ReportParameters Table

API

List Report Templates

Current Implementation

Parameters

API Sample

Get Report

Current Implementation

Parameters

API Sample

Get Report

Current Implementation

Parameters

API Sample

Happy Path

Error Path

Table of Contents