Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Next »

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
tokenStringYesSecurity Token obtained before.
userIdStringYesThe id of the logged in user.

API Sample

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

Result 
{ "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,
"questionName" : "organizationid",
"required" : false,
"splitDisplay" : null,
"style" : null,
"suggestedControl" : "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",
"oid" : 0,
"position" : 0,
"surveyId" : 0,
"value" : "[UNC]NorthEastern"
},
{ "action" : null,
"itemId" : "facilityid",
"label" : "UNC",
"oid" : 0,
"position" : 1,
"surveyId" : 0,
"value" : "[UNC]UNC"
},
{ "action" : null,
"itemId" : "facilityid",
"label" : "Vidant",
"oid" : 0,
"position" : 2,
"surveyId" : 0,
"value" : "[UNC]Vidant"
}
],
"preLabel" : "Facility",
"query" : "organizationid",
"questionName" : "facilityid",
"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" : "workspaceid",
"oid" : 0,
"position" : -1,
"possibleAnswers" : [ { "action" : null,
"itemId" : "workspaceid",
"label" : "Adults",
"oid" : 0,
"position" : 0,
"surveyId" : 0,
"value" : "[NorthEastern]ne_adult"
},
{ "action" : null,
"itemId" : "workspaceid",
"label" : "Nursery",
"oid" : 0,
"position" : 1,
"surveyId" : 0,
"value" : "[NorthEastern]ne_nursery"
},
{ "action" : null,
"itemId" : "workspaceid",
"label" : "Adults",
"oid" : 0,
"position" : 0,
"surveyId" : 0,
"value" : "[UNC]unc_adult"
},
{ "action" : null,
"itemId" : "workspaceid",
"label" : "Nursery",
"oid" : 0,
"position" : 1,
"surveyId" : 0,
"value" : "[UNC]unc_nursery"
},
{ "action" : null,
"itemId" : "workspaceid",
"label" : "Adults",
"oid" : 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" : 1
},
{ "name" : "Facility",
"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" : "2",
"surveyQuestions" : [ { "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,
"questionName" : "organizationid",
"required" : false,
"splitDisplay" : null,
"style" : null,
"suggestedControl" : "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",
"oid" : 0,
"position" : 0,
"surveyId" : 0,
"value" : "[UNC]NorthEastern"
},
{ "action" : null,
"itemId" : "facilityid",
"label" : "UNC",
"oid" : 0,
"position" : 1,
"surveyId" : 0,
"value" : "[UNC]UNC"
},
{ "action" : null,
"itemId" : "facilityid",
"label" : "Vidant",
"oid" : 0,
"position" : 2,
"surveyId" : 0,
"value" : "[UNC]Vidant"
}
],
"preLabel" : "Facility",
"query" : "organizationid",
"questionName" : "facilityid",
"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" : "workspaceid",
"oid" : 0,
"position" : -1,
"possibleAnswers" : [ { "action" : null,
"itemId" : "workspaceid",
"label" : "Adults",
"oid" : 0,
"position" : 0,
"surveyId" : 0,
"value" : "[NorthEastern]ne_adult"
},
{ "action" : null,
"itemId" : "workspaceid",
"label" : "Nursery",
"oid" : 0,
"position" : 1,
"surveyId" : 0,
"value" : "[NorthEastern]ne_nursery"
},
{ "action" : null,
"itemId" : "workspaceid",
"label" : "Adults",
"oid" : 0,
"position" : 0,
"surveyId" : 0,
"value" : "[UNC]unc_adult"
},
{ "action" : null,
"itemId" : "workspaceid",
"label" : "Nursery",
"oid" : 0,
"position" : 1,
"surveyId" : 0,
"value" : "[UNC]unc_nursery"
},
{ "action" : null,
"itemId" : "workspaceid",
"label" : "Adults",
"oid" : 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" : 2
},
{ "name" : "Organization",
"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" : "3",
"surveyQuestions" : [ { "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,
"questionName" : "organizationid",
"required" : false,
"splitDisplay" : null,
"style" : null,
"suggestedControl" : "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",
"oid" : 0,
"position" : 0,
"surveyId" : 0,
"value" : "[UNC]NorthEastern"
},
{ "action" : null,
"itemId" : "facilityid",
"label" : "UNC",
"oid" : 0,
"position" : 1,
"surveyId" : 0,
"value" : "[UNC]UNC"
},
{ "action" : null,
"itemId" : "facilityid",
"label" : "Vidant",
"oid" : 0,
"position" : 2,
"surveyId" : 0,
"value" : "[UNC]Vidant"
}
],
"preLabel" : "Facility",
"query" : "organizationid",
"questionName" : "facilityid",
"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" : "workspaceid",
"oid" : 0,
"position" : -1,
"possibleAnswers" : [ { "action" : null,
"itemId" : "workspaceid",
"label" : "Adults",
"oid" : 0,
"position" : 0,
"surveyId" : 0,
"value" : "[NorthEastern]ne_adult"
},
{ "action" : null,
"itemId" : "workspaceid",
"label" : "Nursery",
"oid" : 0,
"position" : 1,
"surveyId" : 0,
"value" : "[NorthEastern]ne_nursery"
},
{ "action" : null,
"itemId" : "workspaceid",
"label" : "Adults",
"oid" : 0,
"position" : 0,
"surveyId" : 0,
"value" : "[UNC]unc_adult"
},
{ "action" : null,
"itemId" : "workspaceid",
"label" : "Nursery",
"oid" : 0,
"position" : 1,
"surveyId" : 0,
"value" : "[UNC]unc_nursery"
},
{ "action" : null,
"itemId" : "workspaceid",
"label" : "Adults",
"oid" : 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" : 3
},
{ "name" : "Workspace",
"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" : "4",
"surveyQuestions" : [ { "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,
"questionName" : "organizationid",
"required" : false,
"splitDisplay" : null,
"style" : null,
"suggestedControl" : "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",
"oid" : 0,
"position" : 0,
"surveyId" : 0,
"value" : "[UNC]NorthEastern"
},
{ "action" : null,
"itemId" : "facilityid",
"label" : "UNC",
"oid" : 0,
"position" : 1,
"surveyId" : 0,
"value" : "[UNC]UNC"
},
{ "action" : null,
"itemId" : "facilityid",
"label" : "Vidant",
"oid" : 0,
"position" : 2,
"surveyId" : 0,
"value" : "[UNC]Vidant"
}
],
"preLabel" : "Facility",
"query" : "organizationid",
"questionName" : "facilityid",
"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" : "workspaceid",
"oid" : 0,
"position" : -1,
"possibleAnswers" : [ { "action" : null,
"itemId" : "workspaceid",
"label" : "Adults",
"oid" : 0,
"position" : 0,
"surveyId" : 0,
"value" : "[NorthEastern]ne_adult"
},
{ "action" : null,
"itemId" : "workspaceid",
"label" : "Nursery",
"oid" : 0,
"position" : 1,
"surveyId" : 0,
"value" : "[NorthEastern]ne_nursery"
},
{ "action" : null,
"itemId" : "workspaceid",
"label" : "Adults",
"oid" : 0,
"position" : 0,
"surveyId" : 0,
"value" : "[UNC]unc_adult"
},
{ "action" : null,
"itemId" : "workspaceid",
"label" : "Nursery",
"oid" : 0,
"position" : 1,
"surveyId" : 0,
"value" : "[UNC]unc_nursery"
},
{ "action" : null,
"itemId" : "workspaceid",
"label" : "Adults",
"oid" : 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" : 4
},
{ "name" : "Human Milk",
"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" : "5",
"surveyQuestions" : [ { "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,
"questionName" : "organizationid",
"required" : false,
"splitDisplay" : null,
"style" : null,
"suggestedControl" : "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",
"oid" : 0,
"position" : 0,
"surveyId" : 0,
"value" : "[UNC]NorthEastern"
},
{ "action" : null,
"itemId" : "facilityid",
"label" : "UNC",
"oid" : 0,
"position" : 1,
"surveyId" : 0,
"value" : "[UNC]UNC"
},
{ "action" : null,
"itemId" : "facilityid",
"label" : "Vidant",
"oid" : 0,
"position" : 2,
"surveyId" : 0,
"value" : "[UNC]Vidant"
}
],
"preLabel" : "Facility",
"query" : "organizationid",
"questionName" : "facilityid",
"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" : "workspaceid",
"oid" : 0,
"position" : -1,
"possibleAnswers" : [ { "action" : null,
"itemId" : "workspaceid",
"label" : "Adults",
"oid" : 0,
"position" : 0,
"surveyId" : 0,
"value" : "[NorthEastern]ne_adult"
},
{ "action" : null,
"itemId" : "workspaceid",
"label" : "Nursery",
"oid" : 0,
"position" : 1,
"surveyId" : 0,
"value" : "[NorthEastern]ne_nursery"
},
{ "action" : null,
"itemId" : "workspaceid",
"label" : "Adults",
"oid" : 0,
"position" : 0,
"surveyId" : 0,
"value" : "[UNC]unc_adult"
},
{ "action" : null,
"itemId" : "workspaceid",
"label" : "Nursery",
"oid" : 0,
"position" : 1,
"surveyId" : 0,
"value" : "[UNC]unc_nursery"
},
{ "action" : null,
"itemId" : "workspaceid",
"label" : "Adults",
"oid" : 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.

This is a POST operation!

Parameters

Base URL: /listReportTemplates

Parameters:

Name
Type
Mandatory
Description
tokenStringYesSecurity Token obtained before.
userIdStringYesThe id of the logged in user.
reportTemplateIdStringYesThe Id of the Report Template to be executed.
<report-specific-parameters>N/ANoEach 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&reportTemplateId=3&organizationid=&facilityid=' --compressed

Response 
"statusFact": { "success": false, "failMessage": "Exception executing Report: Error executing Report 3" }
  • No labels

0 Comments

You are not logged in. Any changes you make will be marked as anonymous. You may want to Log In if you already have an account.