Fixed apiary doc: document content

SpagoBILabs · Jan 14, 2016 · 5cd6399 · 5cd6399
1 parent 5323788
commit 5cd6399
Show file tree

Hide file tree

Showing 36 changed files with 22 additions and 8 deletions.
diff --git a/ChefCookbooks/spagobi/files/default/mysql-connector-java-5.1.33-bin.jar b/ChefCookbooks/spagobi/files/default/mysql-connector-java-5.1.33-bin.jar
diff --git a/QbeCore/test-resources/hibernate/foodmart/datamart.jar b/QbeCore/test-resources/hibernate/foodmart/datamart.jar
diff --git a/QbeCore/test-resources/jpa/jpaImpl/eclipselink/datamart.jar b/QbeCore/test-resources/jpa/jpaImpl/eclipselink/datamart.jar
diff --git a/QbeCore/test-resources/jpa/jpaImpl/hibernate/datamart.jar b/QbeCore/test-resources/jpa/jpaImpl/hibernate/datamart.jar
diff --git a/QbeCore/test-resources/jpa/keys/compKey/dist/datamart.jar b/QbeCore/test-resources/jpa/keys/compKey/dist/datamart.jar
diff --git a/QbeCore/test-resources/jpa/keys/noKey/dist/datamart.jar b/QbeCore/test-resources/jpa/keys/noKey/dist/datamart.jar
diff --git a/QbeCore/test-resources/jpa/keys/relCompKey/dist/datamart.jar b/QbeCore/test-resources/jpa/keys/relCompKey/dist/datamart.jar
diff --git a/QbeCore/test-resources/jpa/keys/relNoKey/dist/datamart.jar b/QbeCore/test-resources/jpa/keys/relNoKey/dist/datamart.jar
diff --git a/QbeCore/test-resources/jpa/keys/relSimpleKey/dist/datamart.jar b/QbeCore/test-resources/jpa/keys/relSimpleKey/dist/datamart.jar
diff --git a/QbeCore/test-resources/jpa/keys/simpleKey/dist/datamart.jar b/QbeCore/test-resources/jpa/keys/simpleKey/dist/datamart.jar
diff --git a/QbeCore/test-resources/jpa/query/datamart.jar b/QbeCore/test-resources/jpa/query/datamart.jar
diff --git a/QbeCore/test-resources/jpa/views/relNoKey/dist/datamart.jar b/QbeCore/test-resources/jpa/views/relNoKey/dist/datamart.jar
diff --git a/QbeCore/test-resources/jpa/views/relSimpleKey/dist/datamart.jar b/QbeCore/test-resources/jpa/views/relSimpleKey/dist/datamart.jar
diff --git a/QbeCore/test-resources/jpa/views/simpleKey/dist/datamart.jar b/QbeCore/test-resources/jpa/views/simpleKey/dist/datamart.jar
diff --git a/SpagoBICockpitEngine/src/test/resources/qbe/datamarts/MyModel41/datamart.jar b/SpagoBICockpitEngine/src/test/resources/qbe/datamarts/MyModel41/datamart.jar
diff --git a/SpagoBIProject/src/main/webapp/WEB-INF/jsp/engines/config/listEngines.jsp.bak b/SpagoBIProject/src/main/webapp/WEB-INF/jsp/engines/config/listEngines.jsp.bak
@@ -0,0 +1,14 @@
+<%-- SpagoBI, the Open Source Business Intelligence suite
+
+Copyright (C) 2012 Engineering Ingegneria Informatica S.p.A. - SpagoBI Competency Center
+This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0, without the "Incompatible With Secondary Licenses" notice. 
+If a copy of the MPL was not distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/. --%>
+
+
+
+
+<%@ include file="/WEB-INF/jsp/commons/portlet_base.jsp"%>
+
+<spagobi:list moduleName="ListEnginesModule" />
+
+<%@ include file="/WEB-INF/jsp/commons/footer.jsp"%>
diff --git a/apiary.apib b/apiary.apib
@@ -342,18 +342,18 @@ Each parameter is seen as a resource (subresource of parameters) and is uniquely
 
 
 
-## The content subresource [/restful-services/2.0/documents/{document_label}/content]
+## The content subresource: document execution [/restful-services/2.0/documents/{document_label}/content]
 
-In SpagoBI a document can be executed. For a point of view, executing a document can be seen as the act of retrieving its content. For this reason, the content of a document is represented as a sub resource of it.
+In SpagoBI a document can be executed. For a point of view, executing a document can be seen as the act of retrieving its content. For this reason, the content of a document is represented as a subresource of it.
 
 + Parameters
     + document_label (string) - the document's label
 
 
 ### Return the document content [POST]
 
-In order to execute the document you must put them inside the body payload as a JSON object. There is also the outputType parameter represented as queryParameter.
-It accepts an  "outputType" query parameter, for example "HTML".
+In order to execute the document you must put the document's parameters inside the body payload as a JSON object. There is also the outputType parameter represented as queryParameter.
+It accepts an output type, for example "HTML" or "PDF". The available output types depend from the kind of document. Check the available export types from the SpagoBI web application, inside the view of document. 
 
 + Request (application/json)
 
