Reporting REST web services Enhancements - Project Plan
(Resource :Proposal After Design Forum June 12, 2013 )
Resource Definition
Report Definiton
url | description |
GET /ws/rest/v1/reportingrest/reportDefinition | List down all report definitions |
GET /ws/rest/v1/reportingrest/reportDefinition/{uuid} | Fetch by unique id |
GET /ws/rest/v1/reportingrest/reportDefinition?type={type} | Fetch by type |
GET /ws/rest/v1/reportingrest/reportDefinition?q={name} | Fetch by name |
Cohort Definiton
url | description |
GET /ws/rest/v1/reportingrest/cohortDefinition | List down all cohort definition |
GET /ws/rest/v1/reportingrest/cohortDefinition/{uuid} | Fetch by unique id |
GET /ws/rest/v1/reportingrest/cohortDefinition?type={type} | Fetch by type |
GET /ws/rest/v1/reportingrest/cohortDefinition?q={name} | Fetch by name |
Data Set Definiton
url | description |
GET /ws/rest/v1/reportingrest/dataSetDefinition | List down all dataset definition |
GET /ws/rest/v1/reportingrest/dataSetDefinition/{uuid} | Fetch by unique id |
GET /ws/rest/v1/reportingrest/dataSetDefinition?type={type} | Fetch by type |
GET /ws/rest/v1/reportingrest/dataSetDefinition?q={name} | Fetch by name |
Resource Request
Report Request
url | description |
GET /ws/rest/v1/reportingrest/reportRequest | List down all report request |
GET /ws/rest/v1/reportingrest/reportRequest/{uuid} | Fetch by unique id |
GET /ws/rest/v1/reportingrest/reportRequest?type={type} | Fetch by type |
GET /ws/rest/v1/reportingrest/reportRequest?q={ definitionName} | Fetch by definitionName |
GET /ws/rest/v1/reportingrest/reportRequest? user={requestBy} | Fetch by user |
GET /ws/rest/v1/reportingrest/reportRequest? recent={hours} | Fetch by hours |
GET /ws/rest/v1/reportingrest/reportRequest? status={status} | Fetch by status |
POST /ws/rest/v1/reportingrest/reportRequest? type={type}[body] | Create report request |
DELETE /ws/rest/v1/reportingrest/reportRequest/{uuid} | Delete report reqest |
Cohort Request
url | description |
GET /ws/rest/v1/reportingrest/cohortRequest | List down all cohort request //not implemented |
GET /ws/rest/v1/reportingrest/cohortRequest/{uuid} | Fetch by unique id |
GET /ws/rest/v1/reportingrest/cohortRequest?type={type} | Fetch by type |
GET /ws/rest/v1/reportingrest/cohortRequest?q={ definitionName} | Fetch by definitionName |
GET /ws/rest/v1/reportingrest/cohortRequest? user={requestBy} | Fetch by user |
GET /ws/rest/v1/reportingrest/cohortRequest? recent={hours} | Fetch by hours |
GET /ws/rest/v1/reportingrest/cohortRequest? status={status} | Fetch by status |
POST /ws/rest/v1/reportingrest/cohortRequest? type={type}[body] | Create cohort request |
DELETE /ws/rest/v1/reportingrest/cohortRequest /{uuid} | Delete cohort request |
Data set Request
url | description |
GET /ws/rest/v1/reportingrest/datasetRequest | List down all dataset request not implemented |
GET /ws/rest/v1/reportingrest/datasetRequest /{uuid} | Fetch by unique id |
GET /ws/rest/v1/reportingrest/datasetRequest?type={type} | Fetch by type |
GET /ws/rest/v1/reportingrest/datasetRequest?q={ definitionName} | Fetch by definitionName |
GET /ws/rest/v1/reportingrest/datasetRequest? user={requestBy} | Fetch by user |
GET /ws/rest/v1/reportingrest/datasetRequest? recent={hours} | Fetch by hours |
GET /ws/rest/v1/reportingrest/datasetRequest? status={status} | Fetch by status |
POST /ws/rest/v1/reportingrest/datasetRequest? type={type}[body] | Create dataset request |
DELETE /ws/rest/v1/reportingrest/datasetRequest /{uuid} | Delete dataset request |
Evaluated Resource
Evaluated Cohort
url | description |
GET /ws/rest/v1/reportingrest/cohort/{uuid of cohort} | lists all patients of that cohort |
Evaluated Data Set
url | description |
GET /ws/rest/v1/reportingrest/dataSet/{uuid of DSD} | Listing all evaluated DSD against a cohort |
Evaluated Report
url | description |
GET /ws/rest/v1/reportingrest/report/{uuid of reportRequest} | Listing down/renderedOutput of the report results. |
Time Line
June 17 - June 28
- Finalizing the requirements
- Make the project plan
July 1- July 7
- Report definition/Cohort definition/ Data set definition Web services
July 8- July 14
- Report Request/ data Set Request/Cohort Request Web services
July 15- July 21
- Evaluated Report/Evaluated Data Set/ Evaluatede Cohort Web services
July 22- July 28
- Report Processor/Report resources Web services
July 29- August 9
- Unexpected delays
NOTE
This project plan designed up to the mid evaluation. After the Reporting REST web services enhancements, the second phase of my project will be the Pentaho Data Integration.