@@ -362,10 +362,10 @@ It accepts an  "outputType" query parameter, for example "HTML".
                 [
                     {
                             "id":"1",
-                            "label":"label1",
-                            "type":"type1",
-                            "urlName":"myUrl",
-                            "values":["v1","v2"]
+                            "label":"Country",
+                            "type":"string",
+                            "urlName":"country",
+                            "values":["Italy","USA"]
                     }
                 ]
 

diff --git a/resources/qbe/datamarts/foodmart/datamart.jar b/resources/qbe/datamarts/foodmart/datamart.jar
diff --git a/...sitory/java/CRM_DEMO_V3/crm_demo_transformation_jobs/crm_demo_transformation_jobs_0_1.jar b/...sitory/java/CRM_DEMO_V3/crm_demo_transformation_jobs/crm_demo_transformation_jobs_0_1.jar
diff --git a/...ntimeRepository/java/CRM_DEMO_V3/crm_demo_transformation_jobs/crm_mart_all_tables_0_1.jar b/...ntimeRepository/java/CRM_DEMO_V3/crm_demo_transformation_jobs/crm_mart_all_tables_0_1.jar
diff --git a/...imeRepository/java/CRM_DEMO_V3/crm_demo_transformation_jobs/sales_fact_by_periode_0_1.jar b/...imeRepository/java/CRM_DEMO_V3/crm_demo_transformation_jobs/sales_fact_by_periode_0_1.jar
diff --git a/...nd/RuntimeRepository/java/CRM_DEMO_V3/crm_demo_transformation_jobs/sales_fact_tmp_0_1.jar b/...nd/RuntimeRepository/java/CRM_DEMO_V3/crm_demo_transformation_jobs/sales_fact_tmp_0_1.jar
diff --git a/...alend/RuntimeRepository/java/CRM_DEMO_V3/crm_demo_transformation_jobs/t1_customer_0_1.jar b/...alend/RuntimeRepository/java/CRM_DEMO_V3/crm_demo_transformation_jobs/t1_customer_0_1.jar
diff --git a/...alend/RuntimeRepository/java/CRM_DEMO_V3/crm_demo_transformation_jobs/t1_employee_0_1.jar b/...alend/RuntimeRepository/java/CRM_DEMO_V3/crm_demo_transformation_jobs/t1_employee_0_1.jar
diff --git a/...talend/RuntimeRepository/java/CRM_DEMO_V3/crm_demo_transformation_jobs/t1_product_0_1.jar b/...talend/RuntimeRepository/java/CRM_DEMO_V3/crm_demo_transformation_jobs/t1_product_0_1.jar
diff --git a/.../talend/RuntimeRepository/java/CRM_DEMO_V3/crm_demo_transformation_jobs/t1_salary_0_1.jar b/.../talend/RuntimeRepository/java/CRM_DEMO_V3/crm_demo_transformation_jobs/t1_salary_0_1.jar
diff --git a/resources/talend/RuntimeRepository/java/CRM_DEMO_V3/lib/javacsv.jar b/resources/talend/RuntimeRepository/java/CRM_DEMO_V3/lib/javacsv.jar
diff --git a/resources/talend/RuntimeRepository/java/CRM_DEMO_V3/lib/mysql-connector-java-5.1.0-bin.jar b/resources/talend/RuntimeRepository/java/CRM_DEMO_V3/lib/mysql-connector-java-5.1.0-bin.jar
diff --git a/resources/talend/RuntimeRepository/java/CRM_DEMO_V3/lib/systemRoutines.jar b/resources/talend/RuntimeRepository/java/CRM_DEMO_V3/lib/systemRoutines.jar
diff --git a/resources/talend/RuntimeRepository/java/CRM_DEMO_V3/lib/talend_file_enhanced_20070724.jar b/resources/talend/RuntimeRepository/java/CRM_DEMO_V3/lib/talend_file_enhanced_20070724.jar
diff --git a/resources/talend/RuntimeRepository/java/CRM_DEMO_V3/lib/userRoutines.jar b/resources/talend/RuntimeRepository/java/CRM_DEMO_V3/lib/userRoutines.jar
diff --git a/resources/talend/RuntimeRepository/java/ProvaCorso/Clean_Audit/clean_audit_0_1.jar b/resources/talend/RuntimeRepository/java/ProvaCorso/Clean_Audit/clean_audit_0_1.jar
diff --git a/resources/talend/RuntimeRepository/java/ProvaCorso/lib/mysql-connector-java-5.1.0-bin.jar b/resources/talend/RuntimeRepository/java/ProvaCorso/lib/mysql-connector-java-5.1.0-bin.jar
diff --git a/resources/talend/RuntimeRepository/java/ProvaCorso/lib/systemRoutines.jar b/resources/talend/RuntimeRepository/java/ProvaCorso/lib/systemRoutines.jar
diff --git a/resources/talend/RuntimeRepository/java/ProvaCorso/lib/userRoutines.jar b/resources/talend/RuntimeRepository/java/ProvaCorso/lib/userRoutines.jar
diff --git a/spagobi-core/src/test/resources/qbe/datamarts/MyModel41/datamart.jar b/spagobi-core/src/test/resources/qbe/datamarts/MyModel41/datamart.jar